DescribeConfigGroup - 查询配置组列表

更新时间: 2025-03-13 14:28:32

查询配置组列表信息。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecd:DescribeConfigGrouplist
*全部资源
*

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。该功能无地域属性,该字段固定填写cn-shanghai

cn-shanghai
GroupIdstring

配置组 ID。

cg-i1ruuudp92qpj****
Namestring

配置组名称。

定时任务配置
Typestring

配置组类型。

枚举值:
  • Timer定时任务
Timer
ProductTypestring

配置组使用的产品类型。

枚举值:
  • CLOUD_DESKTOP云电脑
CLOUD_DESKTOP
Statusesarray

配置组状态列表。

string

配置组状态。

枚举值:
  • AVAILABLE可用
  • UNAVAILABLE已删除
  • DELETING删除中
  • UPDATING修改中
AVAILABLE
PageNumberinteger

当前页码。

1
PageSizeinteger

分页查询时,当前页的页码。

20
GroupIdsarray

配置组 ID 列表。

string

配置组 ID。

ccg-0cwz8naid24v*****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
Dataarray<object>

配置组信息。

dataobject

配置组信息。

GroupIdstring

配置组 ID。

ccg-0cid8v30an12****
Namestring

配置组名称。

定时任务
Descriptionstring

配置组描述信息。

定时任务信息
Typestring

配置组类型。

枚举值:
  • Timer定时任务
Timer
ProductTypestring

配置组使用的产品类型。

枚举值:
  • CLOUD_DESKTOP云电脑
CLOUD_DESKTOP
Statusstring

配置组状态。

枚举值:
  • AVAILABLE可用
  • UNAVAILABLE已删除
  • DELETING删除中
  • UPDATING修改中
AVAILABLE
BindCountinteger

配置组绑定的资源数。

4
BindCountMapobject

配置绑定资源的数量信息。

integer

绑定的资源数量。

10
PageNumberinteger

当前页码。

1
PageSizeinteger

每页数量。

20
TotalCountinteger

查询结果总数。

20

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "Data": [
    {
      "GroupId": "ccg-0cid8v30an12****",
      "Name": "定时任务",
      "Description": "定时任务信息",
      "Type": "Timer",
      "ProductType": "CLOUD_DESKTOP",
      "Status": "AVAILABLE",
      "BindCount": 4,
      "BindCountMap": {
        "key": 10
      }
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 20
}

错误码

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

上一篇: UnbindConfigGroup - 解绑配置组 下一篇: ModifyTimerGroup - 修改配置组设置
阿里云首页 无影云电脑 相关技术圈