备案控制台
文档
产品文档
输入文档关键字查找
首页 无影云电脑 无影云电脑（专业版） 开发参考 API参考（云桌面管控） API目录 云电脑 云电脑资源 DescribeDesktops - 查询云电脑详细信息

DescribeDesktops - 查询云电脑详细信息

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

查询云电脑的详细信息。

调试

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

授权信息

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

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecd:DescribeDesktopsRead
  • 全部资源
    *
    无
无

请求参数

名称类型必填描述示例值
RegionIdstring是

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

cn-hangzhou
GroupIdstring否

云电脑池 ID。

dg-boyczi8enfyc5****
DesktopStatusstring否

云电脑状态。

枚举值：
  • Stopped：已关机。
  • Starting：启动中。
  • Rebuilding：重建中。
  • Running：运行中。
  • Stopping：停止中。
  • Expired：已过期。
  • Deleted：已删除。
  • Pending：等待中。
Running
MaxResultsinteger否

分页查询时每页行数。

  • 最大值：100
  • 默认值：10
10
NextTokenstring否

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

caeba0bbb2be03f84eb48b699f0a4883
UserNamestring否

用户名称。

Alice
DesktopNamestring否

云电脑名称。

DemoComputer01
DirectoryIdstring否

目录 ID。同办公网络 ID。

cn-hangzhou+dir-363353****
OfficeSiteIdstring否

办公网络 ID。

cn-hangzhou+dir-363353****
OfficeSiteNamestring否

办公网络名称。

default
PolicyGroupIdstring否

策略 ID。

system-all-enabled-policy
ChargeTypestring否

云电脑的计费方式。

枚举值：
  • PostPaid：按量付费 [默认值]。
  • PrePaid：包年包月。
PostPaid
ExpiredTimestring否

包年包月云电脑的到期时间。

2022-12-31T15:59:59Z
ProtocolTypestring否

协议类型。

枚举值：
  • HDX：HDX协议。
  • ASP：阿里云自研ASP协议 [推荐]。
ASP
DesktopIdarray否

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

string否

云电脑 ID。

ecd-gx2x1dhsmucyy****
EndUserIdarray否

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

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

云电脑的授权用户。

alice
ExcludedEndUserIdarray否

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

string否

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

andy
FilterDesktopGroupboolean否

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

枚举值：
  • true：排除池化云电脑 [默认值]。
  • false：不排除池化云电脑。
false
ManagementFlagstring否

管理标识。

枚举值：
  • Migrating：迁移中。
  • Updating：变配中。
  • NoFlag：无标识。
NoFlag
QueryFotaUpdateboolean否

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

枚举值：
  • true：查询云电脑镜像升级信息。
  • false：不查询云电脑镜像升级信息 [默认值]。
false
Tagobject []否

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

Keystring否

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

TestKey
Valuestring否

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

TestValue
SnapshotPolicyIdstring否

快照策略 ID。

sp-hb12mclyne09xw***
OnlyDesktopGroupboolean否

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

true
DesktopGroupIdstring否

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

dg-2i8qxpv6t1a03****
OsTypesarray否

操作系统类型。

string否

操作系统类型。

枚举值：
  • Linux：Linux。
  • Windows：Windows。
Windows
DesktopTypestring否

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

eds.general.2c8g
ImageIdarray否

镜像 ID 列表。

string否

镜像 ID。

m-2g65ljy3ynrdq****
DesktopStatusListarray否

云电脑状态列表。

string否

云电脑状态。

枚举值：
  • Stopped：已关机。
  • Starting：启动中。
  • Rebuilding：重建中。
  • Running：运行中。
  • Stopping：停止中。
  • Expired：已过期。
  • Deleted：已删除。
  • Pending：等待中。
Stopped

返回参数

名称类型描述示例值
object

返回信息集合。

NextTokenstring

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

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求 ID。

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

云电脑总数量。

1
Desktopsobject []

云电脑详细信息。

CreationTimestring

云电脑创建时间。

2020-11-06T08:28Z
ChargeTypestring

