调用ListResourceGroups查询资源组列表。

使用说明

您可以调用本API查询当前账号下的所有资源组列表,也可以根据资源组状态、资源组ID、资源组标识或资源组显示名称查询对应的资源组列表。

本文将提供一个示例,查询当前账号下的资源组rg-1hSBH2****rg-9gLOoK****的基本信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListResourceGroups

要执行的操作。取值:ListResourceGroups

Status String OK

资源组状态,用于查询的过滤条件。取值:

  • Creating:创建中。
  • OK:创建成功。
  • PendingDelete:等待删除。
PageNumber Integer 1

页码。

起始值:1。默认值:1。

PageSize Integer 10

分页时每页显示的数据条数。

取值范围:1~100。默认值:10。

ResourceGroupId String rg-9gLOoK****

资源组ID,用于查询的过滤条件。

长度不能超过18个字符,且以rg-开头。

说明 该参数已被收编到参数ResourceGroupIds,如果您同时设置了ResourceGroupIdResourceGroupIds,则会以ResourceGroupIds为准。
DisplayName String my-project

资源组显示名称,用于查询的过滤条件。支持模糊查询。

长度不能超过50个字符。

Name String my-project

资源组唯一标识,用于查询的过滤条件。支持模糊查询。

长度不能超过50个字符,可包含英文字母、数字和短划线(-)。

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。

说明 如果您同时设置了ResourceGroupIdResourceGroupIds,则会以ResourceGroupIds为准。

关于公共请求参数的详情,请参见公共参数

返回数据

名称 类型 示例值 描述
TotalCount Integer 2

符合请求参数条件的数据总条数。

RequestId String 4B450CA1-36E8-4AA2-8461-86B42BF4CC4E

请求ID。

PageSize Integer 10

分页时每页显示的数据条数。

PageNumber Integer 1

页码。

ResourceGroups Array of ResourceGroup

资源组列表。

ResourceGroup
DisplayName String my-project

资源组显示名称。

Status String OK

资源组状态。

  • Creating:创建中。
  • OK:创建成功。
  • PendingDelete:等待删除。
AccountId String 123456789****

资源组所属的阿里云账号ID。

Name String my-project

资源组唯一标识。

CreateDate String 2015-01-23T12:33:18Z

资源组创建时间(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****
&<公共请求参数>

正常返回示例

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"
        } ]
      }
    } ]
  }
}

错误码

访问错误中心查看更多错误码。