查询近期所有云电脑的基本信息，及对应的使用时长记录。
接口说明
- 国内站用户查询站点选择上海，国际站用户选择新加坡。
- 默认支持查询已删除和未删除的全部云电脑。
- 已删除的云电脑仅支持查询删除时间在三个月以内的。
- 排序条件不能与其他条件共用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecd:DescribeGlobalDesktopRecords | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。
| cn-shanghai |
| OfficeSiteId | string | 否 | 办公网络 ID。 | cn-hangzhou+dir-363353**** |
| StartTime | string | 否 | 开始时间。支持的格式：
| 2022-03-23T04:10:21Z |
| EndTime | string | 否 | 结束时间。开始时间和结束时间间隔最大为 30 天，支持的格式：
| 2022-08-31T06:56:45Z |
| PageNumber | integer | 否 | 分页查询时，当前页的页码。 | 1 |
| PageSize | integer | 否 | 每页数量。最大值 100。 | 20 |
| DesktopId | array | 否 | 云电脑 ID。可设置 1~100 个。 | |
| string | 否 | 云桌面 ID。 | ecd-gx2x1dhsmucyy**** | |
| DesktopName | string | 否 | 云电脑名称。 | DemoComputer |
| SubPayType | string | 否 | 云电脑购买方式。可选值为：
| monthPackage |
| Scope | string | 否 | 查询范围，默认为空，可选值为：
| ADVANCED |
| OrderBy | string | 否 | 排序字段，若不指定则按照创建时间倒序排列。可选值为：
| uptime |
| SortType | string | 否 | 排序方式，默认为增序。取值：
| Asc |
| EndUserId | string | 否 | 终端用户 ID。 | TestUser |
| DesktopType | string | 否 | 云电脑规格。您可以调用 DescribeDesktopTypes 查询云电脑支持的规格 ID。 | eds.enterprise_office.2c4g |
| ResourceGroupId | string | 否 | 资源组 ID。 | rg-3mtuc28rx95lx**** |
返回参数
示例
正常返回示例
JSON格式
{
"TotalCount": 1,
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"Sessions": [
{
"Platform": "Windows 10",
"StatusChangeTime": 0,
"Memory": 4096,
"DesktopName": "DemoComputer",
"Cpu": 2,
"SubPayType": "monthPackage",
"EndUserId": "TestUser",
"OsType": "Linux",
"SessionIdleTime": 120,
"OfficeSiteName": "TestOfficeSite",
"ConnectionStatus": "Connected",
"Sessions": [
{
"EndUserId": "TestUser",
"EstablishmentTime": "2022-08-31T06:56:45Z"
}
],
"DesktopId": "ecd-g6t1ukbaea****",
"EndUserIds": [
"TestUser"
],
"ResourceGroups": [
{
"ResourceGroupId": "rg-f3s3dgt8dtb0vlqc8",
"ResourceGroupName": "dms_test"
}
],
"OfficeSiteId": "cn-hangzhou+dir-8904****",
"UpTime": 86400,
"ProtocolType": "ASP",
"GpuSpec": "8GiB",
"LatestConnectionTime": 120,
"TotalConnectionTime": 240,
"RegionId": "cn-beijing",
"DesktopGroupId": "dg-iaqu3bi2xtie****",
"DesktopGroupName": "DemoCCGroup",
"DesktopStatus": "Running"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-10-21 | 新增 OpenAPI | 查看变更详情 |