查詢命名空間內的資源資訊。
調試
您可以在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 |
使用者識別碼。 |
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 |
APM Java Agent 的版本號碼。 |
|
| SlsConfigs |
string |
日誌採集到 SLS 的配置。
參數說明如下:
多次部署時如果 SLS 採集配置沒有變更,則不需要設定該參數(即請求中無需包含 SlsConfigs 欄位);如果不再需要使用 SLS 採集功能,您需要在請求中將該欄位的值設定為空白字串(即請求中 SlsConfigs 欄位的值為"")。 |
|
| 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}。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。