DescribeNamespaceResources - - Alibaba Cloud Documentation Center

Query the information about resources in 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:DescribeNamespaceResources	get	All Resources *	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
NamespaceId	string	No	cn-shanghai:test	cn-shanghai:test

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 code 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.	0a98a02315955564772843261e****
Data	object	The returned data.
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-2ze0i263cnn311nvj****
LastChangeOrderId	string	The ID of the change order.	afedb3c4-63f8-4a3d-aaa3-2c30363f****
BelongRegion	string	The region to which the namespace belongs.	cn-shanghai
NamespaceId	string	The ID of the namespace.	cn-shangha:test
SecurityGroupId	string	The ID of the security group.	sg-wz969ngg2e49q5i4****
UserId	string	The ID of the user.	test@aliyun.com
NamespaceName	string	The name of the namespace.	test
LastChangeOrderStatus	string	The status of the latest change order. Valid values: READY: The change order is ready. RUNNING: The change order is being executed. SUCCESS: The change order was executed. FAIL: The change order could not be executed. ABORT: The change order was terminated. WAIT_BATCH_CONFIRM: The change order is pending execution. You must manually confirm the release batch. AUTO_BATCH_WAIT: The change order is pending execution. SAE will automatically confirm the release batch. SYSTEM_FAIL: A system exception occurred. WAIT_APPROVAL: The change order is pending approval. APPROVED: The change order is approved and is pending execution.	SUCCESS
VpcName	string	The name of the VPC.	test
VSwitchId	string	The ID of the vSwitch.	vsw-2ze559r1z1bpwqxwp****
Description	string	The description of the namespace.	decs
LastChangeOrderRunning	boolean	Indicates whether a change order is being executed in the namespace. Valid values: true: indicates that a change order is being executed in the namespace. false: indicates that no change orders are being executed in the namespace.	true
AppCount	long	The number of applications.	1
VSwitchName	string	The name of the vSwitch.	test
NotificationExpired	boolean	Indicates whether the notification of a change order is expired. Valid values: true: indicates that the notification is expired. false: indicates that the notification is not expired.	true
TenantId	string	The ID of the tenant in the SAE namespace.	838cad95-973f-48fe-830b-2a8546d7****
JumpServerAppId	string	The ID of the jump server application.	5ec46468-6b26-4a3c-9f7c-bf88761a****
JumpServerIp	string	The IP address of the jump server.	120.78.XXX.XX
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 information about resources in the namespace was 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": "0a98a02315955564772843261e****",
  "Data": {
    "VpcId": "vpc-2ze0i263cnn311nvj****",
    "LastChangeOrderId": "afedb3c4-63f8-4a3d-aaa3-2c30363f****",
    "BelongRegion": "cn-shanghai",
    "NamespaceId": "cn-shangha:test",
    "SecurityGroupId": "sg-wz969ngg2e49q5i4****",
    "UserId": "test@aliyun.com",
    "NamespaceName": "test",
    "LastChangeOrderStatus": "SUCCESS",
    "VpcName": "test",
    "VSwitchId": "vsw-2ze559r1z1bpwqxwp****",
    "Description": "decs",
    "LastChangeOrderRunning": true,
    "AppCount": 1,
    "VSwitchName": "test",
    "NotificationExpired": true,
    "TenantId": "838cad95-973f-48fe-830b-2a8546d7****",
    "JumpServerAppId": "5ec46468-6b26-4a3c-9f7c-bf88761a****",
    "JumpServerIp": "120.78.XXX.XX",
    "NameSpaceShortId": "test"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.

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

Change history

Change time	Summary of changes	Operation

No change history