All Products
Search
Document Center

Elastic Desktop Service:DescribeDesktopInfo

Last Updated:Nov 14, 2025

Queries the basic information about cloud computers.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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 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:DescribeDesktopInfolist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region. You can call the DescribeRegions operation to query the regions supported by Elastic Desktop Service.

cn-hangzhou
DesktopIdarrayNo

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

stringNo

The ID of the cloud computer.

["ecd-gx2x1dhsmucyy****"]

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

062B1439-709A-580E-85DF-CE97A1560565
Desktopsarray<object>

The basic information about cloud computers.

Desktopobject
CurrentAppVersionstring

The version of the cloud computer image.

1.4.0-R-***
StartTimestring

The time when the cloud computer was first started.

2020-11-06T08:31Z
ConnectionStatusstring

The connection status of the user.

Valid values:

  • Connected
  • Disconnected
Disconnected
DesktopIdstring

The ID of the cloud computer.

ecd-gx2x1dhsmucyy****
DesktopStatusstring

The status of the cloud computer.

Valid values:

  • Stopped
  • Failed
  • Starting
  • Running
  • Stopping
  • Expired
  • Deleted
  • Pending
Running
ManagementFlagarray

The information about flags that are used to manage cloud computers.

mgtFlagstring

The flag that is used to manage the cloud desktop.

Valid values:

  • Migrating
  • Updating
  • NoFlag
NoFlag
NewAppVersionstring

The version number of the image that can be updated on the cloud computer.

1.6.0-R-***
ReleaseNotestring

The description of the image version that can be updated.

Test package 03-07
NewAppSizelong

The size of the update package. Unit: KB.

568533470
DesktopGroupIdstring

The ID of the cloud computer pool.

dg-3uiojcc0j4kh7****

Examples

Sample success responses

JSONformat

{
  "RequestId": "062B1439-709A-580E-85DF-CE97A1560565",
  "Desktops": [
    {
      "CurrentAppVersion": "1.4.0-R-***",
      "StartTime": "2020-11-06T08:31Z",
      "ConnectionStatus": "Disconnected",
      "DesktopId": "ecd-gx2x1dhsmucyy****",
      "DesktopStatus": "Running",
      "ManagementFlag": [
        "NoFlag"
      ],
      "NewAppVersion": "1.6.0-R-***",
      "ReleaseNote": "Test package 03-07",
      "NewAppSize": 568533470,
      "DesktopGroupId": "dg-3uiojcc0j4kh7****"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-05-07The response structure of the API has changedView Change Details
2024-01-04The response structure of the API has changedView Change Details