Queries the information about one or more cloud desktops.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDesktops

The operation that you want to perform. Set the value to DescribeDesktops.

ClientId String Yes f4a0dc8e-1702-4728-9a60-95b27a35****

The ID of the client.

LoginToken String Yes v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****

The logon credential.

RegionId String Yes cn-hangzhou

The ID of the region.

SessionId String Yes cd45e873-650d-4d70-acb9-f996187a****

The ID of the session.

OfficeSiteId String No cn-hangzhou+dir-885351****

The ID of the workspace.

GroupId String No system-all-enabled-policy

The ID of the policy.

DesktopStatus String No Running

The status of the cloud desktop. Valid values:

  • Pending
  • Starting
  • Running
  • Stopping
  • Stopped
  • Expired
  • Deleted
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 specifies the start point of the next query. If no additional results exist, this parameter is empty.

UserName String No alice

The username of the user.

DesktopName String No testName

The name of the cloud desktop.

Html5Access String No OFF

Specifies whether to use a browser as a web client . Valid values:

  • ON: uses a web client.
  • OFF: does not use a web client.
ProtocolType String No HDX

The type of the protocol. Valid values:

  • HDX
  • ASP
DesktopId.N RepeatList No ecd-gx2x1dhsmucyy****

The ID of cloud desktop N. You can specify one or more IDs of cloud desktops. Valid values of N: 1 to 100.

Response parameters

Parameter Type Example Description
Desktops Array of Desktop

The details about the cloud desktops.

ChargeType String PostPaid

The billing method of the cloud desktop. The valid values include:

  • PostPaid: pay-as-you-go
  • PrePaid: subscription
ConnectionStatus String Disconnected

The connection status of the user. The valid values include:

  • Connected
  • Disconnected
  • Unknown
Cpu Integer 2

The number of CPUs that are used for the cloud desktop.

CreationTime String 2020-11-06T08:28Z

The point in time when the cloud desktop was created.

DataDiskCategory String null

This parameter is unavailable.

DataDiskSize String null

This parameter is unavailable.

DesktopGroupId String dg-3uiojcc0j4kh7****

The ID of the cloud 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.

DesktopName String testDesktopName

The name of the cloud desktop.

DesktopStatus String Running

The status of the cloud desktop. The valid values include:

  • Pending
  • Starting
  • Running
  • Stopping
  • Stopped
  • Expired
  • Deleted
DesktopType String eds.general.2c8g

The specifications of the cloud desktop.

DirectoryId String cn-hangzhou+dir-jedbpr4sl9l37****

The ID of the directory.

Disks Array of Disk

The details about the disks.

DiskId String d-jedbpr4sl9l37****

The ID of the disk.

DiskSize Integer 80

The size of the disk. Unit: GiB.

DiskType String SYSTEM

The type of the disk. The valid values include:

  • SYSTEM: system disk
  • DATA: data disk
EndUserIds List 123456789

The IDs of users that were authorized to log on to the cloud desktop.

ExpiredTime String 2099-12-31T15:59Z

The point in time when the cloud desktop expires.

  • For a subscription cloud desktop, the return value varies.
  • For a pay-as-you-go cloud desktop, the return value is fixed as 2099-12-31T15:59Z.
ImageId String m-4zfb6zj728hhr****

The ID of the image.

LastStartTime String 2021-07-13T15:59Z

The last time that the cloud desktop was started.

Memory Long 4096

The memory of the cloud desktop. Unit: MiB.

NetworkInterfaceId String eni-uf6iey64p5h9j5uqcowy

The ID of the elastic network interface (ENI).

OfficeSiteId String cn-hangzhou+dir-990541****

The ID of the workspace.

OsType String Windows

The type of the OS. The valid values include:

  • Windows
  • Linux
PolicyGroupId String pg-cg27ufmapx1u40bl4

The ID of the policy that is associated with the cloud desktop.

ProtocolType String HDX

The type of the protocol. The valid values include:

  • HDX
  • ASP
Sessions Array of Session

The information about the sessions.

EndUserId String alice

The username of the user.

EstablishmentTime String 2021-08-25T04:28Z

The point in time when the session was created.

SystemDiskCategory String null

This parameter is unavailable.

SystemDiskSize Integer 1

This parameter is unavailable.

