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

调试

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

请求参数

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

系统规定参数。取值:DescribeDesktops

RegionId String cn-hangzhou

地域ID。

GroupId String dg-boyczi8enfyc5****

桌面组ID。

说明 桌面组功能目前处于邀测中,如需体验,请提交工单申请。
DesktopStatus String Running

云桌面状态。取值范围:

  • Pending:等待中
  • Starting:启动中
  • Running:运行中
  • Stopping:停止中
  • Rebuilding:重建中
  • Stopped:已关机
  • Expired:已过期
  • Deleted:已删除
MaxResults Integer 10

分页查询时每页行数。

最大值:100

默认值:10

NextToken String caeba0bbb2be03f84eb48b699f0a4883

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

UserName String Aliex

用户名称。

DesktopName String testDesktopName

云桌面名称。

DirectoryId String cn-hangzhou+dir-363353****

目录ID。同工作区ID。

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

工作区ID。

PolicyGroupId String system-all-enabled-policy

策略ID。

ChargeType String PostPaid

云桌面的计费方式。取值范围:

  • PostPaid:按量付费
  • PrePaid:包年包月

默认值:PostPaid。

ExpiredTime String 2022-12-31T15:59Z

包年包月付费类型桌面的到期时间。

ProtocolType String HDX

协议类型。取值范围:

  • HDX
  • ASP
说明 ASP协议的云桌面目前处于邀测中,如需体验,请提交工单申请。
DesktopId.N String ecd-gx2x1dhsmucyy****

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

EndUserId.N String alice

已分配云桌面的用户名列表。可设置一个或多个,N的取值范围:1~100。

说明 在同一时段内,只有一个用户可以使用该桌面。
ExcludedEndUserId.N String andy

要排除的已分配云桌面的用户名列表。可设置一个或多个,N的取值范围:1~100。

返回数据

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

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

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

请求ID。

TotalCount Integer 1

桌面总数量。

Desktops Array of Desktop

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

CreationTime String 2020-11-06T08:28Z

云桌面创建时间。

ChargeType String PostPaid

云桌面的计费方式。取值范围:

  • PostPaid:按量付费
  • PrePaid:包年包月

默认值:PostPaid。

DesktopName String testDesktopName

云桌面名称。

PolicyGroupName String test

策略名称。

SystemDiskSize Integer 0

该参数正在邀测中,暂未开放使用。

PolicyGroupId String system-all-enabled-policy

策略ID。

DesktopStatus String Running

云桌面状态。

DesktopType String ecd.basic.large

云桌面规格。

GpuCount Float 1

GPU数量。

ProtocolType String ASP

协议类型。

  • Citrix HDX:第三方协议。
  • ASP:阿里云流化协议。
Memory Long 4096

内存大小。单位:MiB。

GpuSpec String NVIDIA T4

GPU规格。

ImageId String m-4zfb6zj728hhr****

镜像ID。

DirectoryId String cn-hangzhou+dir-363353****

该参数正在邀测中,暂未开放使用。

ManagementFlag String NoFlag

管理标识。可能值:

  • NoFlag:无标识
  • Updating:变配中
DataDiskCategory String null
说明 该参数正在邀测中,暂未开放使用。
SystemDiskCategory String null

该参数正在邀测中,暂未开放使用。

NetworkInterfaceId String 123456

云桌面服务在RAM或AD用户下创建的辅助网卡ID,您没有修改权限。

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

工作区ID。

DataDiskSize String null
说明 该参数正在邀测中,暂未开放使用。
DesktopGroupId String null

云桌面所属的桌面组ID。默认为null。

说明 该参数正在邀测中,暂未开放使用。
DesktopId String ecd-gx2x1dhsmucyy****

云桌面ID。

OfficeSiteName String test

工作区名称。

StartTime String 2020-11-06T08:31Z

云桌面首次启动时间。

DirectoryType String SIMPLE

该参数正在邀测中,暂未开放使用。

Cpu Integer 2

CPU个数。

NetworkInterfaceIp String 192.168.74.165

云桌面服务在RAM或AD用户下创建的辅助网卡IP。

ExpiredTime String 2021-12-31T15:59Z

包年包月付费类型桌面的到期时间。

OsType String Windows

操作系统类型。

ConnectionStatus String Disconnected

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

  • Connected:已连接
  • Disconnected:已断开连接
  • Unknown:未知
BundleId String b-2g65ljy4291vl****

云桌面使用的桌面模板ID。

OfficeSiteType String SIMPLE

工作区的账号系统类型。可能值:

  • SIMPLE:便捷账号
  • AD_CONNECTOR:企业AD账号
HostName String testName

主机名称。

Disks Array of Disk

磁盘信息组成的集合。

DiskType String SYSTEM

磁盘类型。可能值:

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

磁盘ID。

DiskSize Integer 80

磁盘大小。单位:GiB。

Tags Array of Tag

标签信息。

Key String TestKey

标签键。

Value String TestValue

标签值。

Sessions Array of Session

桌面用户会话信息。

EndUserId String 29615820929547****

登录云桌面的用户ID。

EstablishmentTime String 2021-03-07T08:23Z

桌面会话连接的时间。

EndUserIds Array of String Alice

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

示例

请求示例

https://ecd.cn-hangzhou.aliyuncs.com/?Action=DescribeDesktops
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

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

<DescribeDesktopsResponse>
    <TotalCount>10</TotalCount>
    <RequestId>A55A318E-6CBE-5066-839A-07F0654A8036</RequestId>
    <Desktops>
        <Memory>8192</Memory>
        <DesktopName>Zecdf7a7j74obd6tnswrjZ</DesktopName>
        <Cpu>4</Cpu>
        <NetworkInterfaceId>eni-uf6bpjqg1hkhlqzr****</NetworkInterfaceId>
        <DirectoryType>SIMPLE</DirectoryType>
        <OsType>Windows</OsType>
        <ExpiredTime>2021-11-29T16:00Z</ExpiredTime>
        <ImageId>desktopimage-windows-server-2019-64-ch</ImageId>
        <NetworkInterfaceIp>172.16.XX.XX</NetworkInterfaceIp>
        <OfficeSiteName>test-111</OfficeSiteName>
        <GpuCount>0</GpuCount>
        <ConnectionStatus>Disconnected</ConnectionStatus>
        <HostName>a7j74obd6tn****</HostName>
        <PolicyGroupId>pg-9c2d6t2dwflqr****</PolicyGroupId>
        <OfficeSiteType>SIMPLE</OfficeSiteType>
        <StartTime>2021-10-29T09:45Z</StartTime>
        <PolicyGroupName>test-2</PolicyGroupName>
        <DesktopId>ecd-f7a7j74obd6tn****</DesktopId>
        <DesktopStatus>Running</DesktopStatus>
        <OfficeSiteId>cn-shanghai+dir-799957****</OfficeSiteId>
        <BundleId>bundle_eds_general_4c8g_s8d5_win2019</BundleId>
        <DirectoryId>cn-shanghai+dir-799957****</DirectoryId>
        <DesktopType>eds.general.4c8g</DesktopType>
        <ChargeType>PrePaid</ChargeType>
        <ProtocolType>HDX</ProtocolType>
        <CreationTime>2021-10-29T09:42Z</CreationTime>
        <Disks>
            <DiskType>DATA</DiskType>
            <DiskSize>50</DiskSize>
            <DiskId>d-f7a7j74obd8sl****</DiskId>
        </Disks>
        <Disks>
            <DiskType>SYSTEM</DiskType>
            <DiskSize>80</DiskSize>
            <DiskId>d-f7a7j74obd8slc****</DiskId>
        </Disks>
    </Desktops>
</DescribeDesktopsResponse>

JSON格式

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

{
  "TotalCount" : 10,
  "RequestId" : "A55A318E-6CBE-5066-839A-07F0654A8036",
  "Desktops" : [ {
    "Memory" : 8192,
    "DesktopName" : "Zecdf7a7j74obd6tnswrjZ",
    "Cpu" : 4,
    "NetworkInterfaceId" : "eni-uf6bpjqg1hkhlqzr****",
    "DirectoryType" : "SIMPLE",
    "OsType" : "Windows",
    "ExpiredTime" : "2021-11-29T16:00Z",
    "ImageId" : "desktopimage-windows-server-2019-64-ch",
    "NetworkInterfaceIp" : "172.16.XX.XX",
    "OfficeSiteName" : "test-111",
    "GpuCount" : 0,
    "ConnectionStatus" : "Disconnected",
    "HostName" : "a7j74obd6tn****",
    "PolicyGroupId" : "pg-9c2d6t2dwflqr****",
    "OfficeSiteType" : "SIMPLE",
    "Sessions" : [ ],
    "StartTime" : "2021-10-29T09:45Z",
    "PolicyGroupName" : "test-2",
    "DesktopId" : "ecd-f7a7j74obd6tn****",
    "EndUserIds" : [ ],
    "DesktopStatus" : "Running",
    "OfficeSiteId" : "cn-shanghai+dir-799957****",
    "BundleId" : "bundle_eds_general_4c8g_s8d5_win2019",
    "DirectoryId" : "cn-shanghai+dir-799957****",
    "DesktopType" : "eds.general.4c8g",
    "ChargeType" : "PrePaid",
    "ProtocolType" : "HDX",
    "CreationTime" : "2021-10-29T09:42Z",
    "Disks" : [ {
      "DiskType" : "DATA",
      "DiskSize" : 50,
      "DiskId" : "d-f7a7j74obd8sl****"
    }, {
      "DiskType" : "SYSTEM",
      "DiskSize" : 80,
      "DiskId" : "d-f7a7j74obd8slc****"
    } ]
  } ]
}