调用DescribeDesktops查询桌面信息。

请求参数

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

系统规定参数。取值：DescribeDesktops。

RegionId String 是 cn-hangzhou

地域ID。
DirectoryId String 否 cn-hangzhou+dir-jedbpr4sl9l37****

目录ID。同工作区ID。
OfficeSiteId String 否 cn-hangzhou+dir-885351****

工作区ID。
ClientId String 是 f4a0dc8e-1702-4728-9a60-95b27a35****

客户端生成的唯一ID。
SessionId String 是 cd45e873-650d-4d70-acb9-f996187a****

会话ID。
LoginToken String 是 v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****

登录凭证。
GroupId String 否 system-all-enabled-policy

策略ID。
DesktopStatus String 否 Running

云桌面状态。取值范围：

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

分页查询时每页行数。

最大值：100。

默认值：10。
NextToken String 否 caeba0bbb2be03f84eb48b699f0a4883

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

用户名。
DesktopName String 否 testName

云桌面名称。
Html5Access String 否 OFF

是否使用Web客户端（浏览器）。取值范围：

  • ON：使用Web客户端。
  • OFF：未使用Web客户端。
ProtocolType String 否 HDX

协议类型。
ClientType String 否 windows client

客户端的类型。取值范围：

  • windows client：Windows客户端
  • linux client： 阿里云云终端
  • mac client：Mac客户端
  • iphone or ipad：iOS客户端
  • android client：Android客户端
  • html 5：Web客户端
QueryFotaUpdate Boolean 否 true

是否查询镜像更新信息。
DesktopId.N String 否 1

云桌面ID。可设置一个或多个，N的取值范围为1~100。

返回数据

名称 类型 示例值 描述
NextToken String caeba0bbb2be03f84eb48b699f0a4883

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

请求ID。
Desktops Array of Desktop

云桌面详细信息。
CreationTime String 2020-11-06T08:28Z

云桌面的创建时间。
DataDiskCategory String null

该参数暂未开放使用。
SystemDiskCategory String null

该参数暂未开放使用。
ChargeType String PostPaid

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

  • PostPaid：按量付费
  • PrePaid：包年包月
NetworkInterfaceId String eni-uf6iey64p5h9j5uqcowy

弹性网卡ID。
OfficeSiteId String cn-hangzhou+dir-990541****

工作区ID。
DesktopName String testDesktopName

云桌面名称。
DataDiskSize String null

该参数暂未开放使用。
DesktopGroupId String dg-3uiojcc0j4kh7****

桌面组ID。

说明 桌面组功能正在邀测中，无需使用，请提交工单申请。
DesktopId String ecd-gx2x1dhsmucyy****

云桌面ID。
SystemDiskSize Integer 1

该参数暂未开放使用。
Cpu Integer 2

云桌面的CPU数量。
PolicyGroupId String pg-cg27ufmapx1u40bl4

云桌面关联的策略ID。
ExpiredTime String 2099-12-31T15:59Z

云桌面的过期时间。

  • 对于包年包月云桌面，该返回值有实际意义。
  • 对于按量付费云桌面，均返回2099-12-31T15:59Z。
DesktopStatus String Running

云桌面状态。可能值：

  • Pending：等待中
  • Starting：启动中
  • Running：运行中
  • Stopping：停止中
  • Stopped：已停止
  • Expired：已过期
  • Deleted：已删除
  • FotaUpdating：镜像升级中
OsType String Windows

操作系统类型。可能值：

  • Windows
  • Linux
LastStartTime String 2021-07-13T15:59Z

上次开机时间，即最近一次的开机时间。
DesktopType String eds.general.2c8g

云桌面规格。
ConnectionStatus String Disconnected

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

  • Connected：已连接
  • Disconnected：已断开连接
  • Unknown：未知
Memory Long 4096

云桌面的内存。单位为MiB。
ProtocolType String HDX

协议类型。
ImageId String m-4zfb6zj728hhr****

镜像ID。
DirectoryId String cn-hangzhou+dir-jedbpr4sl9l37****

目录ID。
Disks Array of Disk

磁盘信息。
DiskType String SYSTEM

磁盘类型。可能值：

  • SYSTEM：系统盘。
  • DATA：数据盘。
DiskId String d-jedbpr4sl9l37****

磁盘ID。
DiskSize Integer 80

磁盘大小。单位为GiB。
Sessions Array of Session

会话信息。
EndUserId String alice

用户名。
EstablishmentTime String 2021-08-25T04:28Z

会话创建时间。
EndUserIds Array of String 123456789

授权登录云桌面的用户ID。
GpuMemory Integer 1

显存大小。

对于GPU型云桌面，该返回值有实际意义。单位：MB。
RealDesktopId String ecd-gx2x1dhsmucyy

返回真实的桌面ID。

对于桌面组桌面有意义，表示绑定桌面实例后返回真实的桌面ID。
FotaUpdate Object

镜像的更新信息。
CurrentAppVersion String 0.0.0-D-20220102.000000

桌面当前版本号。
NewAppVersion String 0.0.0-R-20220307.190736

桌面可升级的版本号。
ReleaseNote String 测试升级包03-07

可升级的版本描述。
Size Long 108815097

