查询云电脑的详细会话信息。
接口说明
当前仅支持查询 30 天以内的数据。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecd:DescribeDesktopSessions | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 | cn-hangzhou |
| OfficeSiteId | string | 否 | 办公网络 ID。 | cn-hangzhou+dir-363353**** |
| EndUserId | string | 否 | 终端用户 ID。 | alice |
| SessionStatus | string | 否 | 会话连接状态。 枚举值：
| Connected |
| StartTime | string | 否 | 查询开始时间。 | 2023-01-28T02:31:43Z |
| EndTime | string | 否 | 查询结束时间。 | 2023-02-13T02:51:43Z |
| PageNumber | integer | 否 | 分页查询时，当前页的页码。 | 1 |
| PageSize | integer | 否 | 分页查询时，每页最大行数。 | 10 |
| DesktopId | array | 否 | 云电脑 ID。可设置 1~100 个。 | |
| string | 否 | 云电脑 ID。 | ecd-gx2x1dhsmucyy****" | |
| DesktopName | string | 否 | 云电脑名称。 | DemoComputer |
| SubPayType | string | 否 | 云电脑购买方式。 枚举值：
| monthPackage |
| CheckOsSession | boolean | 否 | 检查云电脑内会话状态的开关。 | true |
| EndUserIdFilter | string | 否 | 终端用户 ID。与参数 | alice |
返回参数
示例
正常返回示例
JSON格式
{
"TotalCount": 1,
"RequestId": "3EC4A6DB-EC8D-55B0-9038-543DE671****",
"Sessions": [
{
"SessionStatus": "Connected",
"EndUserId": "alice",
"OfficeSiteId": "cn-hangzhou+dir-8904****",
"ClientIp": "172.21.XX.XX",
"ClientOS": "windows_\\\"Windows10Enterprise\\\"10.0(Build22000)",
"DesktopId": "ecd-g6t1ukbaea****",
"DesktopName": "DemoComputer",
"OfficeSiteName": "TestOfficeSite",
"ClientVersion": "2.0.0-R-20221030.08****",
"ProtocolType": "ASP",
"LatestConnectionTime": 120,
"TotalConnectionTime": 240,
"SessionStartTime": "2023-01-28T02:31:43Z\n",
"SessionEndTime": "2023-01-28T02:31:43Z",
"SessionIdleTime": 120,
"OsType": "Windows",
"EndUserApplyCoordinateTime": 120,
"SubPayType": "monthPackage",
"OsSessionStatus": "true"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-12-09 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2024-07-08 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-07-01 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-04-15 | OpenAPI 入参发生变更 | 查看变更详情 |