查询云电脑的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecd:DescribeDesktops | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 | cn-hangzhou |
| GroupId | string | 否 | 云电脑池 ID。 | dg-boyczi8enfyc5**** |
| DesktopStatus | string | 否 | 云电脑状态。 枚举值：
| Running |
| MaxResults | integer | 否 | 分页查询时每页行数。
| 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 |
| ExpiredTime | string | 否 | 包年包月云电脑的到期时间。 | 2022-12-31T15:59:59Z |
| ProtocolType | string | 否 | 协议类型。 枚举值：
| ASP |
| DesktopId | array | 否 | 云电脑 ID。可设置 1~100 个。 | |
| string | 否 | 云电脑 ID。 | ecd-gx2x1dhsmucyy**** | |
| EndUserId | array | 否 | 云电脑的授权用户列表。可设置 1~100 个。 说明
在同一时段内，只有一个用户可以连接和使用该云电脑。
| |
| string | 否 | 云电脑的授权用户。 | alice | |
| ExcludedEndUserId | array | 否 | 要排除的云电脑授权用户列表。可设置 1~100 个。 | |
| string | 否 | 要排除的云电脑授权用户。 | andy | |
| FilterDesktopGroup | boolean | 否 | 是否排除池化云电脑（云电脑池中的云电脑）。 枚举值：
| false |
| ManagementFlag | string | 否 | 管理标识。 枚举值：
| NoFlag |
| QueryFotaUpdate | boolean | 否 | 是否查询云电脑镜像版本信息。 枚举值：
| false |
| Tag | array<object> | 否 | 标签列表。一个标签由一对键值对组成，用于标记资源。您可以使用标签来分组管理云电脑，便于搜索和批量操作，详情参见使用标签管理云电脑。 | |
| object | 否 | 标签键值对。可为每台云电脑设置 1~20 个键值对，一个标签键只能对应一个标签值。 | ||
| Key | string | 否 | 标签键。如果传入 | TestKey |
| Value | string | 否 | 标签值。不可超过 128 个字符，不能以 | TestValue |
| SnapshotPolicyId | string | 否 | 快照策略 ID。 | sp-hb12mclyne09xw*** |
| OnlyDesktopGroup | boolean | 否 | 是否只查询池化云电脑（云电脑池中的云电脑）。 | true |
| DesktopGroupId | string | 否 | 云电脑池 ID。如果传入了 | dg-2i8qxpv6t1a03**** |
| OsTypes | array | 否 | 操作系统类型。 | |
| string | 否 | 操作系统类型。 枚举值：
| Windows | |
| DesktopType | string | 否 | 云电脑规格。您可以调用 DescribeDesktopTypes 查询云电脑支持的规格 ID。 | eds.general.2c8g |
| ImageId | array | 否 | 镜像 ID 列表。 | |
| string | 否 | 镜像 ID。 | m-2g65ljy3ynrdq**** | |
| DesktopStatusList | array | 否 | 云电脑状态列表。 | |
| string | 否 | 云电脑状态。 枚举值：
| Stopped | |
| GpuInstanceGroupId | string | 否 | 弹性显卡池 ID。 | gp-0bm2iz1v6m6nx**** |
| QosRuleId | string | 否 | 公网限速规则 ID。 | qos-5605u0gelk200**** |
| SubPayType | string | 否 | 云电脑购买方式。 枚举值：
| monthPackage |
| ResourceGroupId | string | 否 | 企业资源组 ID。 | rg-4hsvzbbmqdzu3s**** |
| FillResourceGroup | boolean | 否 | 是否查询企业资源组信息。 | true |
| PageNumber | integer | 否 | 分页查询时，当前页的页码。 | 1 |
| PageSize | integer | 否 | 分页查询时，每页最大行数。 | 10 |
| MultiResource | boolean | 否 | 是否有多个资源。 | false |
返回参数
示例
正常返回示例
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",
"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": 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-gi007jgyc3kce****",
"SnapshotPolicyName": "testSnapshotName",
"BindAmount": 2,
"PolicyGroupIdList": [
"pg-dasffjkdf*****"
],
"PolicyGroupNameList": [
"测试策略01"
],
"HibernationOptionsConfigured": true,
"SupportHibernation": true,
"HibernationBeta": true,
"DesktopDurationList": [
{
"PackageId": "",
"PackageCreationTime": "",
"PackageExpiredTime": "",
"UsedDuration": 0,
"TotalDuration": 0,
"PackageStatus": "",
"PackageType": "",
"PeriodStartTime": "",
"PeriodEndTime": "",
"PostPaidLimitFee": 0,
"PackageUsedUpStrategy": "",
"OrderInstanceId": ""
}
],
"ResourceGroups": [
{
"Name": "资源组01",
"Id": "rg-4hsvzbbmqdzu3s****"
}
],
"StandardStartTime": "",
"OsUpdate": {
"CheckId": "",
"PackageCount": 0,
"Packages": [
{
"Kb": "",
"Title": "",
"Description": ""
}
]
},
"IsLdap": true,
"DomainType": "",
"SerialNumber": "",
"AccountType": "",
"EntraDomainName": ""
}
],
"PageNumber": 1,
"PageSize": 10
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-10-24 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2025-04-09 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2025-03-18 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2025-02-17 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2025-01-24 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2024-10-29 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-07-04 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-06-17 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-09-22 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2023-09-11 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2023-07-19 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-07-03 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-05-18 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-05-06 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-03-17 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2022-08-04 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2022-08-04 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2022-08-04 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2022-08-04 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2022-08-04 | API 内部配置变更，不影响调用 | 查看变更详情 |