调用DescribeNamespaceResources接口查询命名空间内的资源信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。更多信息,请参见公共请求和返回头。
请求语法
GET /pop/v1/sam/namespace/describeNamespaceResources HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
NamespaceId | String | Query | 否 | cn-shanghai:test |
长版命名空间ID。如果设置了该参数会继续生效而忽略NameSpaceShortId,该参数是为了兼容保留,推荐使用短版命名空间ID,简化参数。 |
NameSpaceShortId | String | Query | 否 | test |
短版命名空间ID,不需要带上region,推荐。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 91F93257-7A4A-4BD3-9A7E-2F6EAE6D**** |
请求ID。 |
Message | String | success |
附加信息。取值说明如下:
|
TraceId | String | 0a98a02315955564772843261e**** |
调用链ID,用于精确查询调用信息。 |
Data | Object |
返回结果。 |
|
VpcId | String | vpc-2ze0i263cnn311nvj**** |
VPC ID。 |
LastChangeOrderId | String | afedb3c4-63f8-4a3d-aaa3-2c30363f**** |
发布单ID。 |
BelongRegion | String | cn-shanghai |
命名空间所属地域。 |
NamespaceId | String | cn-shangha:test |
命名空间ID。 |
SecurityGroupId | String | sg-wz969ngg2e49q5i4**** |
安全组ID。 |
UserId | String | test@aliyun.com |
用户ID。 |
NamespaceName | String | test |
命名空间名称。 |
LastChangeOrderStatus | String | SUCCESS |
最近一次发布单状态。取值说明如下:
|
VpcName | String | test |
VPC名称。 |
VSwitchId | String | vsw-2ze559r1z1bpwqxwp**** |
vSwitch ID。 |
Description | String | decs |
命名空间描述信息。 |
LastChangeOrderRunning | Boolean | true |
命名空间是否有发布单运行。取值说明如下:
|
AppCount | Long | 1 |
应用个数。 |
VSwitchName | String | test |
vSwitch名称。 |
NotificationExpired | Boolean | true |
发布单通知是否过期。取值说明如下:
|
TenantId | String | 838cad95-973f-48fe-830b-2a8546d7**** |
SAE命名空间租户ID。 |
JumpServerAppId | String | 5ec46468-6b26-4a3c-9f7c-bf88761a**** |
跳板机应用ID。 |
JumpServerIp | String | 120.78.XXX.XX |
跳板机IP地址。 |
NameSpaceShortId | String | test |
短版命名空间ID。 |
ErrorCode | String | 空 |
错误码。取值说明如下:
|
Code | String | 200 |
接口状态或POP错误码。取值说明如下:
|
Success | Boolean | true |
查询命名空间资源信息是否成功。取值说明如下:
|
示例
请求示例
GET /pop/v1/sam/namespace/describeNamespaceResources?NameSpaceShortId=test HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json
正常返回示例
XML
格式
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
格式
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
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter.Obviously | The specified parameter is invalid {%s}. | 不合法的参数{%s}。 |
访问错误中心查看更多错误码。