DescribeDesktopMetadata-阿里云帮助中心

Lists cloud computers and their metadata across all regions.

Operation description

This is a centralized API and is only available in the China (Shanghai) and Singapore regions.

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:DescribeDesktopMetadata

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
SearchRegionId	string	No	The ID of the region to query.	cn-hangzhou
OfficeSiteId	string	No	The office site ID.	cn-hangzhou+dir-778418****
GroupId	string	No	The ID of the cloud computer pool.	dg-i1ruuudp92qpj****
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
NextToken	string	No	The token that is used to start the next query. If this parameter is empty, all results are returned.	caeba0bbb2be03f84eb48b699f0a4883
Keyword	string	No	Note This parameter is in invitational preview and is not publicly available.	ecd
CreationTimeStart	string	No	The point in time when the cloud computer was created. The time must be in the `yyyy-MM-dd'T'HH:mm:ss'Z'` format. The time is displayed in UTC.	2025-01-01T12:00:00Z
OperationTimeStart	string	No	The beginning of the time range during which an operation was performed on the cloud computer. The time must be in the `yyyy-MM-dd'T'HH:mm:ss'Z'` format.	2025-01-01T12:00:00Z
IncludeDesktopGroup	boolean	No	Specifies whether to include cloud computers in a cloud computer pool.	false
ImageId	string	No	The image ID.	m-gx2x1dhsmusr2****
DesktopIds	array	No	The cloud computer IDs.
	string	No	The ID of a cloud computer.	ecd-84mztzatmipf2****
HostName	string	No	The hostname.	ASW-2F-SRV-YXYZ-4.SHPTG

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token used to retrieve the next page of results. If this parameter is not returned, all results have been returned.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
Desktops	array<object>	The details of the cloud desktops.
	object	The details of a cloud desktop.
CreationTime	string	The time when the cloud desktop was created.	2020-11-06T08:28Z
LocalName	string	The display name of the region.	华东2（上海）
OfficeSiteId	string	The ID of the office network.	cn-hangzhou+dir-363353****
ChargeType	string	The billing method of the cloud desktop. Valid values: `PostPaid`: pay-as-you-go `PrePaid`: subscription	PostPaid
DesktopName	string	The name of the cloud desktop.	testDesktopName
DesktopId	string	The ID of the cloud desktop.	ecd-gx2x1dhsmucyy****
DesktopGroupId	string	The ID of the desktop group.	dg-3uiojcc0j4kh7****
RegionId	string	The ID of the region.	cn-hangzhou
StartTime	string	The time when the cloud desktop was started.	2020-11-06T08:31Z
DesktopStatus	string	The status of the cloud desktop. Valid values: Stopped Starting Rebuilding Running Stopping Expired Deleted Pending	Running
ExpiredTime	string	The expiration time of the cloud desktop. This parameter is returned only for subscription cloud desktops.	2021-12-31T15:59Z
ImageId	string	The ID of the image.	m-4zfb6zj728hhr****
ResourceGroupId	string	The ID of the resource group.	rg-f3s3dgt8dtb0vlqc8
ResourceGroupName	string	The name of the resource group.	serverless_new
ManagementFlags	array	The management flags of the cloud desktop.
	string	The management flag. Valid values: `NoFlag`: stateless `Updating`: upgrading or updating `Migrating`: migrating `UnderMaintenance`: maintenance mode `EnterMaintenance`: entering maintenance mode `Hibernating`: hibernating `Hibernated`: hibernated `WakingUp`: waking up	["NoFlag"]
DesktopType	string
MemberEniIp	string
Platform	string
AgentProviderList	array
	string

Examples

Success response

JSON format

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "Desktops": [
    {
      "CreationTime": "2020-11-06T08:28Z",
      "LocalName": "华东2（上海）",
      "OfficeSiteId": "cn-hangzhou+dir-363353****",
      "ChargeType": "PostPaid",
      "DesktopName": "testDesktopName",
      "DesktopId": "ecd-gx2x1dhsmucyy****",
      "DesktopGroupId": "dg-3uiojcc0j4kh7****",
      "RegionId": "cn-hangzhou",
      "StartTime": "2020-11-06T08:31Z",
      "DesktopStatus": "Running",
      "ExpiredTime": "2021-12-31T15:59Z",
      "ImageId": "m-4zfb6zj728hhr****",
      "ResourceGroupId": "rg-f3s3dgt8dtb0vlqc8",
      "ResourceGroupName": "serverless_new",
      "ManagementFlags": [
        "[\"NoFlag\"]"
      ],
      "DesktopType": "",
      "MemberEniIp": "",
      "Platform": "",
      "AgentProviderList": [
        ""
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.