Retrieve Namespace Lists via DescribeNamespaceList API - SAE - Alibaba Cloud - Serverless App Engine

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

get

*All Resource

*

None

Request syntax

GET /pop/v1/sam/namespace/describeNamespaceList HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ContainCustom	boolean	No	Specifies whether to return custom namespaces. Valid values: true: The system returns custom namespaces. false: The system does not return custom namespaces.	true
HybridCloudExclude	boolean	No	Indicates whether hybrid cloud namespaces are excluded. Valid values: true: Hybrid cloud namespaces are excluded. false: Hybrid cloud namespaces are included.	true

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	30375C38-F4ED-4135-A0AE-5C75DC7F****
Message	string	The returned message. 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.	ac1a0b2215622920113732501e****
Data	array<object>	The list of namespaces.
	object	The information about namespaces.
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-2ze0i263cnn311nvj****
VSwitchId	string	The ID of the vSwitch.	vsw-2ze559r1z1bpwqxwp****
Custom	boolean	Indicates whether custom namespaces are returned. Valid values: true: Custom namespaces are returned. false: Custom namespaces are not returned.	true
AgentInstall	string	The command that was run to install the agent.	http://edas-bj.oss-cn-beijing-internal.aliyuncs.com/test/install.sh
NamespaceId	string	The ID of the namespace.	cn-beijing:test
HybridCloudEnable	boolean	Indicates whether hybrid cloud namespaces are excluded. Valid values: true: Hybrid cloud namespaces are excluded. false: Hybrid cloud namespaces are included.	false
SecurityGroupId	string	The ID of the security group.	sg-wz969ngg2e49q5i4****
Current	boolean	This parameter is no longer valid.	false
NamespaceName	string	The name of the namespace.	test
RegionId	string	The region to which the namespace belongs.	cn-beijing
NameSpaceShortId	string	The short ID of the namespace.	test
ErrorCode	string	The error code. Valid values: If the call is successful, the ErrorCode parameter is not returned. If the call fails, the ErrorCode parameter is returned. 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 list of namespaces was queried. Valid values: true: The list was queried. false: The list failed to be queried.	true

Examples

Success response

JSON format

{
  "RequestId": "30375C38-F4ED-4135-A0AE-5C75DC7F****",
  "Message": "success",
  "TraceId": "ac1a0b2215622920113732501e****",
  "Data": [
    {
      "VpcId": "vpc-2ze0i263cnn311nvj****",
      "VSwitchId": "vsw-2ze559r1z1bpwqxwp****",
      "Custom": true,
      "AgentInstall": "http://edas-bj.oss-cn-beijing-internal.aliyuncs.com/test/install.sh",
      "NamespaceId": "cn-beijing:test",
      "HybridCloudEnable": false,
      "SecurityGroupId": "sg-wz969ngg2e49q5i4****",
      "Current": false,
      "NamespaceName": "test",
      "RegionId": "cn-beijing",
      "NameSpaceShortId": "test"
    }
  ],
  "ErrorCode": "NULL",
  "Code": "200",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.