查询终端用户的操作日志，包括桌面开机、桌面关机、桌面会话断开等事件。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。可以调用 DescribeRegions 获取无影云桌面支持的地域列表。 | cn-hangzhou |
| EndUserId | string | 否 | 登录用户信息，RAM 用户 ID 或 AD 用户名。不指定时，表示查询该地域下所有用户的事件。 | 28961708130834**** |
| DesktopId | string | 否 | 云桌面 ID。不指定时，表示查询该地域下所有云桌面。 | ecd-8fupvkhg0aayu**** |
| DesktopIp | string | 否 | 云桌面的 IP 地址。不指定时，表示查询该地域下所有云桌面的事件。 | 10.10.*.* |
| DirectoryId | string | 否 | 本参数不开放使用。 | To be hidden. |
| OfficeSiteId | string | 否 | 云桌面所属的工作区 ID。不指定时，表示查询该地域下所有工作区下的用户事件。 | cn-hangzhou+dir-bh77qa8nmjot4**** |
| EventType | string | 否 | 要查询的事件类型。当 EventTypes 不为空时，则以 EventTypes 组合类型为查询过滤条件。当 EventTypes 为空，且 EventType 为空，则查询所有事件。 枚举值：
| DESKTOP_DISCONNECT |
| StartTime | string | 否 | 开始时间。按照ISO 8601标准表示，并需要使用 UTC+0 时间，格式为 YYYY-MM-DDThh:mm:ssZ。 | 2020-11-30T06:32:31Z |
| EndTime | string | 否 | 结束时间。按照ISO 8601标准表示，并需要使用 UTC+0 时间，格式为 YYYY-MM-DDThh:mm:ssZ。 | 2020-11-31T06:32:31Z |
| MaxResults | integer | 否 | 分页查询时每页行数。 | 10 |
| NextToken | string | 否 | 查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。 | AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL**** |
| OfficeSiteName | string | 否 | 工作区名称。 | test |
| DesktopName | string | 否 | 云桌面名称。 | test |
| EventTypes | array | 是 | 要查询的事件类型组合，可以多个事件组合，查询结果包含所有组合的事件。 | |
| string | 是 | 要查询的事件类型。 枚举值：
| DESKTOP_START |
返回参数
示例
正常返回示例
JSON格式
{
"NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****",
"RequestId": "28A40F12-F340-442B-A35F-46EF6A03227B",
"Events": [
{
"Status": "200",
"BytesReceived": "8665",
"DesktopIp": "10.10.*.*",
"EventTime": "2020-11-30T06:32:31Z",
"BytesSend": "2345",
"OfficeSiteId": "cn-hangzhou+dir-bh77qa8nmjot4****",
"AliUid": "112259558861****",
"DesktopId": "ecd-8fupvkhg0aayu****",
"RegionId": "cn-hangzhou",
"EventId": "5651188b-3070-d1cc-5311-75753d59****",
"DirectoryType": "RAM",
"EventType": "DESKTOP_DISCONNECT",
"EndUserId": "28961708130834****",
"ClientIp": "100.68.*.*",
"ClientOS": "Darwin 17.7.0 x64",
"OfficeSiteType": "SIMPLE",
"DirectoryId": "cn-hangzhou+dir-bh77qa8nmjot4****",
"ClientVersion": "1.0.4 202012021700",
"OfficeSiteName": "test",
"DesktopName": "test",
"DesktopGroupId": "dg-kadkdfaf****",
"DesktopGroupName": "testName"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2022-09-08 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2021-08-19 | OpenAPI 返回结构发生变更 | 查看变更详情 |