All Products
Search
Document Center

WUYING Workspace:DescribeDesktops

Last Updated:Jan 24, 2024

Query the details of the cloud desktop.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
ecd:DescribeDesktopsLIST
  • All Resources
    acs:ecd:{#regionId}:{#accountId}:*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
GroupIdstringNo

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****
DesktopStatusstringNo

The status of the cloud desktop.

Enumeration Value:
  • Stopped
  • Starting
  • Rebuilding
  • Running
  • Stopping
  • Expired
  • Deleted
  • Pending
Running
MaxResultsintegerNo

The number of entries to return on each page.

  • Maximum value: 100.
  • Default value: 10.
10
NextTokenstringNo

The token that determines the start point of the next query. If this parameter is left empty, all results are returned.

caeba0bbb2be03f84eb48b699f0a4883
UserNamestringNo

The name of the end user.

Alice
DesktopNamestringNo

The name of the cloud desktop.

testDesktopName
DirectoryIdstringNo

The ID of the directory, The ID is the same as the workspace ID.

cn-hangzhou+dir-363353****
OfficeSiteIdstringNo

The ID of the workspace.

cn-hangzhou+dir-363353****
OfficeSiteNamestringNo

The name of the workspace.

testName
PolicyGroupIdstringNo

The ID of the policy.

system-all-enabled-policy
ChargeTypestringNo

The billing method of the cloud desktop.

Enumeration Value:
  • PostPaid
  • PrePaid
PostPaid
ExpiredTimestringNo

The time when the subscription cloud desktop expires.

2022-12-31T15:59:59Z
ProtocolTypestringNo

The type of the protocol.

Enumeration Value:
  • HDX
  • ASP
ASP
DesktopIdarrayNo

The IDs of the cloud desktops. You can specify 1 to 100 cloud desktop IDs.

stringNo

The ID of the cloud desktop.

ecd-gx2x1dhsmucyy****
EndUserIdarrayNo

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.
stringNo

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
ExcludedEndUserIdarrayNo

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.

stringNo

The ID of the end user that is excluded from the end users that are assigned the cloud desktop.

andy
FilterDesktopGroupbooleanNo

Specifies whether to filter cloud desktops in the desktop group.

Enumeration Value:
  • true
  • false
false
ManagementFlagstringNo

The flag that is used to manage the cloud desktops.

Enumeration Value:
  • Migrating
  • Updating
  • NoFlag
NoFlag
QueryFotaUpdatebooleanNo

Specifies whether to query the information about image update of the cloud desktop.

Enumeration Value:
  • true
  • false
false
Tagobject []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.

KeystringNo

The key of the tag. If you specify the Tag parameter, you must also specify the Key parameter. The tag key can be up to 128 characters in length and cannot contain http:// or https://. The tag key cannot start with aliyun or acs:. You cannot specify an empty string as a tag key.

TestKey
ValuestringNo

The value of the tag. The tag value can be up to 128 characters in length and cannot contain http:// or https://. The tag value cannot start with aliyun or acs:.

TestValue
SnapshotPolicyIdstringNo

The ID of the snapshot policy.

sp-hb12mclyne09xw***
OnlyDesktopGroupbooleanNo

The progress when the cloud desktop was created.

true
DesktopGroupIdstringNo

The ID of the desktop group. If you specify the DesktopId parameter, ignore the DesktopGroupId parameter. If you do not specify the DesktopId parameter, specify the DesktopGroupId parameter in the call to request all IDs of the cloud desktops in the specified desktop group.

dg-2i8qxpv6t1a03****
OsTypesarrayNo

The types of the OSs.

stringNo

The type of the OS.

Windows
DesktopTypestringNo

The new desktop type. You can call the DescribeDesktopTypes operation to query the IDs of supported desktop types.

eds.general.2c8g
ImageIdarrayNo

The IDs of the images.

stringNo

The ID of the image.

m-2g65ljy3ynrdq****
DesktopStatusListarrayNo

The list of desktop status.

stringNo

The status of the cloud desktop. Valid values:

  • Stopped
  • Starting
  • Rebuilding
  • Running
  • Stopping
  • Expired
  • Deleted
  • Pending
Stopped

Response parameters

ParameterTypeDescriptionExample
object

The information that is returned.

NextTokenstring

The token that is used for the next query. If this parameter is left empty, all results are returned.

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

The ID of the request.

484256DA-D816-44D2-9D86-B6EE4D5BA78C
TotalCountinteger

The total number of cloud desktops.

1
Desktopsobject []

Details of the cloud desktops.

CreationTimestring

The time when the cloud desktop was created.

2020-11-06T08:28Z
ChargeTypestring

The billing method of the cloud desktop.

Enumeration Value:
  • PostPaid
  • PrePaid
PostPaid
DesktopNamestring

The name of the cloud desktop.

testDesktopName
PolicyGroupNamestring

The name of the policy.

test
SystemDiskSizeinteger
Note This parameter is in invitational preview and is unavailable.
0
PolicyGroupIdstring

The ID of the policy.

system-all-enabled-policy
DesktopStatusstring

The status of the cloud desktop.

Running
DesktopTypestring

The desktop type.

ecd.basic.large
GpuCountfloat

The number of GPUs.

1
ProtocolTypestring

The type of the protocol.

Enumeration Value:
  • HDX
  • ASP
ASP
Memorylong

The memory size. Unit: MiB.

4096
GpuSpecstring

The GPU specifications.

NVIDIA T4
ImageIdstring

The ID of the image.

m-4zfb6zj728hhr****
DirectoryIdstring

The ID of the directory. The ID is the same as the workspace ID that is indicated by the OfficeSiteId parameter.

cn-hangzhou+dir-363353****
ManagementFlagstring

The flag that is used to manage the cloud desktops.

Enumeration Value:
  • Updating
  • NoFlag
NoFlag
DataDiskCategorystring
Note This parameter is in invitational preview and is unavailable.
null
SystemDiskCategorystring
Note This parameter is in invitational preview and is unavailable.
null
NetworkInterfaceIdstring

The ID of the secondary network interface controller (NIC) created by the RAM user or Active Directory (AD) user in EDS. You do not have the permissions to modify this ID.

123456
OfficeSiteIdstring

The ID of the workspace.

cn-hangzhou+dir-363353****
DataDiskSizestring
Note This parameter is in invitational preview and is unavailable.
null
DesktopGroupIdstring

The ID of the desktop group. Default value: null.

Note This parameter is in invitational preview and is unavailable.
null
DesktopIdstring

The ID of the cloud desktop.

ecd-gx2x1dhsmucyy****
OfficeSiteNamestring

The name of the workspace.

test
StartTimestring

The first time when the cloud desktop was started.

2020-11-06T08:31Z
DirectoryTypestring

This parameter is in invitational preview and is unavailable.

SIMPLE
Cpuinteger

The number of vCPUs.

2
NetworkInterfaceIpstring

The IP address of the secondary NIC that is created by the RAM user or AD user in EDS.

192.168.74.165
ExpiredTimestring

The time when the subscription cloud desktop expired.

2021-12-31T15:59Z
OsTypestring

The type of the OS.

Windows
ConnectionStatusstring

The connection status of the end user.

Enumeration Value:
  • Unknown
  • Connected
  • Disconnected
Disconnected
BundleIdstring

The ID of the desktop template that is used to create the cloud desktop.

b-2g65ljy4291vl****
BundleNamestring

The name of the desktop template that is used to create the cloud desktop.

Name
OfficeSiteTypestring

The account type of the workspace.

Enumeration Value:
  • SIMPLE
  • AD_CONNECTOR
SIMPLE
HostNamestring

The hostname of the cloud desktop.

testName
Disksobject []

Details of the disks.

DiskTypestring

The type of the disk.

Enumeration Value:
  • SYSTEM
  • DATA
SYSTEM
DiskIdstring

The ID of the disk.

d-jedbpr4sl9l37****
DiskSizeinteger

The size of the disk. Unit: GiB.

80
PerformanceLevelstring

The performance level (PL) of the disk that is an enhanced SSD (ESSD). Valid values:

  • PL0
  • PL1
  • PL2
  • PL3

For more information about the differences between disks of different PLs, see Enhanced SSDs.

PL0
Tagsobject []

Details of the tags.

Keystring

The key of the tag.

TestKey
Valuestring

The value of the tag.

TestValue
Sessionsobject []

Details of the desktop sessions that end users hold.

EndUserIdstring

The ID of the end user that logged on to the cloud desktop.

29615820929547****
EstablishmentTimestring

The time when the desktop session was established.

2021-03-07T08:23Z
ExternalUserNamestring

The name of the external user.

Testname
EndUserIdsarray

The IDs of the end users that have the permissions to connect to the cloud desktops.

string

The ID of the end user that has the permissions to connect to the cloud desktop.

Alice
DowngradeQuotalong

The number of times for which the cloud desktop can be downgraded.

3
DowngradedTimeslong

The number of times for which the cloud desktop has been downgraded.

0
GpuCategorylong

Indicates whether the cloud desktop is of the GPU-accelerated type.

0
GpuDriverVersionstring

The version of the GPU driver with which the cloud desktop is equipped.

null
ZoneTypestring

The type of the zone. Default value: AvailabilityZone. This value indicates Alibaba Cloud zones.

AvailabilityZone
FotaUpdateobject

The information about the image version that the cloud desktop uses.

CurrentAppVersionstring

The current version of the cloud desktop.

0.0.0-D-20220102.000000
NewAppVersionstring

The version to which the cloud desktop can be updated.

0.0.0-R-20220307.190736
ReleaseNotestring

The description of the version to which the cloud desktop can be updated.

Upgrade package for testing 03-07
Sizelong

The size of the installation package for the version to which the cloud desktop can be updated. Unit: KB.

108815097
ReleaseNoteEnstring

The description of the version that can be upgraded in English.

Release note
ReleaseNoteJpstring

The description of the version that can be upgraded in Japanese.

リリースノート
Progressstring

The progress when the cloud desktop was created.

100%
VolumeEncryptionEnabledboolean

Indicates whether disk encryption is enabled.

false
VolumeEncryptionKeystring

The ID of the Key Management Service (KMS) key that is used when disk encryption is enabled. You can call the ListKeys operation to obtain a list of KMS keys.

08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
OfficeSiteVpcTypestring

The virtual private cloud (VPC) type of the workspace.

Enumeration Value:
  • standard
  • customized
  • basic
basic
Platformstring

The information about the OS platform. Valid values:

  • CentOS
  • Ubuntu
  • Windows Server 2016
  • Windows Server 2019
  • UOS
Ubuntu
SessionTypestring

The session type.

Valid values:

  • SINGLE_SESSION

  • MULTIPLE_SESSION

SINGLE_SESSION
ManagementFlagsarray

The flag that is used to manage the cloud desktops.

string

The management status of the cloud desktop. Valid values:

  • NO_FLAG: The cloud desktop is stateless.
  • UPDATING: The cloud desktop is being updated.
  • MIGRATING: The workspace of the cloud desktop is being migrated.
  • ASSIGNING: The cloud desktop is being assigned to users.
  • ENTER_MAINTENANCE: The cloud desktop is in maintenance mode.
  • ENTER_MAINTENANCE: The cloud desktop enters the maintenance mode.
  • MIGRATING_PROTOCOL: The protocol of the cloud desktop is being migrated.
["NoFlag"]
SnapshotPolicyIdstring

The ID of the snapshot policy.

sp-gi007jgyc3kcey2bb
SnapshotPolicyNamestring

The name of the snapshot policy.

testSnapshotName
BindAmountinteger

The number of sessions allowed for each cloud desktop in the multi-session desktop group.

10
PolicyGroupIdListarray

The policies IDs.

string

The policy ID.

pg-dasffjkdf*****
PolicyGroupNameListarray

The policy names.

string

The policy name.

test01
HibernationOptionsConfiguredboolean
Note This parameter is in invitational preview and is not available for use.
true
SupportHibernationboolean

Indicates whether hibernation is supported for the cloud desktop.

true
HibernationBetaboolean
Note This parameter is in invitational preview and is not available for use.
true

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 timeSummary of changesOperation
2023-09-22The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-09-11The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-07-19The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-07-03The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-05-18The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-05-06The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: DesktopStatusList
Output ParametersThe response structure of the API has changed.
2023-03-17The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ImageId
2022-08-04The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2022-08-04The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2022-08-04The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2022-08-04The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2022-08-04The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2022-08-04The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2022-07-07The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Tag
2022-01-20The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2022-01-20The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2021-12-22The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2021-09-26The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: DesktopGroupId