DescribeNamespace - - Alibaba Cloud Documentation Center

Queries the details of a namespace.

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:DescribeNamespace	get	All Resources ``	none	none

Request syntax

GET /pop/v1/paas/namespace HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
NamespaceId	string	No	The ID of the namespace. The information about the default namespace cannot be queried or modified. The default namespace cannot be deleted.	cn-beijing:test
NameSpaceShortId	string	No	The short ID of the namespace. You do not need to specify a region ID. The value of this parameter can be up to 20 characters in length and can contain only lowercase letters and digits.	test

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The additional information that is returned. Valid values: success: If the call is successful, success is returned. An error code: If the call fails, an error code is returned.	success
TraceId	string	The trace ID that is used to query the details of the request.	0a981dd515966966104121683d****
Data	object	The information about the namespace.
NamespaceDescription	string	The description of the namespace.	desc
NamespaceId	string	The ID of the namespace. The information about 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
RegionId	string	The region ID.	cn-beijing
NameSpaceShortId	string	The short ID of the namespace.	test
EnableMicroRegistration	boolean	Indicates whether the SAE built-in registry is enabled. Valid values: true false	true
ErrorCode	string	The error code returned. Take note of the following rules: The ErrorCode parameter is not returned if the request succeeds. The ErrorCode parameter is returned if the request fails. For more information, see the Error codes section in this topic.	Null
Code	string	The HTTP status code. Valid values: 2xx: The call was successful. 3xx: The call was redirected. 4xx: The call failed. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the information about the namespace was queried successfully. Valid values: true: The information was queried. false: The image failed to be found.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a981dd515966966104121683d****",
  "Data": {
    "NamespaceDescription": "desc",
    "NamespaceId": "cn-beijing:test",
    "NamespaceName": "name",
    "RegionId": "cn-beijing",
    "NameSpaceShortId": "test",
    "EnableMicroRegistration": true
  },
  "ErrorCode": "Null\n",
  "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

No change history