云电脑的计费方式。

枚举值：
  • PostPaid：按量付费 [默认值]。
  • PrePaid：包年包月。
PostPaid
DesktopNamestring

云电脑名称。

DemoComputer01
PolicyGroupNamestring

策略名称。

All enabled policy
SystemDiskSizeinteger
说明 该参数正在邀测中，暂未开放使用。
0
PolicyGroupIdstring

策略 ID。

system-all-enabled-policy
DesktopStatusstring

云电脑状态。

Running
DesktopTypestring

云电脑规格。

ecd.basic.large
GpuCountfloat

GPU 数量。

1
ProtocolTypestring

协议类型。

枚举值：
  • HDX：HDX协议。
  • ASP：阿里云自研ASP协议。
ASP
Memorylong

内存大小。单位：MiB。

4096
GpuSpecstring

GPU 规格。

NVIDIA T4
ImageIdstring

镜像 ID。

m-4zfb6zj728hhr****
DirectoryIdstring

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

cn-hangzhou+dir-363353****
ManagementFlagstring

管理标识。

枚举值：
  • Migrating：迁移中。
  • Updating：变配中。
  • NoFlag：无标识。
NoFlag
DataDiskCategorystring
说明 该参数正在邀测中，暂未开放使用。
null
SystemDiskCategorystring
说明 该参数正在邀测中，暂未开放使用。
null
NetworkInterfaceIdstring

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

123456
OfficeSiteIdstring

办公网络 ID。

cn-hangzhou+dir-363353****
DataDiskSizestring
说明 该参数正在邀测中，暂未开放使用。
null
DesktopGroupIdstring

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

null
DesktopIdstring

云电脑 ID。

ecd-gx2x1dhsmucyy****
OfficeSiteNamestring

办公网络名称。

default
StartTimestring

云电脑首次启动时间。

2020-11-06T08:31Z
DirectoryTypestring
说明 该参数正在邀测中，暂未开放使用。
SIMPLE
Cpuinteger

vCPU 数量。

2
NetworkInterfaceIpstring

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

192.168.XX.XX
ExpiredTimestring

包年包月云电脑的到期时间。

2021-12-31T15:59Z
OsTypestring

操作系统类型。

Windows
ConnectionStatusstring

用户的连接状态。

枚举值：
  • Unknown：未知。
  • Connected：已连接。
  • Disconnected：已断开连接。
Disconnected
BundleIdstring

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

b-2g65ljy4291vl****
BundleNamestring

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

TemplateName
OfficeSiteTypestring

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

枚举值：
  • SIMPLE：便捷账号。
  • AD_CONNECTOR：企业AD账号。
SIMPLE
HostNamestring

主机名称。

testName
Disksobject []

磁盘信息。

DiskTypestring

磁盘类型。

枚举值：
  • SYSTEM：系统盘。
  • DATA：数据盘。
SYSTEM
DiskIdstring

磁盘 ID。

d-jedbpr4sl9l37****
DiskSizeinteger

磁盘大小。单位：GiB。

80
PerformanceLevelstring

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

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

枚举值：
  • PL1：PL1。
  • PL0：PL0。
  • PL3：PL3。
  • PL2：PL2。
PL0
Tagsobject []

标签信息。

Keystring

标签键。

TestKey
Valuestring

标签值。

TestValue
Sessionsobject []

云电脑用户会话信息。

EndUserIdstring

连接云电脑的用户 ID。

29615820929547****
EstablishmentTimestring

云电脑会话连接的时间。

2021-03-07T08:23Z
ExternalUserNamestring

外部用户名称。

Testname
EndUserIdsarray

云电脑的授权用户 ID。

string

云电脑的授权用户 ID。

alice
DowngradeQuotalong

可以降配的次数。

3
DowngradedTimeslong

已经降配的次数。

0
GpuCategorylong

是否为 GPU 云电脑。

0
GpuDriverVersionstring

云电脑的 GPU 驱动版本号。

null
ZoneTypestring

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

AvailabilityZone
FotaUpdateobject

云电脑的镜像版本信息。

CurrentAppVersionstring

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

0.0.0-D-20220102.000000
NewAppVersionstring

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

0.0.0-R-20220307.190736
ReleaseNotestring

可升级镜像的版本描述。

测试升级包03-07
Sizelong

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

108815097
ReleaseNoteEnstring

可升级的版本英文描述。

What's new
ReleaseNoteJpstring

可升级的版本日文描述。

リリースノート
Progressstring

云电脑的创建进度。

100%
VolumeEncryptionEnabledboolean

是否开启磁盘加密。

false
VolumeEncryptionKeystring

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

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

办公网络 VPC 类型。

枚举值：
  • standard：标准型。
  • customized：定制型。
  • basic：基础型。
basic
Platformstring

操作系统平台信息。

枚举值：
  • 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
SessionTypestring

会话类型。

枚举值：
  • SINGLE_SESSION：单会话。
  • MULTIPLE_SESSION：多会话。
SINGLE_SESSION
ManagementFlagsarray

管理标识。

string

云电脑管理状态。

枚举值：
  • Migrating：办公网络迁移中。
  • Hibernated：已休眠。
  • UnderMaintenance：维护模式中。
  • MigratingProtocol：协议迁移中。
  • EnterMaintenance：进入维护模式中。
  • WakingUp：唤醒中。
  • Updating：升级中。
  • NoFlag：无状态。
  • Assigning：分配用户中。
  • Hibernating：休眠中。
["NoFlag"]
SnapshotPolicyIdstring

快照策略 ID。

sp-gi007jgyc3kcey2bb
SnapshotPolicyNamestring

快照策略名称。

testSnapshotName
BindAmountinteger

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

2
PolicyGroupIdListarray

策略 ID 集合。

string

策略 ID。

pg-dasffjkdf*****
PolicyGroupNameListarray

策略名称集合。

string

策略名称。

测试策略01
HibernationOptionsConfiguredboolean
说明 该参数正在邀测中，暂未开放使用。
true
SupportHibernationboolean

是否支持休眠。

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

示例

正常返回示例

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****",
      "DirectoryId": "cn-hangzhou+dir-363353****",
      "ManagementFlag": "NoFlag",
      "DataDiskCategory": "null",
      "SystemDiskCategory": "null",
      "NetworkInterfaceId": "123456",
      "OfficeSiteId": "cn-hangzhou+dir-363353****",
      "DataDiskSize": "null",
      "DesktopGroupId": "null",
      "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"
        }
      ],
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "Sessions": [
        {
          "EndUserId": "29615820929547****",
          "EstablishmentTime": "2021-03-07T08:23Z",
          "ExternalUserName": "Testname"
        }
      ],
      "EndUserIds": [
        "alice"
      ],
      "DowngradeQuota": 3,
      "DowngradedTimes": 0,
      "GpuCategory": 0,
      "GpuDriverVersion": "null",
      "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-gi007jgyc3kcey2bb",
      "SnapshotPolicyName": "testSnapshotName",
      "BindAmount": 2,
      "PolicyGroupIdList": [
        "pg-dasffjkdf*****"
      ],
      "PolicyGroupNameList": [
        "测试策略01"
      ],
      "HibernationOptionsConfigured": true,
      "SupportHibernation": true,
      "HibernationBeta": true
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-09-22API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-09-11API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-07-19OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更。
2023-07-03OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更。
2023-05-18OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更。
2023-05-06OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更。
    新增入参：DesktopStatusList
出参OpenAPI 返回结构发生变更。
2023-03-17OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更。
    新增入参：ImageId
2022-08-04API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2022-08-04API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2022-08-04API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2022-08-04API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2022-08-04API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2022-08-04API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2022-07-07OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更。
    新增入参：Tag
2022-01-20OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更。
2022-01-20OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更。
2021-12-22OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更。
2021-09-26OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更。
    新增入参：DesktopGroupId
文档推荐
  • 本页导读 （0）
文档反馈