查询多个地域的云电脑详细信息。目前仅支持中国内地对应的地域查询（不包含南京本地地域）。
接口说明
- 此接口为中心化域名，接入点为上海，不支持其他区域调用。
- 此接口中的桌面状态信息与实际值有 1~3 秒延迟。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。 | cn-shanghai |
| DirectoryId | string | 否 | 工作区 ID。同 OfficeSiteId。 | cn-hangzhou+dir-880841**** |
| OfficeSiteId | string | 否 | 工作区 ID。DirectoryId 即将弃用，优先使用此字段。 | cn-hangzhou+dir-880841**** |
| ClientId | string | 是 | 客户端生成的唯一 ID。 | c213150d-7ac3-432c-b749-6e1e090b**** |
| SessionId | string | 是 | 会话 ID。 通过登录接口 GetLoginToken 获取，返回参数：SessionId。 | 5c456a41-1e65-4e72-ab4d-5dcfff52**** |
| LoginToken | string | 是 | 登录凭证。 通过 GetLoginToken 接口登录获取，或登录后通过更新接口 RefreshLoginToken 获取。返回参数：LoginToken。 | v147c9114a180489f89691663893169**** |
| DesktopStatus | string | 否 | 云桌面状态。取值范围：
| Running |
| MaxResults | integer | 否 | 分页查询时每页行数。
| 500 |
| NextToken | string | 否 | 下一个查询开始的 Token，NextToken 为空表示没有下一个。 | eyJkZWZhdWx0IjpbIjk2MjEy**** |
| DesktopName | string | 否 | 云桌面名称。 | DesktopTest |
| DesktopId | array | 否 | 云桌面 ID。可设置一个或多个，取值范围：1~20。 | |
| string | 否 | 云桌面 ID。 | ecd-hkbl45il187d6**** | |
| SearchRegionId | string | 否 | 搜索地域 ID。用于过滤出指定地域的桌面信息。 | cn-shanghai |
| DesktopAccessType | string | 否 | 连接云桌面时允许使用的接入方式。取值范围：
默认值：INTERNET。 说明
VPC 连接方式依赖于阿里云私网连接（PrivateLink）服务，该服务不收取费用。该参数设置为 VPC 或者 Any 时，系统将自动为您开通私网连接服务。
| INTERNET |
| QueryFotaUpdate | boolean | 否 | 是否查询镜像更新信息。 | true |
| WithoutLatency | boolean | 否 | 是否查询实时桌面信息。当前接口中桌面状态信息有 1~3 秒延迟，如果需要准确信息可将此值设为 true。 | true |
| OrderBy | string | 否 | 排序字段，若不指定则按照创建时间倒序。取值为 AssignTime：按照分配时间排序。 | AssignTime |
| SortType | string | 否 | 排序方式，默认为增序。取值：
| ASC |
| Keyword | string | 否 | 关键字。支持模糊搜索桌面 ID、云桌面名称和终端用户自定义的桌面名称。 | ecd |
| LoginRegionId | string | 否 | 工作区所在的地域 ID，使用组织 ID 登录时置为空。使用工作区 ID 登录时，该参数必填，使用组织 ID 登录时，该参数可为空。 | cn-hangzhou |
返回参数
示例
正常返回示例
JSON格式
{
"NextToken": "eyJkZWZhdWx0IjpbIjIwMjItMDgtMTdUM****",
"RequestId": "4686A731-D601-548C-83E2-4CB6371E****",
"Desktops": [
{
"CreationTime": "2020-11-06T08:28Z",
"ChargeType": "PostPaid",
"DesktopName": "testDesktopName",
"HostName": "testName",
"DesktopGroupId": "dg-3uiojcc0j4kh7****",
"DesktopId": "ecd-gx2x1dhsmucyy****",
"RegionId": "cn-hangzhou",
"LastStartTime": "2021-07-13T15:59Z",
"Cpu": 2,
"EndUserId": "User1",
"ExpiredTime": "2021-12-31T15:59Z",
"DesktopStatus": "Running",
"DesktopType": "ecd.basic.large",
"ConnectionStatus": "Disconnected",
"Memory": 4096,
"ImageId": "m-4zfb6zj728hhr****",
"DirectoryId": "cn-hangzhou+dir-jedbpr4sl9l37****\t",
"Disks": [
{
"DiskType": "SYSTEM",
"DiskId": "d-jedbpr4sl9l37****",
"DiskSize": 80
}
],
"OsType": "Windows",
"Sessions": [
{
"EndUserId": "User1",
"EstablishmentTime": "2021-03-07T08:23Z"
}
],
"PolicyGroupId": "pg-9cktlowtxfl6****",
"EndUserIds": [
"User1"
],
"GpuMemory": 2048,
"FotaUpdate": {
"Project": "testProject",
"Channel": "Enterprise",
"CurrentAppVersion": "0.0.0-D-20220102.xxxx",
"NewAppVersion": "0.0.0-R-20220307.xxxx",
"Force": false,
"ReleaseNote": "测试升级包03-07",
"Size": "100",
"ReleaseNoteEn": "Release note",
"ReleaseNoteJp": "リリースノート",
"NewDcdVersion": ""
},
"ProtocolType": "ASP",
"OfficeSiteId": "cn-hangzhou+dir-363353****",
"NetworkInterfaceIp": "192.168.xx.xx",
"UserCustomName": "testDesktop",
"ManagementFlags": [
"UPDATING"
],
"LocalName": "（华东2）上海",
"RealDesktopId": "ecd-gx2x1dhsm****",
"DesktopTimers": [
{
"TimerType": "NoConnectShutdown",
"CronExpression": "0 0 0 ? * 1",
"Interval": 60,
"Enforce": false,
"ResetType": "RESET_TYPE_BOTH",
"AllowClientSetting": true,
"OperationType": "SHUTDOWN",
"ExecutionTime": "2021-12-31T15:59Z"
}
],
"Clients": [
{
"Status": "ON",
"ClientType": "windows"
}
],
"SupportHibernation": true,
"HibernationBeta": true,
"SessionType": "SINGLE_SESSION",
"Platform": "Ubuntu",
"Os": "Windows",
"RegionLocation": "",
"OsDescription": ""
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-11-09 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-09-27 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-08-13 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-12-13 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-12-11 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-08-02 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-05-18 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-03-22 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2022-10-18 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |