调用DescribeDesktops查询桌面信息。

调试

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

请求参数

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

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

ClientId String f4a0dc8e-1702-4728-9a60-95b27a35****

客户端生成的唯一ID。

LoginToken String v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****

登录凭证。

RegionId String cn-hangzhou

地域ID。

SessionId String cd45e873-650d-4d70-acb9-f996187a****

会话ID。

OfficeSiteId String cn-hangzhou+dir-885351****

工作区ID。

GroupId String system-all-enabled-policy

策略ID。

DesktopStatus String Running

云桌面状态。取值范围:

  • Pending:等待中
  • Starting:启动中
  • Running:运行中
  • Stopping:停止中
  • Stopped:已停止
  • Expired:已过期
  • Deleted:已删除
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

协议类型。取值范围:

  • HDX
  • ASP
DesktopId.N RepeatList ecd-gx2x1dhsmucyy****

云桌面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

该参数暂未开放使用。

DesktopGroupId String dg-3uiojcc0j4kh7****

桌面组ID。

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

云桌面ID。

DesktopName String testDesktopName

云桌面名称。

DesktopStatus String Running

云桌面状态。可能值:

  • Pending:等待中
  • Starting:启动中
  • Running:运行中
  • Stopping:停止中
  • Stopped:已停止
  • Expired:已过期
  • Deleted:已删除
DesktopType String eds.general.2c8g

云桌面规格。

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

云桌面的过期时间。

  • 对于包年包月云桌面,该返回值有实际意义。
  • 对于按量付费云桌面,均返回2099-12-31T15:59Z。
ImageId String m-4zfb6zj728hhr****

镜像ID。

LastStartTime String 2021-07-13T15:59Z

上次开机时间,即最近一次的开机时间。

Memory Long 4096

云桌面的内存。单位为MiB。

NetworkInterfaceId String eni-uf6iey64p5h9j5uqcowy

弹性网卡ID。

OfficeSiteId String cn-hangzhou+dir-990541****

工作区ID。

OsType String Windows

操作系统类型。可能值:

  • Windows
  • Linux
PolicyGroupId String pg-cg27ufmapx1u40bl4

云桌面关联的策略ID。

ProtocolType String HDX

协议类型。可能值:

  • HDX
  • ASP
Sessions Array of Session

会话信息。

EndUserId String alice

用户名。

EstablishmentTime String 2021-08-25T04:28Z

会话创建时间。

SystemDiskCategory String null

该参数暂未开放使用。

SystemDiskSize Integer 1

该参数暂未开放使用。

NextToken String caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始的Token,NextToken为空表示没有下一个。

RequestId String 484256DA-D816-44D2-9D86-B6EE4D5BA78C

请求ID。

示例

请求示例

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格式

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

JSON格式

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