AI 助理
文档备案控制台
官方文档
首页

DescribeDesktops - 查询云电脑详细信息

更新时间：
复制 MD 格式
产品详情
我的收藏

查询云电脑的详细信息。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:DescribeDesktops

get

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
BusinessChannel

string

否

业务渠道, 取值： Enterprise：企业版 Business：商业版

枚举值：

  • Enterprise :

    企业版

  • AGENTIC_CLOUD_COMPUTER :

    智能体云电脑

  • Business :

    商业版

  • Lincore_team :

    Lincore 团队版

Enterprise
RegionId

string

是

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-hangzhou
GroupId

string

否

云电脑池 ID。

dg-boyczi8enfyc5****
DesktopStatus

string

否

云电脑状态。

枚举值：

  • Stopped :

    已关机

  • Starting :

    启动中

  • Rebuilding :

    重建中

  • Running :

    运行中

  • Stopping :

    停止中

  • Expired :

    已过期

  • Deleted :

    已删除

  • Pending :

    等待中

Running
MaxResults

integer

否

分页查询时每页行数。

  • 最大值：100

  • 默认值：10

10
NextToken

string

否

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

caeba0bbb2be03f84eb48b699f0a4883
UserName

string

否

用户名称。

Alice
DesktopName

string

否

云电脑名称。

DemoComputer01
DirectoryId

string

否

目录 ID。同办公网络 ID。

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

string

否

办公网络 ID。

cn-hangzhou+dir-363353****
OfficeSiteName

string

否

办公网络名称。

default
PolicyGroupId

string

否

云电脑策略 ID。

system-all-enabled-policy
ChargeType

string

否

云电脑的计费方式。

枚举值：

  • PostPaid :

    按量付费 [默认值]

  • PrePaid :

    包年包月

PostPaid
ExpiredTime

string

否

包年包月云电脑的到期时间。 时间格式为 ISO 8601 标准的 UTC 时间：yyyy-MM-ddTHH:mm:ssZ。

2022-12-31T15:59:59Z
ProtocolType

string

否

协议类型。

枚举值：

  • HDX :

    HDX 协议

  • ASP :

    阿里云自研 ASP 协议 [推荐]

ASP
DesktopId

array

否

云电脑 ID。可设置 1~100 个。

ecd-gx2x1dhsmucyy****

string

否

云电脑 ID。

ecd-gx2x1dhsmucyy****
EndUserId

array

否

云电脑的授权用户列表。可设置 1~100 个。

说明

在同一时段内，只有一个用户可以连接和使用该云电脑。

alice

string

否

云电脑的授权用户。

alice
ExcludedEndUserId

array

否

要排除的云电脑授权用户列表。可设置 1~100 个。

andy

string

否

要排除的云电脑授权用户。

andy
FilterDesktopGroup

boolean

否

是否排除池化云电脑（云电脑池中的云电脑）。

枚举值：

  • true :

    排除池化云电脑 [默认值]

  • false :

    不排除池化云电脑

false
ManagementFlag

string

否

管理标识。

枚举值：

  • Migrating :

    迁移中

  • Updating :

    变配中

  • NoFlag :

    无标识

NoFlag
QueryFotaUpdate

boolean

否

是否查询云电脑镜像版本信息。

枚举值：

  • true :

    查询云电脑镜像升级信息

  • false :

    不查询云电脑镜像升级信息 [默认值]

false
Tag

array<object>

否

标签列表。一个标签由一对键值对组成，用于标记资源。您可以使用标签来分组管理云电脑，便于搜索和批量操作，详情参见使用标签管理云电脑。

object

否

标签键值对。可为每台云电脑设置 1~20 个键值对，一个标签键只能对应一个标签值。

Key

string

否

标签键。如果传入Tag，则Key是必填的。不可超过 128 个字符，不能以aliyun或acs:开头，不能包含http://或者https://，也不能仅包含空格。

TestKey
Value

string

否

标签值。不可超过 128 个字符，不能以aliyun或acs:开头，不能包含http://或者https://。

TestValue
SnapshotPolicyId

string

否

快照策略 ID。

sp-hb12mclyne09xw***
OnlyDesktopGroup

boolean

否

是否只查询池化云电脑（云电脑池中的云电脑）。

true
DesktopGroupId

string

否

云电脑池 ID。如果传入了DesktopId，则忽略该DesktopGroupId；如果DesktopId为空，则会根据DesktopGroupId去获取该云电脑池内所有云电脑的DesktopId。

dg-2i8qxpv6t1a03****
OsTypes

array

否

操作系统类型。

string

否

操作系统类型。

枚举值：

  • Linux :

    Linux

  • Windows :

    Windows

Windows
DesktopType

string

否

云电脑规格。您可以调用 DescribeDesktopTypes 查询云电脑支持的规格 ID。

eds.general.2c8g
ImageId

array

否

镜像 ID 列表。

string

否

镜像 ID。

m-2g65ljy3ynrdq****
DesktopStatusList

array

否

云电脑状态列表。

string

否

云电脑状态。

枚举值：

  • Stopped :

    已关机

  • Starting :

    启动中

  • Rebuilding :

    重建中

  • Running :

    运行中

  • Stopping :

    停止中

  • Expired :

    已过期

  • Deleted :

    已删除

  • Pending :

    等待中

Stopped
GpuInstanceGroupId

string

否

弹性显卡池 ID。

gp-0bm2iz1v6m6nx****
QosRuleId

string

否

公网限速规则 ID。

qos-5605u0gelk200****
SubPayType

string

否

云电脑购买方式。

枚举值：

  • duration :

    时长包 [白名单]

  • postPaid :

    按需购买

  • monthPackage :

    按月购买（120 小时/250 小时）

  • prePaid :

    按月购买（不限时长）

monthPackage
ResourceGroupId

string

否

企业资源组 ID。

rg-4hsvzbbmqdzu3s****
FillResourceGroup

boolean

否

是否查询企业资源组信息。

true
PageNumber

integer

否

分页查询时，当前页的页码。

1
PageSize

integer

否

分页查询时，每页最大行数。

10
MultiResource

boolean

否

是否有多个资源。

false
IncludeAutoSnapshotPolicy

boolean

否

是否在返回结果中包含自动快照策略信息。

返回参数

名称

类型

描述

示例值

object

返回信息集合。

NextToken

string

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

caeba0bbb2be03f84eb48b699f0a4883
RequestId

string

请求 ID。

484256DA-D816-44D2-9D86-B6EE4D5BA78C
TotalCount

integer

云电脑总数量。

1
Desktops

array<object>

云电脑详细信息。

array<object>

云电脑详细信息。

CreationTime

string

云电脑创建时间。时间格式为 ISO 8601 标准（UTC 时间）。

2020-11-06T08:28Z
ChargeType

string

云电脑的计费方式。

枚举值：

  • PostPaid :

    按量付费 [默认值]

  • PrePaid :

    包年包月

PostPaid
DesktopName

string

云电脑名称。

DemoComputer01
PolicyGroupName

string

策略名称。

All enabled policy
SystemDiskSize

integer
说明

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

0
PolicyGroupId

string

云电脑策略 ID。

system-all-enabled-policy
DesktopStatus

string

云电脑状态。

Running
DesktopType

string

云电脑规格。

ecd.basic.large
GpuCount

number

GPU 数量。

1
ProtocolType

string

协议类型。

枚举值：

  • HDX :

    HDX 协议

  • ASP :

    阿里云自研 ASP 协议

ASP
Memory

integer

内存大小。单位：MiB。

4096
GpuSpec

string

GPU 规格。

NVIDIA T4
ImageId

string

镜像 ID。

m-4zfb6zj728hhr****
ImageName

string

变更前镜像名称。

Windows server 2019 Mainland
DirectoryId

string

目录 ID，同办公网络 ID（OfficeSiteId）。

cn-hangzhou+dir-363353****
ManagementFlag

string

管理标识。

枚举值：

  • Migrating :

    迁移中

  • Updating :

    变配中

  • NoFlag :

    无标识

NoFlag
DataDiskCategory

string
说明

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

cloud_auto
SystemDiskCategory

string
说明

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

cloud_auto
NetworkInterfaceId

string

云电脑服务在 RAM 或 AD 用户下创建的辅助网卡 ID，不可修改。

123456
OfficeSiteId

string

办公网络 ID。

cn-hangzhou+dir-363353****
DataDiskSize

string
说明

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

80
DesktopGroupId

string

云电脑所属的云电脑池 ID。默认为null。

dg-2i8qxpv6t1a03****
DesktopId

string

云电脑 ID。

ecd-gx2x1dhsmucyy****
OfficeSiteName

string

办公网络名称。

default
StartTime

string

云电脑首次启动时间。时间格式为 ISO 8601 标准（UTC 时间）。

2020-11-06T08:31Z
DirectoryType

string
说明

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

SIMPLE
Cpu

integer

vCPU 数量。

2
NetworkInterfaceIp

string

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

192.168.XX.XX
ExpiredTime

string

包年包月云电脑的到期时间。时间格式为 ISO 8601 标准（UTC 时间）。

2021-12-31T15:59Z
OsType

string

操作系统类型。

Windows
ConnectionStatus

string

用户的连接状态。

枚举值：

  • Unknown :

    未知

  • Connected :

    已连接

  • Disconnected :

    已断开连接

Disconnected
BundleId

string

云电脑使用的云电脑模板 ID。

b-2g65ljy4291vl****
BundleName

string

云电脑使用的云电脑模板名称。

TemplateName
OfficeSiteType

string

办公网络的账号系统类型。

枚举值：

  • SIMPLE :

    便捷账号

  • AD_CONNECTOR :

    企业 AD 账号

SIMPLE
HostName

string

主机名称。

testName
Disks

array<object>

磁盘信息。

object

磁盘信息。

DiskType

string

磁盘类型。

枚举值：

  • SYSTEM :

    系统盘

  • DATA :

    数据盘

SYSTEM
DiskId

string

磁盘 ID。

d-jedbpr4sl9l37****
DiskSize

integer

磁盘大小。单位：GiB。

80
PerformanceLevel

string

当磁盘采用 ESSD 云盘时，ESSD 云盘的性能等级。

关于各性能等级磁盘的差异，请参见 ESSD 云盘。

枚举值：

  • PL1 :

    PL1

  • PL0 :

    PL0

  • PL3 :

    PL3

  • PL2 :

    PL2

PL0
DiskCategory

string

磁盘类型。

  • cloud_efficiency（高效云盘）

    • cloud_auto（极速云盘）

    • cloud_essd（增强型 SSD 云盘，仅部分规格支持）

枚举值：

  • cloud_efficiency :

    高效云盘

  • cloud_auto :

    极速云盘

  • cloud_essd :

    增强型 SSD 云盘，仅部分规格支持

cloud_auto
Tags

array<object>

标签信息。

object

标签信息。

Key

string

标签键。

TestKey
Value

string

标签值。

TestValue
Sessions

array<object>

云电脑用户会话信息。

object

云电脑用户会话信息。

EndUserId

string

连接云电脑的用户 ID。

29615820929547****
EstablishmentTime

string

云电脑会话连接的时间。时间格式为 ISO 8601 标准（UTC 时间）。

2021-03-07T08:23Z
ExternalUserName

string

外部用户名称。

Testname
EndUserIds

array

云电脑的授权用户 ID。

string

云电脑的授权用户 ID。

alice
DowngradeQuota

integer

可以降配的次数。

3
DowngradedTimes

integer

已经降配的次数。

0
GpuCategory

integer

是否为 GPU 云电脑。

0
GpuDriverVersion

string

云电脑的 GPU 驱动版本号。

471.68
ZoneType

string

查询可用区的类型。默认取值为AvailabilityZone，即普通云上可用区。

AvailabilityZone
FotaUpdate

object

云电脑的镜像版本信息。

CurrentAppVersion

string

云电脑当前镜像的版本号。

0.0.0-D-20220102.000000
NewAppVersion

string

云电脑可升级的镜像版本号。

0.0.0-R-20220307.190736
ReleaseNote

string

可升级镜像的版本描述。

测试升级包03-07
Size

integer

可升级的版本安装包大小。单位：KB。

108815097
ReleaseNoteEn

string

可升级的版本英文描述。

What's new
ReleaseNoteJp

string

可升级的版本日文描述。

リリースノート
Progress

string

云电脑的创建进度。

100%
VolumeEncryptionEnabled

boolean

是否开启磁盘加密。

false
VolumeEncryptionKey

string

开启磁盘加密的情况下使用的 KMS 的密钥 ID。可通过 ListKeys 接口获取。

08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
OfficeSiteVpcType

string

办公网络 VPC 类型。

枚举值：

  • standard :

    标准型

  • customized :

    定制型

  • basic :

    基础型

basic
Platform

string

操作系统平台信息。

枚举值：

  • Ubuntu :

    Ubuntu

  • Windows Server 2022 :

    Windows Server 2022

  • UOS :

    UOS

  • CentOS :

    CentOS

  • Windows Server 2019 :

    Windows Server 2019

  • Windows Server 2016 :

    Windows Server 2016

Ubuntu
SessionType

string

会话类型。

枚举值：

  • SINGLE_SESSION :

    单会话

  • MULTIPLE_SESSION :

    多会话

SINGLE_SESSION
ManagementFlags

array

管理标识。

string

云电脑管理状态。

枚举值：

  • Migrating :

    办公网络迁移中

  • Hibernated :

    已休眠

  • UnderMaintenance :

    维护模式中

  • MigratingProtocol :

    协议迁移中

  • EnterMaintenance :

    进入维护模式中

  • WakingUp :

    唤醒中

  • Updating :

    升级中

  • NoFlag :

    无状态

  • Assigning :

    分配用户中

  • Hibernating :

    休眠中

["NoFlag"]
SnapshotPolicyId

string

快照策略 ID。

sp-gi007jgyc3kce****
SnapshotPolicyName

string

快照策略名称。

testSnapshotName
BindAmount

integer

多会话云电脑池中，每台云电脑允许的并发会话数。

2
PolicyGroupIdList

array

云电脑策略 ID 集合。

string

云电脑策略 ID。

pg-dasffjkdf*****
PolicyGroupNameList

array

云电脑策略名称列表。

string

云电脑策略名称。

测试策略01
HibernationOptionsConfigured

boolean
说明

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

true
SupportHibernation

boolean

是否支持休眠。

true
HibernationBeta

boolean
说明

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

true
DesktopDurationList

array<object>

云电脑的时长包信息列表。

object

PackageId

string

云企业网实例绑定的带宽包 ID。

cenbwp-4c2zaavbvh5f42****
PackageCreationTime

string

时长包的创建时间。时间格式为 ISO 8601 标准（UTC 时间）。

2024-01-15T08:00Z
PackageExpiredTime

string

时长包的到期时间。时间格式为 ISO 8601 标准（UTC 时间）。

2024-07-15T08:00Z
UsedDuration

integer

时长包已使用的时长。

30
TotalDuration

integer

时长包的总时长。

120
PackageStatus

string

时长包的状态。

Normal
PackageType

string

时长包的类型。

duration
PeriodStartTime

string

时长包计费周期的开始时间。时间格式为 ISO 8601 标准（UTC 时间）。

2024-01-01T00:00Z
PeriodEndTime

string

时长包计费周期的结束时间。时间格式为 ISO 8601 标准（UTC 时间）。

2024-02-01T00:00Z
PostPaidLimitFee

number

按量付费的封顶金额。单位：元。

100.0
PackageUsedUpStrategy

string

时长包用尽后的处理策略。

PostPaid
OrderInstanceId

string

订单实例 ID。

ord-9c3d2e****
ResourceGroups

array<object>

企业资源组信息列表。

object

企业资源组信息。

Name

string

企业资源组名称。

资源组01
Id

string

企业资源组 ID。

rg-4hsvzbbmqdzu3s****
StandardStartTime

string

查询的开始时间。按照 ISO 8601 标准表示，并使用 UTC+0 时间，格式为yyyy-mm-ddthh:mm:ssz。

2025-01-27T02:20:10Z
OsUpdate

object

云电脑操作系统更新信息。

CheckId

string

健康检查任务的 ID。

ck-8f2a1b****
PackageCount

integer

待更新补丁包的数量。

3
Packages

array<object>

系统补丁包列表。

object

Kb

string

系统补丁的 KB 编号。

KB5032190
Title

string

漏洞名称。

2021-适用于 Windows Server 2019 的 05 服务堆栈更新，适合基于 x64 的系统 (KB5003243)
Description

string

NAS 文件系统描述。

newDescription
IsLdap

boolean

是否为 LDAP 目录。

DomainType

string

云电脑所属目录的域类型。

AD
SerialNumber

string

终端序列号

96c530bc-6095-4014-8bbc-d461b8ac****
AccountType

string

账号类型

SIMPLE
EntraDomainName

string

Microsoft Entra ID 的域名。

contoso.onmicrosoft.com
EnvType

string

环境类型，不对外开放。

Private
EnvId

string

环境 ID，不对外开放。

adifa****
AgentProviderList

array

当前云电脑支持的 Agent 列表。

string

当前云电脑支持的 Agent。

Wuying
SubnetId

string

子网 ID。

vsw-dgea1*****
PageNumber

integer

分页查询时，当前页的页码。

1
PageSize

integer

分页查询时，每页最大行数。

