DescribeNamespaces-阿里云帮助中心

Queries a list of namespaces.

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

sae:DescribeNamespaces

get

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
CurrentPage	integer	Yes	The current page number.	1
PageSize	integer	Yes	The number of entries per page. Valid values: 0 to 10000.	10

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The message returned by the system. Returns success if the request is successful. Returns a specific error message if the request fails.	success
TraceId	string	The trace ID that can be used to query the details of a call.	0a981dd515966966104121683d****
Data	object	The details of the namespaces.
CurrentPage	integer	The current page number.	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.
	object	The details of a namespace.
NamespaceDescription	string	The description of the namespace.	desc
AccessKey	string	The access key ID for Application Configuration Management (ACM), used to manage data in an ACM namespace. For more information, see Differences between an Alibaba Cloud access key and an ACM-specific access key.	b34dbe3315c64f9f99b58ea447ec****
SecretKey	string	The secret access key for Application Configuration Management (ACM), used to manage data in an ACM namespace. For more information, see Differences between an Alibaba Cloud access key and an ACM-specific access key.	G/w6sseK7+nb3S6HBmANDBMD****
NamespaceId	string	The namespace ID. The default namespace cannot be queried, modified, or deleted.	cn-beijing:test
AddressServerHost	string	The service endpoint.	addr-bj-internal.edas.aliyun.com
NamespaceName	string	The name of the namespace.	name
TenantId	string	The tenant ID.	838cad95-973f-48fe-830b-2a8546d7****
RegionId	string	The ID of the region. For example, 'cn-beijing' indicates China (Beijing).	cn-beijing
NameSpaceShortId	string	The short ID of the namespace.	test
ErrorCode	string	The error code. This parameter is returned only if the request fails. For more information, see the Error codes section in this topic.
Code	string	The HTTP status code. 2xx: The request was successful. 3xx: The request was redirected. 4xx: The request was invalid. 5xx: A server-side error occurred.	200
Success	boolean	Indicates whether the request was successful. true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.