Queries the information about one or more cloud desktops in Elastic Desktop Service (EDS).
Request parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| Action | String | Yes | DescribeDesktops |
The operation that you want to perform. Set the value to DescribeDesktops. |
| RegionId | String | Yes | cn-hangzhou |
The ID of the region. |
| DirectoryId | String | No | cn-hangzhou+dir-jedbpr4sl9l37**** |
The ID of the directory, which is the same as the workspace ID. |
| OfficeSiteId | String | No | cn-hangzhou+dir-885351**** |
The ID of the workspace. |
| ClientId | String | Yes | f4a0dc8e-1702-4728-9a60-95b27a35**** |
The ID of the client. The system generates a unique ID for each client. |
| SessionId | String | Yes | cd45e873-650d-4d70-acb9-f996187a**** |
The ID of the session. |
| LoginToken | String | Yes | v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b**** |
The logon token. |
| GroupId | String | No | system-all-enabled-policy |
The ID of the policy. |
| DesktopStatus | String | No | Running |
The status of the cloud desktop. Valid values:
|
| MaxResults | Integer | No | 10 |
The number of entries to return on each page. Maximum value: 100. Default value: 10. |
| NextToken | String | No | caeba0bbb2be03f84eb48b699f0a4883 |
The token that is used for the next query. If you leave this parameter empty, all results are returned. |
| UserName | String | No | alice |
The name of the regular user. |
| DesktopName | String | No | testName |
The name of the cloud desktop. |
| Html5Access | String | No | OFF |
Specifies whether to use a web client. Valid values:
|
| ProtocolType | String | No | HDX |
The protocol type.
|
| ClientType | String | No | windows client |
The client type. Valid values:
|
| QueryFotaUpdate | Boolean | No | true |
Specifies whether to query the information about image update. |
| DesktopId.N | String | No | 1 |
The ID of cloud desktop N. You can specify the IDs of one or more cloud desktops. Valid values of N: 1 to 100. |
Response parameters
| Parameter | Type | Example | Description |
|---|---|---|---|
| NextToken | String | caeba0bbb2be03f84eb48b699f0a4883 |
The token that is used for the next query. If this parameter is empty, all results have been returned. |
| RequestId | String | 484256DA-D816-44D2-9D86-B6EE4D5BA78C |
The ID of the request. |
| Desktops | Array of Desktop |
Details about the cloud desktops. |
|
| CreationTime | String | 2020-11-06T08:28Z |
The time when the cloud desktop was created. |
| DataDiskCategory | String | null |
This parameter is unavailable. |
| SystemDiskCategory | String | null |
This parameter is unavailable. |
| ChargeType | String | PostPaid |
The billing method of the cloud desktop. Valid values:
|
| NetworkInterfaceId | String | eni-uf6iey64p5h9j5uqcowy |
The ID of the elastic network interface (ENI). |
| OfficeSiteId | String | cn-hangzhou+dir-990541**** |
The ID of the workspace. |
| DesktopName | String | testDesktopName |
The name of the cloud desktop. |
| DataDiskSize | String | null |
This parameter is unavailable. |
| DesktopGroupId | String | dg-3uiojcc0j4kh7**** |
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.
|
| DesktopId | String | ecd-gx2x1dhsmucyy**** |
The ID of the cloud desktop. |
| SystemDiskSize | Integer | 1 |
This parameter is unavailable. |
| Cpu | Integer | 2 |
The number of vCPUs that are used for the cloud desktop. |
| PolicyGroupId | String | pg-cg27ufmapx1u40bl4 |
The ID of the policy that is associated with the cloud desktop. |
| ExpiredTime | String | 2099-12-31T15:59Z |
The time when the cloud desktop expires.
|
| DesktopStatus | String | Running |
The status of the cloud desktop. Valid values:
|
| OsType | String | Windows |
The OS type. Valid values:
|
| LastStartTime | String | 2021-07-13T15:59Z |
The time when the cloud desktop was last started. |
| DesktopType | String | eds.general.2c8g |
The type of the cloud desktop. |
| ConnectionStatus | String | Disconnected |
The connection status of the regular user. Valid values:
|
| Memory | Long | 4096 |
The memory size of the cloud desktop. Unit: MiB. |
| ProtocolType | String | HDX |
The protocol type.
|
| ImageId | String | m-4zfb6zj728hhr**** |
The ID of the image. |
| DirectoryId | String | cn-hangzhou+dir-jedbpr4sl9l37**** |
The ID of the directory. |
| Disks | Array of Disk |
Details about the disks. |
|
| DiskType | String | SYSTEM |
The disk type. Valid values:
|
| DiskId | String | d-jedbpr4sl9l37**** |
The ID of the disk. |
| DiskSize | Integer | 80 |
The size of the disk. Unit: GiB. |
| Sessions | Array of Session |
Details about the sessions. |
|
| EndUserId | String | alice |
The name of the regular user. |
| EstablishmentTime | String | 2021-08-25T04:28Z |
The time when the session was created. |
| EndUserIds | Array of String | 123456789 |
The IDs of regular users that are authorized to log on to the cloud desktop. |
| GpuMemory | Integer | 1 |
The size of the GPU memory. For a GPU-accelerated cloud desktop, the return value varies. Unit: MB. |
| RealDesktopId | String | ecd-gx2x1dhsmucyy |
The actual ID of the cloud desktop. This parameter takes effect for cloud desktops in desktop groups, and the return value of actual desktop ID varies. |
| FotaUpdate | Object |
The information about image update. |
|
| CurrentAppVersion | String | 0.0.0-D-20220102.000000 |
The current version of the cloud desktop. |
| NewAppVersion | String | 0.0.0-R-20220307.190736 |
The version to which the cloud desktop can be updated. |
| ReleaseNote | String | Package for update test 03-07 |
The description of the version to which the cloud desktop can be updated. |
| Size | Long | 108815097 |
The size of a new version of the installation package. The cloud desktop can be updated to this version. |
Examples
Sample requests
https://ecd.cn-hangzhou.aliyuncs.com/?Action=DescribeDesktops
&ClientId=f4a0dc8e-1702-4728-9a60-95b27a35****
&LoginToken=v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
&RegionId=cn-hangzhou
&SessionId=cd45e873-650d-4d70-acb9-f996187a****
&<Common request parameters>Sample success responses
XML format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDesktopsResponse>
<NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
<RequestId>484256DA-D816-44D2-9D86-B6EE4D5BA78C</RequestId>
<Desktops>
<CreationTime>2020-11-06T08:28Z</CreationTime>
<DataDiskCategory>null</DataDiskCategory>
<SystemDiskCategory>null</SystemDiskCategory>
<ChargeType>PostPaid</ChargeType>
<NetworkInterfaceId>eni-uf6iey64p5h9j5uqcowy</NetworkInterfaceId>
<OfficeSiteId>cn-hangzhou+dir-990541****</OfficeSiteId>
<DesktopName>testDesktopName</DesktopName>
<DataDiskSize>null</DataDiskSize>
<DesktopGroupId>dg-3uiojcc0j4kh7****</DesktopGroupId>
<DesktopId>ecd-gx2x1dhsmucyy****</DesktopId>
<SystemDiskSize>1</SystemDiskSize>
<Cpu>2</Cpu>
<PolicyGroupId>pg-cg27ufmapx1u40bl4</PolicyGroupId>
<ExpiredTime>2099-12-31T15:59Z</ExpiredTime>
<DesktopStatus>Running</DesktopStatus>
<OsType>Windows</OsType>
<LastStartTime>2021-07-13T15:59Z</LastStartTime>
<DesktopType>eds.general.2c8g</DesktopType>
<ConnectionStatus>Disconnected</ConnectionStatus>
<Memory>4096</Memory>
<ProtocolType>HDX</ProtocolType>
<ImageId>m-4zfb6zj728hhr****</ImageId>
<DirectoryId>cn-hangzhou+dir-jedbpr4sl9l37**** </DirectoryId>
<Disks>
<DiskType>SYSTEM</DiskType>
<DiskId>d-jedbpr4sl9l37****</DiskId>
<DiskSize>80</DiskSize>
</Disks>
<Sessions>
<EndUserId>alice</EndUserId>
<EstablishmentTime>2021-08-25T04:28Z</EstablishmentTime>
</Sessions>
<EndUserIds>123456789</EndUserIds>
<GpuMemory>1</GpuMemory>
<RealDesktopId>ecd-gx2x1dhsmucyy</RealDesktopId>
<FotaUpdate>
<CurrentAppVersion>0.0.0-D-20220102.000000</CurrentAppVersion>
<NewAppVersion>0.0.0-R-20220307.190736</NewAppVersion>
<ReleaseNote>Package for update test 03-07</ReleaseNote>
<Size>108815097</Size>
</FotaUpdate>
</Desktops>
</DescribeDesktopsResponse>JSON format
HTTP/1.1 200 OK
Content-Type:application/json
{
"NextToken" : "caeba0bbb2be03f84eb48b699f0a4883",
"RequestId" : "484256DA-D816-44D2-9D86-B6EE4D5BA78C",
"Desktops" : [ {
"CreationTime" : "2020-11-06T08:28Z",
"DataDiskCategory" : "null",
"SystemDiskCategory" : "null",
"ChargeType" : "PostPaid",
"NetworkInterfaceId" : "eni-uf6iey64p5h9j5uqcowy",
"OfficeSiteId" : "cn-hangzhou+dir-990541****",
"DesktopName" : "testDesktopName",
"DataDiskSize" : "null",
"DesktopGroupId" : "dg-3uiojcc0j4kh7****",
"DesktopId" : "ecd-gx2x1dhsmucyy****",
"SystemDiskSize" : 1,
"Cpu" : 2,
"PolicyGroupId" : "pg-cg27ufmapx1u40bl4",
"ExpiredTime" : "2099-12-31T15:59Z",
"DesktopStatus" : "Running",
"OsType" : "Windows",
"LastStartTime" : "2021-07-13T15:59Z",
"DesktopType" : "eds.general.2c8g",
"ConnectionStatus" : "Disconnected",
"Memory" : 4096,
"ProtocolType" : "HDX",
"ImageId" : "m-4zfb6zj728hhr****",
"DirectoryId" : "cn-hangzhou+dir-jedbpr4sl9l37****\t",
"Disks" : [ {
"DiskType" : "SYSTEM",
"DiskId" : "d-jedbpr4sl9l37****",
"DiskSize" : 80
} ],
"Sessions" : [ {
"EndUserId" : "alice",
"EstablishmentTime" : "2021-08-25T04:28Z"
} ],
"EndUserIds" : [ "123456789" ],
"GpuMemory" : 1,
"RealDesktopId" : "ecd-gx2x1dhsmucyy",
"FotaUpdate" : {
"CurrentAppVersion" : "0.0.0-D-20220102.000000",
"NewAppVersion" : "0.0.0-R-20220307.190736",
"ReleaseNote" : "Package for update test 03-07",
"Size" : 108815097
}
} ]
}