DescribeDesktopInfo - Query cloud desktop basic info API - Elastic Desktop Service

Queries basic information about cloud desktops.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:DescribeDesktopInfo

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	Region ID. Call DescribeRegions to query supported regions.	cn-hangzhou
DesktopId	array	No	Cloud desktop IDs. You can specify 1 to 100 IDs.
	string	No	Desktop ID.	["ecd-gx2x1dhsmucyy****"]
NeedExtraInfo	boolean	No

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID.	062B1439-709A-580E-85DF-CE97A1560565
Desktops	array<object>	Basic desktop information.
	object	Basic desktop information.
CurrentAppVersion	string	Current image version of the desktop.	1.4.0-R-***
StartTime	string	Time when the desktop first started.	2020-11-06T08:31Z
ConnectionStatus	string	User connection status. Valid values: Connected : Connected Disconnected : Disconnected	Disconnected
DesktopId	string	Desktop ID.	ecd-gx2x1dhsmucyy****
DesktopStatus	string	Cloud desktop status. Valid values: Stopped : The cloud desktop is stopped. Failed : The cloud desktop failed to be created. Starting : The cloud desktop is starting. Running : The cloud desktop is running. Stopping : The cloud desktop is stopping. Expired : The cloud desktop has expired. Deleted : The cloud desktop has been deleted. Pending : The cloud desktop is being created.	Running
ManagementFlag	array	The management flag.
	string	The management flag. Valid values: Migrating : Migrating Updating : Upgrading or downgrading NoFlag : No flag	NoFlag
NewAppVersion	string	Available upgrade image version.	1.6.0-R-***
ReleaseNote	string	Release notes for the upgrade image version.	测试升级包03-07
NewAppSize	integer	Upgrade package size. Unit: KB.	568533470
DesktopGroupId	string	Computer pool ID.	dg-3uiojcc0j4kh7****

Examples

Success response

JSON format

{
  "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": "测试升级包03-07\n",
      "NewAppSize": 568533470,
      "DesktopGroupId": "dg-3uiojcc0j4kh7****"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.