調用ListResourceGroups查詢資源組列表。
接口說明
您可以調用本 API 查詢當前賬號下的所有資源組列表,也可以根據(jù)資源組狀態(tài)、資源組 ID、資源組標識或資源組顯示名稱查詢對應的資源組列表。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Status | string | 否 | 資源組狀態(tài),用于查詢的過濾條件。取值:
| OK |
PageNumber | integer | 否 | 頁碼。 起始值:1。默認值:1。 | 1 |
PageSize | integer | 否 | 分頁時每頁顯示的數(shù)據(jù)條數(shù)。 取值范圍:1~100。默認值:10。 | 10 |
ResourceGroupId | string | 否 | 資源組 ID,用于查詢的過濾條件。 長度不能超過 18 個字符,且以 說明
該參數(shù)已被收編到參數(shù) ResourceGroupIds ,如果您同時設置了ResourceGroupId 和ResourceGroupIds ,則會以ResourceGroupIds 為準。
| rg-9gLOoK**** |
DisplayName | string | 否 | 資源組顯示名稱,用于查詢的過濾條件。支持模糊查詢。 長度不能超過 50 個字符。 | my-project |
Name | string | 否 | 資源組唯一標識,用于查詢的過濾條件。支持模糊查詢。 長度不能超過 50 個字符,可包含英文字母、數(shù)字和短劃線(-)。 | my-project |
Tag | object [] | 否 | 標簽,用于查詢的過濾條件。 最多可以設置 20 個標簽。 | |
Key | string | 否 | 標簽鍵。 | k1 |
Value | string | 否 | 標簽值。 | v1 |
IncludeTags | boolean | 否 | 是否返回標簽信息。取值:
說明
當您設置了標簽過濾條件后,不論 IncludeTags 為何值,都會返回標簽信息。
| false |
ResourceGroupIds | array | 否 | 資源組 ID 列表,用于查詢的過濾條件。 最多可以設置 100 個資源組 ID。 說明
如果您同時設置了 ResourceGroupId 和ResourceGroupIds ,則會以ResourceGroupIds 為準。
| |
string | 否 | 資源組 ID 列表,用于查詢的過濾條件。 最多可以設置 100 個資源組 ID。 說明
如果您同時設置了 ResourceGroupId 和ResourceGroupIds ,則會以ResourceGroupIds 為準。
| {"rg-1hSBH2****","rg-9gLOoK****"} |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"TotalCount": 2,
"RequestId": "4B450CA1-36E8-4AA2-8461-86B42BF4CC4E",
"PageSize": 10,
"PageNumber": 1,
"ResourceGroups": {
"ResourceGroup": [
{
"DisplayName": "my-project",
"Status": "OK",
"AccountId": "123456789****",
"Name": "my-project",
"CreateDate": "2015-01-23T12:33:18Z",
"Id": "rg-9gLOoK****",
"Tags": {
"Tag": [
{
"TagKey": "k1",
"TagValue": "v1"
}
]
}
}
]
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|
暫無變更歷史