全部产品
Search
文档中心

:GetResourceGroup

更新时间:Aug 02, 2023

调用GetResourceGroup查询资源组信息。

使用说明

本文将提供一个示例,查询ID为rg-9gLOoK****的资源组信息。

调试

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

请求参数

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

要执行的操作。取值:GetResourceGroup

ResourceGroupId String rg-9gLOoK****

资源组ID。

您可以调用ListResourceGroups查询资源组ID。

IncludeTags Boolean true

是否返回标签信息。取值:

  • false(默认值):不返回。
  • true:返回。

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

返回数据

名称 类型 示例值 描述
RequestId String 2D69A58F-345C-4FDE-88E4-BF5189484043

请求ID。

ResourceGroup Object

资源组信息。

DisplayName String my-project

资源组显示名称。

Status String OK

资源组状态。

  • Creating:创建中。
  • OK:创建成功。
  • PendingDelete:等待删除。
RegionStatuses Array of RegionStatus

各个地域的资源组状态。

RegionStatus
Status String OK

资源组状态。

  • Creating:创建中。
  • OK:创建成功。
  • PendingDelete:等待删除。
  • Deleting:删除中。
RegionId String cn-qingdao

地域ID。

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=GetResourceGroup
&ResourceGroupId=rg-9gLOoK****
&IncludeTags=true
&<公共请求参数>

正常返回示例

XML格式

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

<GetResourceGroupResponse>
    <RequestId>2D69A58F-345C-4FDE-88E4-BF5189484043</RequestId>
    <ResourceGroup>
        <Id>rg-9gLOoK****</Id>
        <AccountId>123456789****</AccountId>
        <Name>my-project</Name>
        <DisplayName>my-project</DisplayName>
        <Status>OK</Status>
        <RegionStatuses>
            <RegionStatus>
                <RegionId>cn-hangzhou</RegionId>
                <Status>OK</Status>
            </RegionStatus>
            <RegionStatus>
                <RegionId>cn-qingdao</RegionId>
                <Status>OK</Status>
            </RegionStatus>
        </RegionStatuses>
        <CreateDate>2015-01-23T12:33:18Z</CreateDate>
        <Tags>
            <Tag>
                <TagKey>k1</TagKey>
                <TagValue>v1</TagValue>
            </Tag>
        </Tags>
    </ResourceGroup>
</GetResourceGroupResponse>

JSON格式

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

{
  "RequestId" : "2D69A58F-345C-4FDE-88E4-BF5189484043",
  "ResourceGroup" : {
    "Id" : "rg-9gLOoK****",
    "AccountId" : "123456789****",
    "Name" : "my-project",
    "DisplayName" : "my-project",
    "Status" : "OK",
    "RegionStatuses" : {
      "RegionStatus" : [ {
        "RegionId" : "cn-hangzhou",
        "Status" : "OK"
      }, {
        "RegionId" : "cn-qingdao",
        "Status" : "OK"
      } ]
    },
    "CreateDate" : "2015-01-23T12:33:18Z",
    "Tags" : {
      "Tag" : [ {
        "TagKey" : "k1",
        "TagValue" : "v1"
      } ]
    }
  }
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParameter.ResourceGroupId The ResourceGroupId is invalid. 资源组ID无效。
403 NoPermission You are not authorized to perform the operation. 没有权限进行这个操作。
404 EntityNotExists.ResourceGroup The specified resource group does not exist. You must first create a resource group. 资源组不存在,请先创建资源组。

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