Queries the details of cloud computers.
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:DescribeDesktops | 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 regions supported by Elastic Desktop Service (EDS). | cn-hangzhou |
| GroupId | string | No | The ID of the cloud computer pool. | dg-boyczi8enfyc5**** |
| DesktopStatus | string | No | The cloud computer status. Valid values:
| 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 cloud computer name. | testDesktopName |
| DirectoryId | string | No | The directory ID, which is the same as the office network ID. | cn-hangzhou+dir-363353**** |
| OfficeSiteId | string | No | The office network ID. | cn-hangzhou+dir-363353**** |
| OfficeSiteName | string | No | The office network name. | testName |
| PolicyGroupId | string | No | The ID of the cloud computer policy. | system-all-enabled-policy |
| ChargeType | string | No | The billing method of the cloud computer. Valid values:
| PostPaid |
| ExpiredTime | string | No | The time when a subscription cloud computer expires. | 2022-12-31T15:59:59Z |
| ProtocolType | string | No | The protocol. Valid values:
| ASP |
| DesktopId | array | No | The cloud computer IDs. You can specify the IDs of 1 to 100 cloud computers. | |
| string | No | The cloud computer ID. | ecd-gx2x1dhsmucyy**** | |
| EndUserId | array | No | The authorized users of the cloud computer. You can specify the IDs of 1 to 100 users. Note
During a specific period of time, only one user can connect to and use the cloud computer.
| |
| string | No | The authorized user of the cloud computer. | alice | |
| ExcludedEndUserId | array | No | The list of authorized users that you want to exclude from the cloud computer. You can specify the IDs of 1 to 100 users. | |
| string | No | The authorized user that you want to exclude from the cloud computer. | andy | |
| FilterDesktopGroup | boolean | No | Specifies whether to exclude pooled cloud computers. Valid values:
| false |
| ManagementFlag | string | No | The flag that is used to manage the cloud desktops. | NoFlag |
| QueryFotaUpdate | boolean | No | Specifies whether to query the image update information about the cloud computer. Valid values:
| false |
| Tag | array<object> | No | The tags that you want to add to the cloud computer. 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 computers by group. This facilitates search and batch operations. For more information, see Use tags to manage cloud computers. | |
| object | No | The key-value pair of the tag. You can specify 1 to 20 key-value pairs. One tag key corresponds to only one tag value. | ||
| Key | string | No | The tag key. If you specify the | TestKey |
| Value | string | No | The tag value. 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 | Specifies whether to query pooled cloud computers. | true |
| DesktopGroupId | string | No | The ID of the cloud computer pool. If you specify | dg-2i8qxpv6t1a03**** |
| OsTypes | array | No | The operating systems (OSs). | |
| string | No | The OS. Valid values:
| Windows | |
| DesktopType | string | No | The cloud computer type. You can call the DescribeDesktopTypes operation to query the IDs of all supported 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 cloud computer status. | |
| string | No | The cloud computer status. Valid values:
| Stopped | |
| GpuInstanceGroupId | string | No | The ID of the elastic GPU pool. | gp-0bm2iz1v6m6nx**** |
| QosRuleId | string | No | The ID of the network throttling rule. | qos-5605u0gelk200**** |
| SubPayType | string | No | The billing method of the cloud computer. Valid values:
| monthPackage |
| ResourceGroupId | string | No | The ID of the enterprise resource group. | rg-4hsvzbbmqdzu3s**** |
| FillResourceGroup | boolean | No | Specifies whether to query the information about the enterprise resource group. | true |
| PageNumber | integer | No | The page number. | 1 |
| PageSize | integer | No | The number of entries returned per page. | 10 |
| MultiResource | boolean | No | Specifies whether the shared group is a multi-cloud computer type. Valid values:
| false |
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",
"DiskCategory": "cloud_auto"
}
],
"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,
"DesktopDurationList": [
{
"PackageId": "",
"PackageCreationTime": "",
"PackageExpiredTime": "",
"UsedDuration": 0,
"TotalDuration": 0,
"PackageStatus": "",
"PackageType": "",
"PeriodStartTime": "",
"PeriodEndTime": "",
"PostPaidLimitFee": 0,
"PackageUsedUpStrategy": "",
"OrderInstanceId": ""
}
],
"ResourceGroups": [
{
"Name": "Resource group 01\n",
"Id": "rg-4hsvzbbmqdzu3s****"
}
],
"StandardStartTime": "2025-02-24T06:38:02Z",
"OsUpdate": {
"CheckId": "",
"PackageCount": 0,
"Packages": [
{
"Kb": "",
"Title": "",
"Description": ""
}
]
},
"IsLdap": true
}
],
"PageNumber": 1,
"PageSize": 10
}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-18 | The response structure of the API has changed | View Change Details |
| 2025-02-17 | The response structure of the API has changed | View Change Details |
| 2025-01-24 | The request parameters of the API has changed | View Change Details |
| 2024-10-29 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2024-07-04 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2024-06-17 | The request parameters of the API has changed | View Change Details |
| 2023-09-22 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2023-09-11 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2023-07-19 | The response structure of the API has changed | View Change Details |
| 2023-07-03 | The response structure of the API has changed | View Change Details |
| 2023-05-18 | The response structure of the API has changed | View Change Details |
| 2023-05-06 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2023-03-17 | The request parameters of the API has changed | View Change Details |
| 2022-08-04 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2022-08-04 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2022-08-04 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2022-08-04 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2022-08-04 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2022-08-04 | The internal configuration of the API is changed, but the call is not affected | View Change Details |