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