10

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "484256DA-D816-44D2-9D86-B6EE4D5BA78C",
  "TotalCount": 1,
  "Desktops": [
    {
      "CreationTime": "2020-11-06T08:28Z",
      "ChargeType": "PostPaid",
      "DesktopName": "DemoComputer01",
      "PolicyGroupName": "All enabled policy",
      "SystemDiskSize": 0,
      "PolicyGroupId": "system-all-enabled-policy",
      "DesktopStatus": "Running",
      "DesktopType": "ecd.basic.large",
      "GpuCount": 1,
      "ProtocolType": "ASP",
      "Memory": 4096,
      "GpuSpec": "NVIDIA T4",
      "ImageId": "m-4zfb6zj728hhr****",
      "ImageName": "Windows server 2019 Mainland",
      "DirectoryId": "cn-hangzhou+dir-363353****",
      "ManagementFlag": "NoFlag",
      "DataDiskCategory": "cloud_auto",
      "SystemDiskCategory": "cloud_auto",
      "NetworkInterfaceId": "123456",
      "OfficeSiteId": "cn-hangzhou+dir-363353****",
      "DataDiskSize": "80",
      "DesktopGroupId": "dg-2i8qxpv6t1a03****",
      "DesktopId": "ecd-gx2x1dhsmucyy****",
      "OfficeSiteName": "default",
      "StartTime": "2020-11-06T08:31Z",
      "DirectoryType": "SIMPLE",
      "Cpu": 2,
      "NetworkInterfaceIp": "192.168.XX.XX",
      "ExpiredTime": "2021-12-31T15:59Z",
      "OsType": "Windows",
      "ConnectionStatus": "Disconnected",
      "BundleId": "b-2g65ljy4291vl****",
      "BundleName": "TemplateName",
      "OfficeSiteType": "SIMPLE",
      "HostName": "testName",
      "Disks": [
        {
          "DiskType": "SYSTEM",
          "DiskId": "d-jedbpr4sl9l37****",
          "DiskSize": 80,
          "PerformanceLevel": "PL0",
          "DiskCategory": "cloud_auto"
        }
      ],
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "Sessions": [
        {
          "EndUserId": "29615820929547****",
          "EstablishmentTime": "2021-03-07T08:23Z",
          "ExternalUserName": "Testname"
        }
      ],
      "EndUserIds": [
        "alice"
      ],
      "DowngradeQuota": 3,
      "DowngradedTimes": 0,
      "GpuCategory": 0,
      "GpuDriverVersion": "471.68",
      "ZoneType": "AvailabilityZone",
      "FotaUpdate": {
        "CurrentAppVersion": "0.0.0-D-20220102.000000",
        "NewAppVersion": "0.0.0-R-20220307.190736",
        "ReleaseNote": "测试升级包03-07",
        "Size": 108815097,
        "ReleaseNoteEn": "What's new",
        "ReleaseNoteJp": "リリースノート"
      },
      "Progress": "100%",
      "VolumeEncryptionEnabled": false,
      "VolumeEncryptionKey": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
      "OfficeSiteVpcType": "basic",
      "Platform": "Ubuntu",
      "SessionType": "SINGLE_SESSION",
      "ManagementFlags": [
        "[\"NoFlag\"]"
      ],
      "SnapshotPolicyId": "sp-gi007jgyc3kce****",
      "SnapshotPolicyName": "testSnapshotName",
      "BindAmount": 2,
      "PolicyGroupIdList": [
        "pg-dasffjkdf*****"
      ],
      "PolicyGroupNameList": [
        "测试策略01"
      ],
      "HibernationOptionsConfigured": true,
      "SupportHibernation": true,
      "HibernationBeta": true,
      "DesktopDurationList": [
        {
          "PackageId": "cenbwp-4c2zaavbvh5f42****",
          "PackageCreationTime": "2024-01-15T08:00Z",
          "PackageExpiredTime": "2024-07-15T08:00Z",
          "UsedDuration": 30,
          "TotalDuration": 120,
          "PackageStatus": "Normal",
          "PackageType": "duration",
          "PeriodStartTime": "2024-01-01T00:00Z",
          "PeriodEndTime": "2024-02-01T00:00Z",
          "PostPaidLimitFee": 100,
          "PackageUsedUpStrategy": "PostPaid",
          "OrderInstanceId": "ord-9c3d2e****"
        }
      ],
      "ResourceGroups": [
        {
          "Name": "资源组01",
          "Id": "rg-4hsvzbbmqdzu3s****"
        }
      ],
      "StandardStartTime": "2025-01-27T02:20:10Z",
      "OsUpdate": {
        "CheckId": "ck-8f2a1b****",
        "PackageCount": 3,
        "Packages": [
          {
            "Kb": "KB5032190",
            "Title": "2021-适用于 Windows Server 2019 的 05 服务堆栈更新，适合基于 x64 的系统 (KB5003243)",
            "Description": "newDescription"
          }
        ]
      },
      "IsLdap": true,
      "DomainType": "AD",
      "SerialNumber": "96c530bc-6095-4014-8bbc-d461b8ac****",
      "AccountType": "SIMPLE",
      "EntraDomainName": "contoso.onmicrosoft.com",
      "EnvType": "Private",
      "EnvId": "adifa****",
      "AgentProviderList": [
        "Wuying"
      ],
      "SubnetId": "vsw-dgea1*****"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10
}

错误码

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

变更历史

更多信息，参考变更详情。

上一篇：DescribeDesktopInfo - 查询云电脑基础信息下一篇：DescribeDesktopTypes - 查询云电脑规格详细信息