可升级的版本安装包大小。

示例

请求示例

https://ecd.cn-hangzhou.aliyuncs.com/?Action=DescribeDesktops
&ClientId=f4a0dc8e-1702-4728-9a60-95b27a35****
&LoginToken=v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
&RegionId=cn-hangzhou
&SessionId=cd45e873-650d-4d70-acb9-f996187a****
&<公共请求参数>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDesktopsResponse>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <RequestId>484256DA-D816-44D2-9D86-B6EE4D5BA78C</RequestId>
    <Desktops>
        <CreationTime>2020-11-06T08:28Z</CreationTime>
        <DataDiskCategory>null</DataDiskCategory>
        <SystemDiskCategory>null</SystemDiskCategory>
        <ChargeType>PostPaid</ChargeType>
        <NetworkInterfaceId>eni-uf6iey64p5h9j5uqcowy</NetworkInterfaceId>
        <OfficeSiteId>cn-hangzhou+dir-990541****</OfficeSiteId>
        <DesktopName>testDesktopName</DesktopName>
        <DataDiskSize>null</DataDiskSize>
        <DesktopGroupId>dg-3uiojcc0j4kh7****</DesktopGroupId>
        <DesktopId>ecd-gx2x1dhsmucyy****</DesktopId>
        <SystemDiskSize>1</SystemDiskSize>
        <Cpu>2</Cpu>
        <PolicyGroupId>pg-cg27ufmapx1u40bl4</PolicyGroupId>
        <ExpiredTime>2099-12-31T15:59Z</ExpiredTime>
        <DesktopStatus>Running</DesktopStatus>
        <OsType>Windows</OsType>
        <LastStartTime>2021-07-13T15:59Z</LastStartTime>
        <DesktopType>eds.general.2c8g</DesktopType>
        <ConnectionStatus>Disconnected</ConnectionStatus>
        <Memory>4096</Memory>
        <ProtocolType>HDX</ProtocolType>
        <ImageId>m-4zfb6zj728hhr****</ImageId>
        <DirectoryId>cn-hangzhou+dir-jedbpr4sl9l37****	</DirectoryId>
        <Disks>
            <DiskType>SYSTEM</DiskType>
            <DiskId>d-jedbpr4sl9l37****</DiskId>
            <DiskSize>80</DiskSize>
        </Disks>
        <Sessions>
            <EndUserId>alice</EndUserId>
            <EstablishmentTime>2021-08-25T04:28Z</EstablishmentTime>
        </Sessions>
        <EndUserIds>123456789</EndUserIds>
        <GpuMemory>1</GpuMemory>
        <RealDesktopId>ecd-gx2x1dhsmucyy</RealDesktopId>
        <FotaUpdate>
            <CurrentAppVersion>0.0.0-D-20220102.000000</CurrentAppVersion>
            <NewAppVersion>0.0.0-R-20220307.190736</NewAppVersion>
            <ReleaseNote>测试升级包03-07</ReleaseNote>
            <Size>108815097</Size>
        </FotaUpdate>
    </Desktops>
</DescribeDesktopsResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId" : "484256DA-D816-44D2-9D86-B6EE4D5BA78C",
  "Desktops" : [ {
    "CreationTime" : "2020-11-06T08:28Z",
    "DataDiskCategory" : "null",
    "SystemDiskCategory" : "null",
    "ChargeType" : "PostPaid",
    "NetworkInterfaceId" : "eni-uf6iey64p5h9j5uqcowy",
    "OfficeSiteId" : "cn-hangzhou+dir-990541****",
    "DesktopName" : "testDesktopName",
    "DataDiskSize" : "null",
    "DesktopGroupId" : "dg-3uiojcc0j4kh7****",
    "DesktopId" : "ecd-gx2x1dhsmucyy****",
    "SystemDiskSize" : 1,
    "Cpu" : 2,
    "PolicyGroupId" : "pg-cg27ufmapx1u40bl4",
    "ExpiredTime" : "2099-12-31T15:59Z",
    "DesktopStatus" : "Running",
    "OsType" : "Windows",
    "LastStartTime" : "2021-07-13T15:59Z",
    "DesktopType" : "eds.general.2c8g",
    "ConnectionStatus" : "Disconnected",
    "Memory" : 4096,
    "ProtocolType" : "HDX",
    "ImageId" : "m-4zfb6zj728hhr****",
    "DirectoryId" : "cn-hangzhou+dir-jedbpr4sl9l37****\t",
    "Disks" : [ {
      "DiskType" : "SYSTEM",
      "DiskId" : "d-jedbpr4sl9l37****",
      "DiskSize" : 80
    } ],
    "Sessions" : [ {
      "EndUserId" : "alice",
      "EstablishmentTime" : "2021-08-25T04:28Z"
    } ],
    "EndUserIds" : [ "123456789" ],
    "GpuMemory" : 1,
    "RealDesktopId" : "ecd-gx2x1dhsmucyy",
    "FotaUpdate" : {
      "CurrentAppVersion" : "0.0.0-D-20220102.000000",
      "NewAppVersion" : "0.0.0-R-20220307.190736",
      "ReleaseNote" : "测试升级包03-07",
      "Size" : 108815097
    }
  } ]
}