调用DescribeDesktopMetadata查询全地域云桌面列表及元数据-无影云电脑企业版-阿里云

查询全地域的桌面列表及元数据。

接口说明

该接口为中心化接口，仅支持上海及新加坡站点查询。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ecd:DescribeDesktopMetadata	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 id。	cn-shanghai
SearchRegionId	string	是	需要搜索的地域 id。	cn-hangzhou
OfficeSiteId	string	否	工作区 id。	cn-hangzhou+dir-778418****
GroupId	string	否	共享云电脑 id。	dg-i1ruuudp92qpj****
MaxResults	integer	否	分页查询时每页行数。最大值：100 默认值：10	10
NextToken	string	否	下一个查询开始的 token，nexttoken 为空表示没有下一个。	caeba0bbb2be03f84eb48b699f0a4883
Keyword	string	否	说明该参数正在邀测中，暂未开放使用。	ecd
CreationTimeStart	string	否	云电脑创建的时间点。格式为 UTC 时间格式： `yyyy-MM-dd'T'HH:mm:ss'Z'`。	2025-01-01T12:00:00Z
OperationTimeStart	string	否	云电脑发生操作的开始时间。时间格式： `yyyy-MM-dd'T'HH:mm:ss'Z'`。	2025-01-01T12:00:00Z
IncludeDesktopGroup	boolean	否	返回接口是否包含共享云电脑中的云电脑。	false
ImageId	string	否	镜像 ID。	m-gx2x1dhsmusr2****
DesktopIds	array	否	云电脑 ID 列表。
	string	否	云电脑 ID 列表。	ecd-84mztzatmipf2****
HostName	string	否	主机名称	ASW-2F-SRV-YXYZ-4.SHPTG

返回参数

名称	类型	描述	示例值
	object
NextToken	string	下一个查询开始的 token，nexttoken 为空表示没有下一个。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	请求 id。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
Desktops	array<object>	云桌面详细信息。
Desktop	object	云桌面详细信息。
CreationTime	string	云桌面的创建时间。	2020-11-06T08:28Z
LocalName	string	云桌面所属的本地名称。	华东2（上海）
OfficeSiteId	string	工作区 id。	cn-hangzhou+dir-363353****
ChargeType	string	云桌面的计费类型。可能值： PostPaid：按量付费 PrePaid：包年包月	PostPaid
DesktopName	string	云桌面名称。	testDesktopName
DesktopId	string	云桌面 id。	ecd-gx2x1dhsmucyy****
DesktopGroupId	string	共享云电脑 id。	dg-3uiojcc0j4kh7****
RegionId	string	地域 id。	cn-hangzhou
StartTime	string	云桌面的启动时间。	2020-11-06T08:31Z
DesktopStatus	string	云桌面状态。可能值： Stopped(已关机) Starting(启动中) Rebuilding(重建中) Running(运行中) Stopping(停止中) Expired(已过期) Deleted(已删除) Pending(等待中)	Running
ExpiredTime	string	云桌面过期时间。仅计费方式为包年包月的云桌面有该返回值。	2021-12-31T15:59Z
ImageId	string	镜像 id。	m-4zfb6zj728hhr****
ResourceGroupId	string	资源组 ID。	rg-f3s3dgt8dtb0vlqc8
ResourceGroupName	string	资源组名称。	serverless_new
ManagementFlags	array	云电脑管理状态。
ManagementFlag	string	管理标识。可能值： NoFlag：无状态 Updating：升级或更新中 Migrating：迁移中 UnderMaintenance：维护模式 EnterMaintenance：正在进入维护模式 Hibernating：休眠中 Hibernated：已休眠 WakingUp：唤醒中	["NoFlag"]

示例

正常返回示例

JSON格式

{
  "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"
        ]
      ]
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2025-12-23	新增 OpenAPI	查看变更详情