All Products
Search
Document Center

Elastic Desktop Service:DescribeUsersInGroup

Last Updated:Nov 14, 2025

Queries the information about authorized users of a cloud computer share, including the usernames, email addresses, mobile numbers, and cloud computer IDs.

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:DescribeUsersInGroupget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
DesktopGroupIdstringYes

The ID of the cloud computer share.

dg-8ttn55ujj8nj8****
MaxResultsintegerNo

The number of entries to return on each page.

  • Maximum value: 100.
  • Default value: 10.
10
NextTokenstringNo

The token that determines the start point of the next query. If this parameter is left empty, all results are returned.

caeba0bbb2be03f84eb48b699f0a4883
EndUserIdstringNo

The ID of the authorized user.

alice
ConnectStateintegerNo

The status of the desktop connection for the end user.

Valid values:

  • 0: Disconnected.
  • 1: Connected.
1
QueryUserDetailbooleanNo

Specifies whether to query user details.

Valid values:

  • true (default)
  • false
false
FilterstringNo

The query string for fuzzy match. If you specify this parameter, the system returns all results that contain the string.

alice
OrgIdstringNo

The ID of the organization to which the end user belongs.

org-d0fua2oyukw8j****
EndUserIdsarrayNo

The IDs of the authorized users.

stringNo

The ID of the authorized user. Only exact match is supported.

alice

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

NextTokenstring

The token that is used to start the next query.

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

The ID of the request.

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

The total number of authorized users of the cloud computer share.

1
OnlineUsersCountinteger

The total number of authorized users that are connected to cloud computers of the cloud computer share.

0
EndUsersarray<object>

The authorized users.

EndUserobject

The authorized user.

EndUserIdstring

The ID of the authorized user.

alice
EndUserEmailstring

The email address of the authorized user.

alice@example.com
DesktopNamestring

The name of the cloud computer.

testName
ConnectionStatusstring

The connection status.

Valid values:

  • 0: disconnected
  • 1: connecting
1
DesktopIdstring

The ID of the cloud computer.

ecd-gx2x1dhsmucyy****
EndUserTypestring

The user account type.

Valid values:

  • SIMPLE: convenience account
  • AD_CONNECTOR: enterprise Active Directory (AD) account
SIMPLE
EndUserPhonestring

The mobile number of the authorized user.

1381111****
EndUserNamestring

The username of the authorized user.

alice
ExternalInfoobject

The appended information.

ExternalNamestring

The external name.

nameDemo
JobNumberstring

The employee ID.

123
UserSetPropertiesModelsarray<object>

Details about the seats of users.

userSetPropertiesModelsobject

The seat of the end user.

UserIdlong

The user ID.

123
UserNamestring

The username.

nameDemo
PropertyIdlong

The property ID.

123
PropertyKeystring

The property name.

key
PropertyTypeinteger

The property type.

Valid values:

  • 1: system property
  • 2: custom property
1
PropertyValuesarray<object>

Details about property values.

propertyValuesobject

The property values.

PropertyValueIdlong

The ID of the property value.

123
PropertyValuestring

The property value.

value
UserDesktopIdstring

The ID of the cloud computer that is used by the user.

ud-i896ze8hazpvl****
EndUserRemarkstring

The remarks.

Note
DisplayNamestring

The display name of the enterprise AD account.

alice

Examples

Sample success responses

JSONformat

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "UsersCount": 1,
  "OnlineUsersCount": 0,
  "UserOuPath": "",
  "EndUsers": [
    {
      "EndUserId": "alice",
      "EndUserEmail": "alice@example.com",
      "DesktopName": "testName",
      "ConnectionStatus": 1,
      "DesktopId": "ecd-gx2x1dhsmucyy****",
      "EndUserType": "SIMPLE",
      "EndUserPhone": "1381111****",
      "EndUserName": "alice",
      "ExternalInfo": {
        "ExternalName": "nameDemo",
        "JobNumber": 123
      },
      "UserSetPropertiesModels": [
        {
          "UserId": 123,
          "UserName": "nameDemo",
          "PropertyId": 123,
          "PropertyKey": "key",
          "PropertyType": 1,
          "PropertyValues": [
            {
              "PropertyValueId": 123,
              "PropertyValue": "value"
            }
          ]
        }
      ],
      "UserDesktopId": "ud-i896ze8hazpvl****",
      "EndUserRemark": "Note",
      "DisplayName": "alice",
      "UserPrincipalName": "",
      "DisplayNameNew": ""
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2025-04-09The response structure of the API has changedView Change Details
2025-03-24The response structure of the API has changedView Change Details
2022-04-13The request parameters of the API has changedView Change Details