ListResourceGroups - 查询资源组列表-阿里云帮助中心

调用ListResourceGroups查询资源组列表。

接口说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Status	string	否	资源组状态，用于查询的过滤条件。取值： Creating：创建中。 OK：创建成功。 PendingDelete：等待删除。	OK
PageNumber	integer	否	页码。起始值：1。默认值：1。	1
PageSize	integer	否	分页时每页显示的数据条数。取值范围：1~100。默认值：10。	10
ResourceGroupId	string	否	资源组 ID，用于查询的过滤条件。长度不能超过 18 个字符，且以`rg-`开头。说明该参数已被收编到参数`ResourceGroupIds`，如果您同时设置了`ResourceGroupId`和`ResourceGroupIds`，则会以`ResourceGroupIds`为准。	rg-9gLOoK****
DisplayName	string	否	资源组显示名称，用于查询的过滤条件。支持模糊查询。长度不能超过 50 个字符。	my-project
Name	string	否	资源组唯一标识，用于查询的过滤条件。支持模糊查询。长度不能超过 50 个字符，可包含英文字母、数字和短划线（-）。	my-project
Tag	object []	否	标签，用于查询的过滤条件。最多可以设置 20 个标签。
Key	string	否	标签键。	k1
Value	string	否	标签值。	v1
IncludeTags	boolean	否	是否返回标签信息。取值： false（默认值）：不返回。 true：返回。说明当您设置了标签过滤条件后，不论`IncludeTags`为何值，都会返回标签信息。	false
ResourceGroupIds	array	否	资源组 ID 列表，用于查询的过滤条件。最多可以设置 100 个资源组 ID。说明如果您同时设置了`ResourceGroupId`和`ResourceGroupIds`，则会以`ResourceGroupIds`为准。
	string	否	资源组 ID 列表，用于查询的过滤条件。最多可以设置 100 个资源组 ID。说明如果您同时设置了`ResourceGroupId`和`ResourceGroupIds`，则会以`ResourceGroupIds`为准。	{"rg-1hSBH2**","rg-9gLOoK**"}

返回参数

名称	类型	描述	示例值
	object	返回结果。
TotalCount	integer	符合请求参数条件的数据总条数。	2
RequestId	string	请求 ID。	4B450CA1-36E8-4AA2-8461-86B42BF4CC4E
PageSize	integer	分页时每页显示的数据条数。	10
PageNumber	integer	页码。	1
ResourceGroups	object []	资源组列表。
DisplayName	string	资源组显示名称。	my-project
Status	string	资源组状态。取值： Creating：创建中。 OK：创建成功。 PendingDelete：等待删除。	OK
AccountId	string	资源组所属的阿里云账号 ID。	123456789****
Name	string	资源组唯一标识。	my-project
CreateDate	string	资源组创建时间（UTC 时间）。	2015-01-23T12:33:18Z
Id	string	资源组 ID。	rg-9gLOoK****
Tags	object []	标签列表。
TagKey	string	标签键。	k1
TagValue	string	标签值。	v1

示例

正常返回示例

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

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史