DescribeConfigGroup - 查询配置组列表

更新时间:
复制 MD 格式

查询配置组列表信息。

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

RegionId

string

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

cn-shanghai

GroupId

string

配置组 ID。

cg-i1ruuudp92qpj****

Name

string

配置组名称。

Scheduled task configuration

Type

string

配置组类型。

枚举值:

  • Timer :

    定时任务

Timer

ProductType

string

配置组使用的产品类型。

枚举值:

  • CLOUD_DESKTOP :

    云电脑

CLOUD_DESKTOP

Statuses

array

配置组状态列表。

string

配置组状态。

枚举值:

  • AVAILABLE :

    可用

  • UNAVAILABLE :

    已删除

  • DELETING :

    删除中

  • UPDATING :

    修改中

AVAILABLE

PageNumber

integer

当前页码。

1

PageSize

integer

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

20

GroupIds

array

配置组 ID 列表。

string

配置组 ID。

ccg-0cwz8naid24v*****

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Data

array<object>

配置组信息。

array<object>

配置组信息。

GroupId

string

配置组 ID。

ccg-0cid8v30an12****

Name

string

配置组名称。

Scheduled task

Description

string

配置组描述信息。

Scheduled task information

Type

string

配置组类型。

枚举值:

  • Timer :

    定时任务

Timer

ProductType

string

配置组使用的产品类型。

枚举值:

  • CLOUD_DESKTOP :

    云电脑

CLOUD_DESKTOP

Status

string

配置组状态。

枚举值:

  • AVAILABLE :

    可用

  • UNAVAILABLE :

    已删除

  • DELETING :

    删除中

  • UPDATING :

    修改中

AVAILABLE

BindCount

integer

配置组绑定的资源数。

4

BindCountMap

object

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

integer

绑定的资源数量。

10

IsUpdate

boolean

系统定时任务检查使用,当前定时任务不支持修改

IsBind

boolean

系统定时任务检查使用,当前定时任务不支持解绑和绑定

InnerTimerName

string

前端展示使用,系统定时任务名称映射 code

INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE

InnerTimerDesc

string

前端展示使用,系统定时任务描述使用 code

INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE_DESC

PageNumber

integer

当前页码。

1

PageSize

integer

每页数量。

20

TotalCount

integer

查询结果总数。

20

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "Data": [
    {
      "GroupId": "ccg-0cid8v30an12****",
      "Name": "Scheduled task",
      "Description": "Scheduled task information",
      "Type": "Timer",
      "ProductType": "CLOUD_DESKTOP",
      "Status": "AVAILABLE",
      "BindCount": 4,
      "BindCountMap": {
        "key": 10
      },
      "IsUpdate": true,
      "IsBind": true,
      "InnerTimerName": "INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE",
      "InnerTimerDesc": "INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE_DESC"
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 20
}

错误码

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

变更历史

更多信息,参考变更详情