NextToken String caeba0bbb2be03f84eb48b699f0a4883

The token that specifies the start point of the next query. If no additional results exist, this parameter is empty.

RequestId String 484256DA-D816-44D2-9D86-B6EE4D5BA78C

The ID of the request.

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

<DescribeDesktopsResponse>
      <RequestId>484256DA-D816-44D2-9D86-B6EE4D5BA78C</RequestId>
      <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
      <Desktops>
            <SystemDiskSize>1</SystemDiskSize>
            <Memory>4096</Memory>
            <PolicyGroupId>pg-cg27ufmapx1u40bl4</PolicyGroupId>
            <DesktopName>testDesktopName</DesktopName>
            <Cpu>2</Cpu>
            <DesktopId>ecd-gx2x1dhsmucyy****</DesktopId>
            <NetworkInterfaceId>eni-uf6iey64p5h9j5uqcowy</NetworkInterfaceId>
            <DesktopStatus>Running</DesktopStatus>
            <SystemDiskCategory>null</SystemDiskCategory>
            <OfficeSiteId>cn-hangzhou+dir-990541****</OfficeSiteId>
            <DesktopGroupId>dg-3uiojcc0j4kh7****</DesktopGroupId>
            <DirectoryId>cn-hangzhou+dir-jedbpr4sl9l37****    </DirectoryId>
            <DesktopType>eds.general.2c8g</DesktopType>
            <OsType>Windows</OsType>
            <ProtocolType>HDX</ProtocolType>
            <ChargeType>PostPaid</ChargeType>
            <ExpiredTime>2099-12-31T15:59Z</ExpiredTime>
            <ImageId>m-4zfb6zj728hhr****</ImageId>
            <CreationTime>2020-11-06T08:28Z</CreationTime>
            <LastStartTime>2021-07-13T15:59Z</LastStartTime>
            <DataDiskSize>null</DataDiskSize>
            <ConnectionStatus>Disconnected</ConnectionStatus>
            <DataDiskCategory>null</DataDiskCategory>
            <Disks>
                  <DiskType>SYSTEM</DiskType>
                  <DiskSize>80</DiskSize>
                  <DiskId>d-jedbpr4sl9l37****</DiskId>
            </Disks>
            <Sessions>
                  <EndUserId>alice</EndUserId>
                  <EstablishmentTime>2021-08-25T04:28Z</EstablishmentTime>
            </Sessions>
            <EndUserIds>123456789</EndUserIds>
      </Desktops>
</DescribeDesktopsResponse>

JSON format

{
    "RequestId": "484256DA-D816-44D2-9D86-B6EE4D5BA78C",
    "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
    "Desktops": [
        {
            "SystemDiskSize": "1",
            "Memory": "4096",
            "PolicyGroupId": "pg-cg27ufmapx1u40bl4",
            "DesktopName": "testDesktopName",
            "Cpu": "2",
            "DesktopId": "ecd-gx2x1dhsmucyy****",
            "NetworkInterfaceId": "eni-uf6iey64p5h9j5uqcowy",
            "DesktopStatus": "Running",
            "SystemDiskCategory": "null",
            "OfficeSiteId": "cn-hangzhou+dir-990541****",
            "DesktopGroupId": "dg-3uiojcc0j4kh7****",
            "DirectoryId": "cn-hangzhou+dir-jedbpr4sl9l37****\t",
            "DesktopType": "eds.general.2c8g",
            "OsType": "Windows",
            "ProtocolType": "HDX",
            "ChargeType": "PostPaid",
            "ExpiredTime": "2099-12-31T15:59Z",
            "ImageId": "m-4zfb6zj728hhr****",
            "CreationTime": "2020-11-06T08:28Z",
            "LastStartTime": "2021-07-13T15:59Z",
            "DataDiskSize": "null",
            "ConnectionStatus": "Disconnected",
            "DataDiskCategory": "null",
            "Disks": [
                {
                    "DiskType": "SYSTEM",
                    "DiskSize": "80",
                    "DiskId": "d-jedbpr4sl9l37****"
                }
            ],
            "Sessions": [
                {
                    "EndUserId": "alice",
                    "EstablishmentTime": "2021-08-25T04:28Z"
                }
            ],
            "EndUserIds": "123456789"
        }
    ]
}