調(diào)用ListResourceGroups查詢資源組列表。

使用說明

您可以調(diào)用本API查詢當前賬號下的所有資源組列表，也可以根據(jù)資源組狀態(tài)、資源組ID、資源組標識或資源組顯示名稱查詢對應的資源組列表。

本文將提供一個示例，查詢當前賬號下的資源組rg-1hSBH2****和rg-9gLOoK****的基本信息。

調(diào)試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 ListResourceGroups

要執(zhí)行的操作。取值：ListResourceGroups。

Status String 否 OK

資源組狀態(tài)，用于查詢的過濾條件。取值：

  • Creating：創(chuàng)建中。
  • OK：創(chuàng)建成功。
  • PendingDelete：等待刪除。
PageNumber Integer 否 1

頁碼。

起始值：1。默認值：1。
PageSize Integer 否 10

分頁時每頁顯示的數(shù)據(jù)條數(shù)。

取值范圍：1~100。默認值：10。
ResourceGroupId String 否 rg-9gLOoK****

資源組ID，用于查詢的過濾條件。

長度不能超過18個字符，且以rg-開頭。

說明 該參數(shù)已被收編到參數(shù)ResourceGroupIds，如果您同時設置了ResourceGroupId和ResourceGroupIds，則會以ResourceGroupIds為準。
DisplayName String 否 my-project

資源組顯示名稱，用于查詢的過濾條件。支持模糊查詢。

長度不能超過50個字符。
Name String 否 my-project

資源組唯一標識，用于查詢的過濾條件。支持模糊查詢。

長度不能超過50個字符，可包含英文字母、數(shù)字和短劃線（-）。
Tag Array 否

標簽，用于查詢的過濾條件。
Key String 否 k1

標簽鍵。
Value String 否 v1

標簽值。
IncludeTags Boolean 否 false

是否返回標簽信息。取值：

  • false（默認值）：不返回。
  • true：返回。
    說明 當您設置了標簽過濾條件后，不論IncludeTags為何值，都會返回標簽信息。
ResourceGroupIds Array of String 否 {"rg-1hSBH2****","rg-9gLOoK****"}

資源組ID列表，用于查詢的過濾條件。

最多可以設置100個資源組ID。

說明 如果您同時設置了ResourceGroupId和ResourceGroupIds，則會以ResourceGroupIds為準。

關于公共請求參數(shù)的詳情，請參見公共參數(shù)。

返回數(shù)據(jù)

名稱 類型 示例值 描述
TotalCount Integer 2

符合請求參數(shù)條件的數(shù)據(jù)總條數(shù)。
RequestId String 4B450CA1-36E8-4AA2-8461-86B42BF4CC4E

請求ID。
PageSize Integer 10

分頁時每頁顯示的數(shù)據(jù)條數(shù)。
PageNumber Integer 1

頁碼。
ResourceGroups Array of ResourceGroup

資源組列表。
ResourceGroup
DisplayName String my-project

資源組顯示名稱。
Status String OK

資源組狀態(tài)。

  • Creating：創(chuàng)建中。
  • OK：創(chuàng)建成功。
  • PendingDelete：等待刪除。
AccountId String 123456789****

資源組所屬的阿里云賬號ID。
Name String my-project

資源組唯一標識。
CreateDate String 2015-01-23T12:33:18Z

資源組創(chuàng)建時間（UTC時間）。
Id String rg-9gLOoK****

資源組ID。
Tags Array of Tag

標簽列表。
Tag
TagKey String k1

標簽鍵。
TagValue String v1

標簽值。

示例

請求示例

https://resourcemanager.aliyuncs.com/?Action=ListResourceGroups
&IncludeTags=true
&ResourceGroupIds.1=rg-1hSBH2****
&ResourceGroupIds.2=rg-9gLOoK****
&<公共請求參數(shù)>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListResourceGroupsResponse>
    <RequestId>4B450CA1-36E8-4AA2-8461-86B42BF4CC4E</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <TotalCount>2</TotalCount>
    <ResourceGroups>
        <ResourceGroup>
            <Id>rg-1hSBH2****</Id>
            <AccountId>123456789****</AccountId>
            <Name>default</Name>
            <DisplayName>默認資源組</DisplayName>
            <Status>OK</Status>
            <CreateDate>2015-01-23T12:33:18Z</CreateDate>
            <Tags>
                <Tag>
                    <TagKey>k1</TagKey>
                    <TagValue>v1</TagValue>
                </Tag>
            </Tags>
        </ResourceGroup>
        <ResourceGroup>
            <Id>rg-9gLOoK****</Id>
            <AccountId>123456789****</AccountId>
            <Name>my-project</Name>
            <DisplayName>my-project</DisplayName>
            <Status>OK</Status>
            <CreateDate>2015-01-23T12:33:18Z</CreateDate>
            <Tags>
                <Tag>
                    <TagKey>k2</TagKey>
                    <TagValue>v2</TagValue>
                </Tag>
            </Tags>
        </ResourceGroup>
    </ResourceGroups>
</ListResourceGroupsResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "4B450CA1-36E8-4AA2-8461-86B42BF4CC4E",
  "PageNumber" : 1,
  "PageSize" : 10,
  "TotalCount" : 2,
  "ResourceGroups" : {
    "ResourceGroup" : [ {
      "Id" : "rg-1hSBH2****",
      "AccountId" : "123456789****",
      "Name" : "default",
      "DisplayName" : "默認資源組",
      "Status" : "OK",
      "CreateDate" : "2015-01-23T12:33:18Z",
      "Tags" : {
        "Tag" : [ {
          "TagKey" : "k1",
          "TagValue" : "v1"
        } ]
      }
    }, {
      "Id" : "rg-9gLOoK****",
      "AccountId" : "123456789****",
      "Name" : "my-project",
      "DisplayName" : "my-project",
      "Status" : "OK",
      "CreateDate" : "2015-01-23T12:33:18Z",
      "Tags" : {
        "Tag" : [ {
          "TagKey" : "k2",
          "TagValue" : "v2"
        } ]
      }
    } ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。