DescribeNamespaces - - Alibaba Cloud Documentation Center

Queries a list of namespaces.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
sae:DescribeNamespaces	get	All Resources *	none	none

Request syntax

GET /pop/v1/paas/namespaces HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
CurrentPage	integer	Yes	1	1
PageSize	integer	Yes	10	10

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The returned message. success is returned when the request succeeds. An error message is returned when the request fails.	success
TraceId	string	The ID of the trace. It can be used to query the details of a request.	0a981dd515966966104121683d****
Data	object	The information of namespaces.
CurrentPage	integer	The page number of the returned page.	1
TotalSize	integer	The total number of namespaces.	100
PageSize	integer	The number of entries returned on each page.	10
Namespaces	array<object>	The list of namespaces.
Namespace	object
NamespaceDescription	string	The description of the namespace.	desc
AccessKey	string	The ACM-specific AccessKey ID. It can be used to manage data in an Application Configuration Management (ACM) namespace. For more information, see Differences between Alibaba Cloud AccessKey and ACM-specific AccessKey.	b34dbe3315c64f9f99b58ea447ec****
SecretKey	string	The ACM-specific AccessKey secret. It can be used to manage data in an ACM namespace. For more information, see Differences between Alibaba Cloud AccessKey and ACM-specific AccessKey.	G/w6sseK7+nb3S6HBmANDBMD****
NamespaceId	string	The ID of the namespace. The information of the default namespace cannot be queried or modified. The default namespace cannot be deleted.	cn-beijing:test
NamespaceName	string	The name of the namespace.	name
TenantId	string	The ID of the tenant.	838cad95-973f-48fe-830b-2a8546d7****
RegionId	string	The ID of the region.	cn-beijing
ErrorCode	string	The error code. The ErrorCode parameter is not returned when the request succeeds. The ErrorCode parameter is returned when the request fails. For more information, see Error codes in this topic.
Code	string	The HTTP status code. Valid values: 2xx: indicates that the request was successful. 3xx: indicates that the request was redirected. 4xx: indicates that the request failed. 5xx: indicates that a server error occurred.	200
Success	boolean	Indicates whether the details of namespaces were queried successfully. Valid values: true: indicates that the query was successful. false: indicates that the query failed.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a981dd515966966104121683d****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 100,
    "PageSize": 10,
    "Namespaces": [
      {
        "NamespaceDescription": "desc",
        "AccessKey": "b34dbe3315c64f9f99b58ea447ec****",
        "SecretKey": "G/w6sseK7+nb3S6HBmANDBMD****",
        "NamespaceId": "cn-beijing:test",
        "AddressServerHost": "addr-bj-internal.edas.aliyun.com",
        "NamespaceName": "name",
        "TenantId": "838cad95-973f-48fe-830b-2a8546d7****",
        "RegionId": "cn-beijing",
        "NameSpaceShortId": "test"
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2022-10-13	The response structure of the API has changed	View Change Details