All Products
Search
Document Center

Elastic Desktop Service:DescribeConfigGroup

Last Updated:Nov 14, 2025

Queries configuration groups.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecd:DescribeConfigGrouplist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The ID of the region. Set the value to cn-shanghai.

cn-hangzhou
GroupIdstringNo

The ID of the configuration group.

cg-i1ruuudp92qpj****
NamestringNo

The name of the configuration group.

ScheduledTask
TypestringNo

The type of the configuration group.

Valid value:

  • Timer: the scheduled task type.
Timer
ProductTypestringNo

The service type of the configuration group.

Valid value:

  • CLOUD_DESKTOP: the cloud computer service.
CLOUD_DESKTOP
StatusesarrayNo

The status of the configuration groups.

stringNo

The state of the configuration group.

Valid values:

  • AVAILABLE: The configuration group is available.
  • UNAVAILABLE: The configuration group is deleted.
  • DELETING: The configuration group is being deleted.
  • UPDATING: The configuration group is being modified.
AVAILABLE
PageNumberintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page.

20
GroupIdsarrayNo

The IDs of the configuration groups.

stringNo

The ID of the configuration group.

ccg-0cwz8naid24v*****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

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

The configuration groups.

dataobject

The configuration group.

GroupIdstring

The ID of the configuration group.

ccg-0cid8v30an12****
Namestring

The name of the configuration group.

ScheduledTask
Descriptionstring

The description of the configuration group.

ScheduledTask
Typestring

The type of the configuration group.

Valid values:

  • Timer: the scheduled task type.
Timer
ProductTypestring

The service type of the configuration group.

Valid values:

  • CLOUD_DESKTOP: the cloud computer service.
CLOUD_DESKTOP
Statusstring

The state of the configuration group.

Valid values:

  • AVAILABLE: The configuration group is available.
  • UNAVAILABLE: The configuration group is deleted.
  • DELETING: The configuration group is being deleted.
  • UPDATING: The configuration group is being modified.
AVAILABLE
BindCountinteger

The number of resources that are bound to the configuration group.

4
BindCountMapobject

The number of bound cloud computers.

integer

The number of bound resources.

10
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of entries returned.

20

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.