All Products
Search
Document Center

Cloud Phone:DescribeGroups

Last Updated:Nov 14, 2025

Queries user 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:DescribeGroupsget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GroupIdstringNo

The ID of the user group.

ug-12341234****
BizTypestringNo
Note This parameter is not publicly available.
ENTERPRISE
SolutionIdstringNo
Note This parameter is not publicly available.
co-0esnf80jab***
GroupNamestringNo

The name of the user group.

TestGroup
PageSizeintegerNo

The number of entries to return on each page. Valid values: 1 to 100. Default value: 10.

10
PageNumberintegerNo

The number of the page to return.

1
TransferFileNeedApprovalbooleanNo

Indicates whether the file approval feature is enabled.

false
LoginPolicyIdstringNo

指定关联的登录策略筛选。

ExcludeAttachedLoginPolicyGroupsbooleanNo

是否排除已关联登录策略的用户组。

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Groupsarray<object>

The user groups.

groupobject

The information about the user group.

GroupNamestring

The name of the user group.

TestGroup
Descriptionstring

The description of the user group.

A test group.
CreateTimestring

The time when the user group is created.

2025-08-07T13:40:40+08:00
UserCountinteger

The number of users in the user group.

20
TransferFileNeedApprovalboolean

Indicates whether the file approval feature is enabled.

false
AuthedResourcesobject

The type of the resource assigned to the user group.

string

The type of the resource assigned to the user group.

Valid value:

  • DesktopGroup: shared cloud computers
DesktopGroup
Countinteger

The number of the entries returned.

1

Examples

Sample success responses

JSONformat

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "Groups": [
    {
      "GroupName": "TestGroup",
      "GroupId": "ug-2412ojkwtybd****",
      "Description": "A test group.",
      "CreateTime": "2025-08-07T13:40:40+08:00",
      "UserCount": 20,
      "TransferFileNeedApproval": false,
      "AuthedResources": {
        "key": "DesktopGroup"
      },
      "AttachedLoginPolicy": {
        "PolicyId": "",
        "Name": ""
      }
    }
  ],
  "Count": 1
}

Error codes

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