ListNamespaces - Microservices Engine - Alibaba Cloud Documentation Center

Displays the namespace list, showing the number of online nodes and total applications in each namespace. This interface also supports fuzzy queries based on namespace names.

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 support 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:ListNamespaces

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Region	string	Yes	Region.	cn-hangzhou
PageNumber	integer	No	Page number for paged query.	1
PageSize	integer	No	Number of entries per page for paged queries. The default is 5. To return more data, increase this value.	10
Name	string	No	Namespace name for fuzzy query. If not specified, all namespaces are queried by default.	myNamespace
Tag	array	No	Alibaba Cloud tags.
	object	No	Tag list, containing a maximum of 20 subkeys.
Key	string	No	Tag key.
Value	string	No	Tag value.
AcceptLanguage	string	No	Language for displaying results. Values: zh (default): Chinese, en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	RestResult<PageResult>
RequestId	string	Request ID.	D1F1A6F3-7E03-5EAD-B3F1-123456789ABC
Data	object	Return results.
PageNumber	integer	Result page number.	1
TotalSize	integer	Total number of query results.	7
PageSize	integer	Page size for the query.	10
Result	array	Return results.
	object	Result set.
UserId	string	User ID.	178*******
Region	string	Region.	cn-hangzhou
Namespace	string	Namespace.	myNamespace
Version	integer	Version. Basic Edition 0, Professional Edition 1, Enterprise Edition 2.	1
Describe	string	Namespace description.
InstanceCount	integer	Number of online nodes.	6
AppCount	integer	Number of applications.	3
CreateTime	integer	Creation time.	2024-09-02T09:49:48.000+0000
UpdateTime	integer	Update time.	2024-09-02T09:49:48.000+0000
Tags	object	Alibaba Cloud tags.
Results	array	Result set.
	object	Result collection.
UserId	string	User ID.	178*******
Region	string	Region.	cn-hangzhou
Namespace	string	Namespace.	myNamespace
Version	integer	Version. Basic Edition 0, Professional Edition 1, Enterprise Edition 2.	1
Describe	string	Namespace description.
InstanceCount	integer	Number of online nodes.	6
AppCount	integer	Number of applications.	3
CreateTime	integer	Creation time.	2024-09-02T09:49:48.000+0000
UpdateTime	integer	Update time.	2024-09-02T09:49:48.000+0000

Examples

Success response

JSON format

{
  "RequestId": "D1F1A6F3-7E03-5EAD-B3F1-123456789ABC",
  "Data": {
    "PageNumber": 1,
    "TotalSize": 7,
    "PageSize": 10,
    "Result": [
      {
        "UserId": "178*******",
        "Region": "cn-hangzhou",
        "Namespace": "myNamespace",
        "Version": 1,
        "Describe": "",
        "InstanceCount": 6,
        "AppCount": 3,
        "CreateTime": 0,
        "UpdateTime": 0,
        "Tags": {
          "test": "test",
          "test2": 1
        }
      }
    ],
    "Results": [
      {
        "UserId": "178*******",
        "Region": "cn-hangzhou",
        "Namespace": "myNamespace",
        "Version": 1,
        "Describe": "",
        "InstanceCount": 6,
        "AppCount": 3,
        "CreateTime": 0,
        "UpdateTime": 0
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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.