調(diào)用ListResourceGroups查詢資源組列表。
接口說(shuō)明
您可以調(diào)用本 API 查詢當(dāng)前賬號(hào)下的所有資源組列表，也可以根據(jù)資源組狀態(tài)、資源組 ID、資源組標(biāo)識(shí)或資源組顯示名稱查詢對(duì)應(yīng)的資源組列表。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Status | string | 否 | 資源組狀態(tài)，用于查詢的過(guò)濾條件。取值：
| OK |
| PageNumber | integer | 否 | 頁(yè)碼。 起始值：1。默認(rèn)值：1。 | 1 |
| PageSize | integer | 否 | 分頁(yè)時(shí)每頁(yè)顯示的數(shù)據(jù)條數(shù)。 取值范圍：1~100。默認(rèn)值：10。 | 10 |
| ResourceGroupId | string | 否 | 資源組 ID，用于查詢的過(guò)濾條件。 長(zhǎng)度不能超過(guò) 18 個(gè)字符，且以 說(shuō)明
該參數(shù)已被收編到參數(shù) ResourceGroupIds，如果您同時(shí)設(shè)置了ResourceGroupId和ResourceGroupIds，則會(huì)以ResourceGroupIds為準(zhǔn)。
| rg-9gLOoK**** |
| DisplayName | string | 否 | 資源組顯示名稱，用于查詢的過(guò)濾條件。支持模糊查詢。 長(zhǎng)度不能超過(guò) 50 個(gè)字符。 | my-project |
| Name | string | 否 | 資源組唯一標(biāo)識(shí)，用于查詢的過(guò)濾條件。支持模糊查詢。 長(zhǎng)度不能超過(guò) 50 個(gè)字符，可包含英文字母、數(shù)字和短劃線（-）。 | my-project |
| Tag | object [] | 否 | 標(biāo)簽，用于查詢的過(guò)濾條件。 最多可以設(shè)置 20 個(gè)標(biāo)簽。 | |
| Key | string | 否 | 標(biāo)簽鍵。 | k1 |
| Value | string | 否 | 標(biāo)簽值。 | v1 |
| IncludeTags | boolean | 否 | 是否返回標(biāo)簽信息。取值：
說(shuō)明
當(dāng)您設(shè)置了標(biāo)簽過(guò)濾條件后，不論 IncludeTags為何值，都會(huì)返回標(biāo)簽信息。
| false |
| ResourceGroupIds | array | 否 | 資源組 ID 列表，用于查詢的過(guò)濾條件。 最多可以設(shè)置 100 個(gè)資源組 ID。 說(shuō)明
如果您同時(shí)設(shè)置了 ResourceGroupId和ResourceGroupIds，則會(huì)以ResourceGroupIds為準(zhǔn)。
| |
| string | 否 | 資源組 ID 列表，用于查詢的過(guò)濾條件。 最多可以設(shè)置 100 個(gè)資源組 ID。 說(shuō)明
如果您同時(shí)設(shè)置了 ResourceGroupId和ResourceGroupIds，則會(huì)以ResourceGroupIds為準(zhǔn)。
| {"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"
}
]
}
}
]
}
}錯(cuò)誤碼
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|