DescribeResourceGroups - 查看资源组信息

更新时间:
复制为 MD 格式

查看资源组。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:DescribeResourceGroups

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

ResourceGroupName

string

资源组名称。

部门A资源组

ResourceGroupIds

array

资源组 ID 列表。

string

资源组 ID。

rg-9th3k8twp3ox2***

PageSize

integer

每页数量。

20

PageNumber

integer

页码。

1

NeedContainResourceGroupWithOfficeSite

integer

说明

该参数不对外开放使用。

0

Platform

string

说明

固定值:AliyunConsole。

  • 无影企业版固定传 AliyunConsole,其他平台暂不对外开放。

AliyunConsole

BusinessChannel

string

渠道标记

ENTERPRISE

AliyunResourceGroupIds

array

云平台资源组 ID。

string

资源组 ID。

rg-as8nlsbsxsldk***

ResourceClassification

string

返回参数

名称

类型

描述

示例值

object

返回信息集合。

RequestId

string

请求 ID。

68BA1DF7-8814-5AED-B844-F8F7F7****

ResourceGroup

array<object>

资源组信息列表。

array<object>

资源组信息。

ResourceGroupId

string

资源组 ID。

rg-cyo0il2pzge1***

ResourceGroupName

string

资源组名称。

测试资源组

ResourceCount

string

资源组内的资源数量。

119

AuthCount

string

资源组授权的管理员数量。

3

CreateTime

string

创建时间。

2022-11-29T17:25:40.000000000Z

Policies

array<object>

说明

资源组关联的策略。

  • 关联策略会对资源组内的云电脑生效,如果有多个策略,会按策略的优先级生效。

  • 如果资源组内的云电脑本身已指定其他策略,资源组关联的策略优先生效。

object

Id

string

策略 ID。

pl-a8jnatl8kjasb***

Name

string

策略名称。

测试策略123

IsDefault

boolean

是否默认策略。

False

Timers

array<object>

说明

关联的定时任务。

  • 关联的定时任务会对资源组内的云电脑生效,如果资源组内的云电脑本身已关联其他定时任务,资源组关联的任务优先生效。

object

Id

string

定时任务 ID。

t-asdzx0mbjhg***

Name

string

定时任务名称。

测试任务123

TimerStatus

string

BindStatus

string

AppRules

array<object>

object

Id

string

Name

string

Type

integer

AliyunResourceGroupId

string

阿里云资源组 ID

rg-123456

TotalCount

string

资源组总个数。

7

示例

正常返回示例

JSON格式

{
  "RequestId": "68BA1DF7-8814-5AED-B844-F8F7F7****",
  "ResourceGroup": [
    {
      "ResourceGroupId": "rg-cyo0il2pzge1***",
      "ResourceGroupName": "测试资源组",
      "ResourceCount": "119",
      "AuthCount": "3",
      "CreateTime": "2022-11-29T17:25:40.000000000Z",
      "Policies": [
        {
          "Id": "pl-a8jnatl8kjasb***",
          "Name": "测试策略123",
          "IsDefault": true
        }
      ],
      "Timers": [
        {
          "Id": "t-asdzx0mbjhg***",
          "Name": "测试任务123",
          "TimerStatus": "",
          "BindStatus": ""
        }
      ],
      "AppRules": [
        {
          "Id": "",
          "Name": "",
          "Type": 0
        }
      ],
      "AliyunResourceGroupId": "rg-123456"
    }
  ],
  "TotalCount": "7"
}

错误码

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

变更历史

更多信息,参考变更详情