调用DescribeDesktops查询云桌面的详细信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeDesktops

系统规定参数。取值：DescribeDesktops。
RegionId String 是 cn-hangzhou

地域ID。
DesktopStatus String 否 Running

云桌面状态。取值范围：

  • Pending：等待中
  • Starting：启动中
  • Running：运行中
  • Stopping：停止中
  • Stopped：已停止
  • Expired：已过期
  • Deleted：已删除
MaxResults Integer 否 10

分页查询时每页行数。

最大值：100

默认值：10
NextToken String 否 caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始的Token，NextToken为空表示没有下一个。
DesktopName String 否 testDesktopName

云桌面名称。
DirectoryId String 否 cn-hangzhou+dir-jedbpr4sl9l37****

目录ID。
PolicyGroupId String 否 system-all-enabled-policy

策略ID。
DesktopId.N RepeatList 否 ecd-gx2x1dhsmucyy****

云桌面ID。可设置一个或多个，N的取值范围：1~100。
EndUserId.N RepeatList 否 123456789

授权使用云桌面的用户ID。可设置一个或多个，N的取值范围：1~100。

说明 在同一时段内，只有一个用户可以使用该桌面。

返回数据

名称 类型 示例值 描述
Desktops Array of Desktop

云桌面详细信息组成的集合。
ChargeType String PostPaid

云桌面的计费类型。可能值：

  • PostPaid：按量付费
  • PrePaid：包年包月
ConnectionStatus String Disconnected

用户的连接状态。可能值：

  • Connected：已连接
  • Disconnected：已断开连接
  • Unknown：未知
Cpu Integer 2

CPU数量。
CreationTime String 2020-11-06T08:28Z

云桌面的创建时间。
DataDiskCategory String null
说明 该参数正在邀测中，暂未开放使用。
DataDiskSize String null
说明 该参数正在邀测中，暂未开放使用。
DesktopId String ecd-gx2x1dhsmucyy****

云桌面ID。
DesktopName String testDesktopName

云桌面名称。
DesktopStatus String Running

云桌面状态。
DesktopType String ecd.basic.large

云桌面规格。
DirectoryId String cn-hangzhou+dir-jedbpr4sl9l37****

目录ID。
Disks Array of Disk

磁盘信息组成的集合。
DiskId String d-jedbpr4sl9l37****

磁盘ID。
DiskSize Integer 80

磁盘大小。单位：GiB
DiskType String system

磁盘类型。可能值：

  • system：系统盘
  • data：数据盘
EndUserIds List 123456789

授权登录云桌面的用户ID。
ExpiredTime String 2099-12-31T15:59Z

云桌面的过期时间。仅计费方式为包年包月的云桌面有该返回值。
ImageId String m-4zfb6zj728hhr****

镜像ID。
Memory Long 4096

内存大小。单位：MiB
NetworkInterfaceId Long 123456

云桌面服务在RAM或AD用户下创建的辅助网卡ID，您没有修改权限。
PolicyGroupId String system-all-enabled-policy

策略ID。
SystemDiskCategory String null
说明 该参数正在邀测中，暂未开放使用。
SystemDiskSize Integer 0
说明 该参数正在邀测中，暂未开放使用。
NextToken String caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始的Token，NextToken为空表示没有下一个。
RequestId String 484256DA-D816-44D2-9D86-B6EE4D5BA78C

请求ID。

示例

请求示例

https://ecd.cn-hangzhou.aliyuncs.com/?Action=DescribeDesktops
&MaxResults=10
&DesktopId.1=ecd-gx2x1dhsmucyy****
&<公共请求参数>

正常返回示例

XML 格式 

<DescribeDesktopsResponse>
      <RequestId>484256DA-D816-44D2-9D86-B6EE4D5BA78C</RequestId>
      <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
      <Desktops>
            <PolicyGroupId>system-all-enabled-policy</PolicyGroupId>
            <Memory>4096</Memory>
            <DesktopName>testDesktopName</DesktopName>
            <DesktopId>ecd-gx2x1dhsmucyy****</DesktopId>
            <Cpu>2</Cpu>
            <EndUserIds>123456789</EndUserIds>
            <NetworkInterfaceId>123456</NetworkInterfaceId>
            <DesktopStatus>Running</DesktopStatus>
            <DirectoryId>cn-hangzhou+dir-akchwgcm706le****</DirectoryId>
            <DesktopType>ecd.basic.large</DesktopType>
            <ChargeType>PostPaid</ChargeType>
            <ExpiredTime>2099-12-31T15:59Z</ExpiredTime>
            <CreationTime>2020-11-06T08:28Z</CreationTime>
            <ImageId>m-4zfb6zj728hhr****</ImageId>
            <Disks>
                  <DiskId>d-jedbpr4sl9l37****</DiskId>
                  <DiskSize>80</DiskSize>
                  <DiskType>system</DiskType>
            </Disks>
            <ConnectionStatus>Disconnected</ConnectionStatus>
      </Desktops>
</DescribeDesktopsResponse>

JSON 格式 

{
    "RequestId":"484256DA-D816-44D2-9D86-B6EE4D5BA78C",
    "NextToken":"caeba0bbb2be03f84eb48b699f0a4883",
    "Desktops":[
        {
            "PolicyGroupId":"system-all-enabled-policy",
            "Memory":"4096",
            "DesktopName":"testDesktopName",
            "DesktopId":"ecd-gx2x1dhsmucyy****",
            "Cpu":"2",
            "EndUserIds":[
                "123456789"
            ],
            "NetworkInterfaceId":"123456",
            "DesktopStatus":"Running",
            "DirectoryId":"cn-hangzhou+dir-akchwgcm706le****",
            "DesktopType":"ecd.basic.large",
            "ChargeType":"PostPaid",
            "ExpiredTime":"2099-12-31T15:59Z",
            "CreationTime":"2020-11-06T08:28Z",
            "ImageId":"m-4zfb6zj728hhr****",
            "Disks":{
					"DiskId": "d-jedbpr4sl9l37****",
					"DiskSize": "80",
					"DiskType": "system"
				},
            "ConnectionStatus":"Disconnected"
        }
    ]
}

错误码

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