Query the details of the cloud desktop.
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:
- The required resource types are displayed in bold characters.
- 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:DescribeDesktops | LIST |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The ID of the region. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| GroupId | string | No | The ID of the desktop group. Note
The desktop group feature is in invitational preview. If you want to use this feature, submit a ticket.
| dg-boyczi8enfyc5**** |
| DesktopStatus | string | No | The status of the cloud desktop. | Running |
| MaxResults | integer | No | The number of entries per 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 |
| UserName | string | No | The name of the end user. | Alice |
| DesktopName | string | No | The name of the cloud desktop. | testDesktopName |
| DirectoryId | string | No | The ID of the directory, The ID is the same as the workspace ID. | cn-hangzhou+dir-363353**** |
| OfficeSiteId | string | No | The ID of the workspace. | cn-hangzhou+dir-363353**** |
| OfficeSiteName | string | No | The name of the workspace. | testName |
| PolicyGroupId | string | No | The ID of the policy. | system-all-enabled-policy |
| ChargeType | string | No | The billing method of the cloud desktop. | PostPaid |
| ExpiredTime | string | No | The time when the subscription cloud desktop expires. | 2022-12-31T15:59:59Z |
| ProtocolType | string | No | The type of the protocol. | ASP |
| DesktopId | array | No | The IDs of the cloud desktops. You can specify 1 to 100 cloud desktop IDs. | |
| string | No | The ID of the cloud desktop. | ecd-gx2x1dhsmucyy**** | |
| EndUserId | array | No | The IDs of the end users that are assigned the cloud desktop. You can specify 1 to 100 end user IDs. Note
Only one end user can use the cloud desktop at a time.
| |
| string | No | The name of the end user that is assigned the cloud desktop. Note
Only one end user can use the cloud desktop at a time.
| alice | |
| ExcludedEndUserId | array | No | The IDs of the end users that are excluded from the end users that are assigned the cloud desktop. You can specify 1 to 100 end user IDs. | |
| string | No | The ID of the end user that is excluded from the end users that are assigned the cloud desktop. | andy | |
| FilterDesktopGroup | boolean | No | Specifies whether to filter cloud desktops in the desktop group. | false |
| ManagementFlag | string | No | The flag that is used to manage the cloud desktops. | NoFlag |
| QueryFotaUpdate | boolean | No | Specifies whether to query the information about image update of the cloud desktop. | false |
| Tag | object [] | No | The tags. A tag is a key-value pair that consists of a tag key and a tag value. Tags are used to identify resources. You can use tags to manage cloud desktops by group for easy searching and batch operations. For more information, see Use tags to manage cloud desktops. | |
| Key | string | No | The key of the tag. If you specify the | TestKey |
| Value | string | No | The value of the tag. The tag value can be up to 128 characters in length and cannot contain | TestValue |
| SnapshotPolicyId | string | No | The ID of the snapshot policy. | sp-hb12mclyne09xw*** |
| OnlyDesktopGroup | boolean | No | The progress when the cloud desktop was created. | true |
| DesktopGroupId | string | No | The ID of the desktop group. If you specify the | dg-2i8qxpv6t1a03**** |
| OsTypes | array | No | The types of the OSs. | |
| string | No | The type of the OS. Enumeration Value:
| Windows | |
| DesktopType | string | No | The new desktop type. You can call the DescribeDesktopTypes operation to query the IDs of supported desktop types. | eds.general.2c8g |
| ImageId | array | No | The IDs of the images. | |
| string | No | The ID of the image. | m-2g65ljy3ynrdq**** | |
| DesktopStatusList | array | No | The list of desktop status. | |
| string | No | The status of the cloud desktop. Valid values:
| Stopped |
Response parameters
Examples
Sample success responses
JSONformat
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"RequestId": "484256DA-D816-44D2-9D86-B6EE4D5BA78C",
"TotalCount": 1,
"Desktops": [
{
"CreationTime": "2020-11-06T08:28Z",
"ChargeType": "PostPaid",
"DesktopName": "testDesktopName",
"PolicyGroupName": "test",
"SystemDiskSize": 0,
"PolicyGroupId": "system-all-enabled-policy",
"DesktopStatus": "Running",
"DesktopType": "ecd.basic.large",
"GpuCount": 1,
"ProtocolType": "ASP",
"Memory": 4096,
"GpuSpec": "NVIDIA T4",
"ImageId": "m-4zfb6zj728hhr****",
"DirectoryId": "cn-hangzhou+dir-363353****",
"ManagementFlag": "NoFlag",
"DataDiskCategory": "null",
"SystemDiskCategory": "null",
"NetworkInterfaceId": "123456",
"OfficeSiteId": "cn-hangzhou+dir-363353****",
"DataDiskSize": "null",
"DesktopGroupId": "null",
"DesktopId": "ecd-gx2x1dhsmucyy****",
"OfficeSiteName": "test",
"StartTime": "2020-11-06T08:31Z",
"DirectoryType": "SIMPLE",
"Cpu": 2,
"NetworkInterfaceIp": "192.168.74.165",
"ExpiredTime": "2021-12-31T15:59Z",
"OsType": "Windows",
"ConnectionStatus": "Disconnected",
"BundleId": "b-2g65ljy4291vl****",
"BundleName": "Name",
"OfficeSiteType": "SIMPLE",
"HostName": "testName",
"Disks": [
{
"DiskType": "SYSTEM",
"DiskId": "d-jedbpr4sl9l37****",
"DiskSize": 80,
"PerformanceLevel": "PL0"
}
],
"Tags": [
{
"Key": "TestKey",
"Value": "TestValue"
}
],
"Sessions": [
{
"EndUserId": "29615820929547****",
"EstablishmentTime": "2021-03-07T08:23Z",
"ExternalUserName": "Testname"
}
],
"EndUserIds": [
"Alice"
],
"DowngradeQuota": 3,
"DowngradedTimes": 0,
"GpuCategory": 0,
"GpuDriverVersion": "null",
"ZoneType": "AvailabilityZone",
"FotaUpdate": {
"CurrentAppVersion": "0.0.0-D-20220102.000000",
"NewAppVersion": "0.0.0-R-20220307.190736",
"ReleaseNote": "Upgrade package for testing 03-07\n",
"Size": 108815097,
"ReleaseNoteEn": "Release note",
"ReleaseNoteJp": "リリースノート"
},
"Progress": "100%",
"VolumeEncryptionEnabled": false,
"VolumeEncryptionKey": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
"OfficeSiteVpcType": "basic",
"Platform": "Ubuntu",
"SessionType": "SINGLE_SESSION",
"ManagementFlags": [
"[\"NoFlag\"]"
],
"SnapshotPolicyId": "sp-gi007jgyc3kcey2bb",
"SnapshotPolicyName": "testSnapshotName",
"BindAmount": 10,
"PolicyGroupIdList": [
"pg-dasffjkdf*****"
],
"PolicyGroupNameList": [
"test01"
],
"HibernationOptionsConfigured": true,
"SupportHibernation": true,
"HibernationBeta": true
}
]
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||
|---|---|---|---|---|---|---|---|---|
| 2023-09-22 | The internal configuration of the API is changed, but the call is not affected | see changesets | ||||||
| ||||||||
| 2023-09-11 | The internal configuration of the API is changed, but the call is not affected | see changesets | ||||||
| ||||||||
| 2023-07-19 | The response structure of the API has changed | see changesets | ||||||
| ||||||||
| 2023-07-03 | The response structure of the API has changed | see changesets | ||||||
| ||||||||
| 2023-05-18 | The response structure of the API has changed | see changesets | ||||||
| ||||||||
| 2023-05-06 | The request parameters of the API has changed. The response structure of the API has changed | see changesets | ||||||
| ||||||||
| 2023-03-17 | The request parameters of the API has changed | see changesets | ||||||
| ||||||||
| 2022-08-04 | The internal configuration of the API is changed, but the call is not affected | see changesets | ||||||
| ||||||||
| 2022-08-04 | The internal configuration of the API is changed, but the call is not affected | see changesets | ||||||
| ||||||||
| 2022-08-04 | The internal configuration of the API is changed, but the call is not affected | see changesets | ||||||
| ||||||||
| 2022-08-04 | The internal configuration of the API is changed, but the call is not affected | see changesets | ||||||
| ||||||||
| 2022-08-04 | The internal configuration of the API is changed, but the call is not affected | see changesets | ||||||
| ||||||||
| 2022-08-04 | The internal configuration of the API is changed, but the call is not affected | see changesets | ||||||
| ||||||||
| 2022-07-07 | The request parameters of the API has changed | see changesets | ||||||
| ||||||||
| 2022-01-20 | The response structure of the API has changed | see changesets | ||||||
| ||||||||
| 2022-01-20 | The response structure of the API has changed | see changesets | ||||||
| ||||||||
| 2021-12-22 | The response structure of the API has changed | see changesets | ||||||
| ||||||||
| 2021-09-26 | The request parameters of the API has changed | see changesets | ||||||
|