Queries the information of the resources in a namespace.
Debugging
Request headers
This operation does not have operation-specific request headers and uses only common request headers. For more information, see Common request and response headers.
Request syntax
GET /pop/v1/sam/namespace/describeNamespaceResources HTTP/1.1
Request parameters
Parameter | Type | Position | Required | Example | Description |
---|---|---|---|---|---|
NamespaceId | String | Query | No | cn-shanghai:test | The long ID of the namespace. If you configure this parameter, the long ID take effects and the value of the NameSpaceShortId parameter is ignored. To ensure compatibility, we recommend that you specify a short namespace ID. |
NameSpaceShortId | String | Query | No | test | The short ID of the namespace. You do not need to specify a region ID. We recommend that you configure this parameter. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 91F93257-7A4A-4BD3-9A7E-2F6EAE6D**** | The request ID. |
Message | String | success | The returned message. Valid values:
|
TraceId | String | 0a98a02315955564772843261e**** | The trace ID that is used to query the details of the request. |
Data | Object | The returned data. |
|
VpcId | String | vpc-2ze0i263cnn311nvj**** | The VPC ID. |
LastChangeOrderId | String | afedb3c4-63f8-4a3d-aaa3-2c30363f**** | The ID of the latest change order. |
BelongRegion | String | cn-shanghai | The region where the namespace resides. |
NamespaceId | String | cn-shangha:test | The namespace ID. |
SecurityGroupId | String | sg-wz969ngg2e49q5i4**** | The ID of the security group. |
UserId | String | test@aliyun.com | The user ID. |
NamespaceName | String | test | The name of the namespace. |
LastChangeOrderStatus | String | SUCCESS | The status of the latest change order. Valid values:
|
VpcName | String | test | The name of the VPC. |
VSwitchId | String | vsw-2ze559r1z1bpwqxwp**** | The vSwitch ID. |
Description | String | decs | The description of the namespace. |
LastChangeOrderRunning | Boolean | true | Indicates whether the latest change order in the namespace is being executed. Valid values:
|
AppCount | Long | 1 | The number of applications. |
VSwitchName | String | test | The name of the vSwitch. |
NotificationExpired | Boolean | true | Indicates whether the notification of the change order is expired. Valid values:
|
TenantId | String | 838cad95-973f-48fe-830b-2a8546d7**** | The ID of the tenant in the SAE namespace. |
JumpServerAppId | String | 5ec46468-6b26-4a3c-9f7c-bf88761a**** | The ID of the application with witch the jump server is associated. |
JumpServerIp | String | 120.78.XXX.XX | The IP address of the jump server. |
NameSpaceShortId | String | test | The short ID of the namespace. |
ErrorCode | String | Null | The error code. Valid values:
|
Code | String | 200 | The HTTP status code. Valid values:
|
Success | Boolean | true | Indicates whether the information of resources in the namespace was queried. Valid values:
|
Examples
Sample requests
GET /pop/v1/sam/namespace/describeNamespaceResources?NameSpaceShortId=test HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeNamespaceResourcesResponse>
<RequestId>91F93257-7A4A-4BD3-9A7E-2F6EAE6D****</RequestId>
<Message>success</Message>
<TraceId>0a98a02315955564772843261e****</TraceId>
<Data>
<VpcId>vpc-2ze0i263cnn311nvj****</VpcId>
<LastChangeOrderId>afedb3c4-63f8-4a3d-aaa3-2c30363f****</LastChangeOrderId>
<BelongRegion>cn-shanghai</BelongRegion>
<NamespaceId>cn-shangha:test</NamespaceId>
<SecurityGroupId>sg-wz969ngg2e49q5i4****</SecurityGroupId>
<UserId>test@aliyun.com</UserId>
<NamespaceName>test</NamespaceName>
<LastChangeOrderStatus>SUCCESS</LastChangeOrderStatus>
<VpcName>test</VpcName>
<VSwitchId>vsw-2ze559r1z1bpwqxwp****</VSwitchId>
<Description>decs</Description>
<LastChangeOrderRunning>true</LastChangeOrderRunning>
<AppCount>1</AppCount>
<VSwitchName>test</VSwitchName>
<NotificationExpired>true</NotificationExpired>
<TenantId>838cad95-973f-48fe-830b-2a8546d7****</TenantId>
<JumpServerAppId>5ec46468-6b26-4a3c-9f7c-bf88761a****</JumpServerAppId>
<JumpServerIp>120.78.XXX.XX</JumpServerIp>
</Data>
<Code>200</Code>
<Success>true</Success>
</DescribeNamespaceResourcesResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"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"
},
"Code" : "200",
"Success" : true
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidParameter.Obviously | The specified parameter is invalid {%s}. | The value of the {%s} parameter is invalid. |
For a list of error codes, see Service error codes.