This operation queries the details of all authorized users in a computer pool, including their usernames, email addresses, phone numbers, and the IDs of their authorized cloud desktops.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID. Call DescribeRegions to get a list of regions where WUYING Workspace is available. |
cn-hangzhou |
| DesktopGroupId |
string |
Yes |
The shared cloud computer ID. |
dg-8ttn55ujj8nj8**** |
| MaxResults |
integer |
No |
The number of entries per page.
|
10 |
| NextToken |
string |
No |
The token to start the next query. An empty value indicates that all results have been returned. |
caeba0bbb2be03f84eb48b699f0a4883 |
| EndUserId |
string |
No |
The ID of the authorized user. |
alice |
| ConnectState |
integer |
No |
The connection status of the user. Valid values:
|
1 |
| QueryUserDetail |
boolean |
No |
Specifies whether to query user details. Valid values:
|
true |
| Filter |
string |
No |
The string for a partial match query. Results that contain this string are returned. |
alice |
| OrgId |
string |
No |
The ID of the organization to which the user belongs. |
org-d0fua2oyukw8j**** |
| EndUserIds |
array |
No |
A list of authorized user IDs. |
|
|
string |
No |
The ID of the authorized user. Only exact matches are supported. |
alice |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The collection of returned information. |
||
| NextToken |
string |
The token to start the next query. |
caeba0bbb2be03f84eb48b699f0a4883 |
| RequestId |
string |
The request ID. |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
| UsersCount |
integer |
The total number of authorized users in the computer pool who meet the query conditions. |
1 |
| OnlineUsersCount |
integer |
The total number of authorized users in the computer pool who meet the query conditions and are connected to a cloud desktop. |
0 |
| UserOuPath |
string |
||
| UserGroupName |
string |
||
| EndUsers |
array<object> |
A list of authorized user information. |
|
|
array<object> |
The information of an authorized user. |
||
| EndUserId |
string |
The ID of the authorized user. |
alice |
| EndUserEmail |
string |
The email address of the authorized user. |
alice@example.com |
| DesktopName |
string |
The name of the cloud desktop. |
testName |
| ConnectionStatus |
string |
The connection status. Valid values:
|
1 |
| DesktopId |
string |
The ID of the cloud desktop. |
ecd-gx2x1dhsmucyy**** |
| EndUserType |
string |
The user account type. Valid values:
|
SIMPLE |
| EndUserPhone |
string |
The phone number of the authorized user. |
1381111**** |
| EndUserName |
string |
The username of the authorized user. |
alice |
| ExternalInfo |
object |
Additional information. |
|
| ExternalName |
string |
The external name. |
nameDemo |
| JobNumber |
string |
The employee ID. |
123 |
| UserSetPropertiesModels |
array<object> |
A list of user seat information. |
|
|
array<object> |
The user seat information. |
||
| UserId |
integer |
The user ID. |
123 |
| UserName |
string |
The username. |
nameDemo |
| PropertyId |
integer |
The property ID. |
123 |
| PropertyKey |
string |
The property name. |
key |
| PropertyType |
integer |
The property type. Valid values:
|
1 |
| PropertyValues |
array<object> |
An array of property values. |
|
|
object |
A property value object. |
||
| PropertyValueId |
integer |
The property value ID. |
123 |
| PropertyValue |
string |
The property value. |
value |
| UserDesktopId |
string |
The ID of the virtual cloud desktop assigned to the user. |
ud-i896ze8hazpvl**** |
| EndUserRemark |
string |
The user remarks. |
Note |
| DisplayName |
string |
The display name of the enterprise AD account. |
alice |
| UserPrincipalName |
string |
||
| DisplayNameNew |
string |
Examples
Success response
JSON format
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"UsersCount": 1,
"OnlineUsersCount": 0,
"UserOuPath": "",
"UserGroupName": "",
"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
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.