Nacos Namespace Management with ListEngineNamespaces API - MSE - Alibaba Cloud - Microservices Engine

Queries the namespaces of a Nacos instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mse:ListEngineNamespaces

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The ID of the instance.	mse-cn-st21ri2****
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object	The data structure.
HttpCode	string	The HTTP status code.	202
TotalCount	integer	The total number of returned instances.	7
RequestId	string	The ID of the request.	062D13C5-DEA3-4921-8918-C49A0F1B****
Message	string	The response message.	The request was successfully processed.
PageSize	integer	The number of entries returned per page.	10
PageNumber	integer	The page number.	1
Data	array<object>	The details of the data.
	object	The details of the data.
Type	integer	The type of the namespace. Valid values: `0`: global configuration `1`: default namespace `2`: custom namespace	0
NamespaceShowName	string	The name of the namespace.	public
Quota	integer	The quota.	200
Namespace	string	The namespace.	DEFAULT
NamespaceDesc	string	The description of the namespace.	mytest
ConfigCount	integer	The quota value.	1
ServiceCount	string	The number of active services.	3
SourceType	string	The source from which the namespace was created.	mse
ErrorCode	string	The error code returned if the request failed.	mse-100-000
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	OperationNotSupport	The current cluster does not support this operation, %s.	The current cluster does not support this operation
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.