All Products
Search
Document Center

Microservices Engine:ListEngineNamespaces

Last Updated:Nov 20, 2024

Queries the namespaces of a Nacos instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
mse:ListEngineNamespaceslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

mse-cn-st21ri2****
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The data structure.

HttpCodestring

The HTTP status code.

202
TotalCountinteger

The total number of returned instances.

7
RequestIdstring

The ID of the request.

062D13C5-DEA3-4921-8918-C49A0F1B****
Messagestring

The message returned.

The request was successfully processed.
PageSizeinteger

The number of entries returned per page.

10
PageNumberinteger

The number of the returned page.

1
Dataarray<object>

The details of the data.

Namespaceobject

The details of the data.

Typeinteger

The type of the namespace. Valid values:

  • 0: global configuration
  • 1: default namespace
  • 2: custom namespace
0
NamespaceShowNamestring

The name of the namespace.

public
Quotainteger

The quota.

200
Namespacestring

The namespace.

DEFAULT
NamespaceDescstring

The description of the namespace.

mytest
ConfigCountinteger

The quota value.

1
ServiceCountstring

The number of active services.

3
SourceTypestring

The source from which the namespace was created.

mse
ErrorCodestring

The error code returned if the request failed.

mse-100-000
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

{
  "HttpCode": "202",
  "TotalCount": 7,
  "RequestId": "062D13C5-DEA3-4921-8918-C49A0F1B****",
  "Message": "The request was successfully processed.\n",
  "PageSize": 10,
  "PageNumber": 1,
  "Data": [
    {
      "Type": 0,
      "NamespaceShowName": "public",
      "Quota": 200,
      "Namespace": "DEFAULT",
      "NamespaceDesc": "mytest",
      "ConfigCount": 1,
      "ServiceCount": "3",
      "SourceType": "mse"
    }
  ],
  "ErrorCode": "mse-100-000",
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-08-28The internal configuration of the API is changed, but the call is not affectedView Change Details
2023-04-25The internal configuration of the API is changed, but the call is not affectedView Change Details