Queries the information about authorized users of a cloud computer share, including the usernames, email addresses, mobile numbers, and cloud computer IDs.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecd:DescribeUsersInGroup | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| DesktopGroupId | string | Yes | The ID of the cloud computer share. | dg-8ttn55ujj8nj8**** |
| MaxResults | integer | No | The number of entries to return on each page.
| 10 |
| NextToken | string | No | The token that determines the start point of the next query. If this parameter is left empty, all results are returned. | caeba0bbb2be03f84eb48b699f0a4883 |
| EndUserId | string | No | The ID of the authorized user. | alice |
| ConnectState | integer | No | The status of the desktop connection for the end user. Valid values:
| 1 |
| QueryUserDetail | boolean | No | Specifies whether to query user details. Valid values:
| false |
| Filter | string | No | The query string for fuzzy match. If you specify this parameter, the system returns all results that contain the string. | alice |
| OrgId | string | No | The ID of the organization to which the end user belongs. | org-d0fua2oyukw8j**** |
| EndUserIds | array | No | The IDs of the authorized users. | |
| string | No | The ID of the authorized user. Only exact match is supported. | alice |
Response parameters
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 time | Summary of changes | Operation |
|---|---|---|
| 2025-04-09 | The response structure of the API has changed | View Change Details |
| 2025-03-24 | The response structure of the API has changed | View Change Details |
| 2022-04-13 | The request parameters of the API has changed | View Change Details |
