Retrieve SAE Namespace Details via DescribeNamespace API - Serverless App Engine - Alibaba Cloud - Serverless App Engine

Queries the details of a namespace.

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:DescribeNamespace

get

*All Resource

*

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 elements

Element	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

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.