调用DescribeClientEvents查询终端用户的操作日志_无影云电脑(WUYING Workspace)-阿里云帮助中心

查询终端用户的操作日志，包括桌面开机、桌面关机、桌面会话断开等事件。

调试

您可以在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_STOP：桌面关机。 GET_LITE_CONNECTION_TICKET：获取桌面自动断线重连凭证。 DESKTOP_DISCONNECT：桌面会话断开。 GET_CONNECTION_TICKET：桌面连接请求。 CLIENT_LOGIN：用户登录。 DESKTOP_REBOOT：重启桌面。 DESKTOP_CONNECT：桌面会话建立。 DESKTOP_START：桌面开机。	DESKTOP_DISCONNECT
StartTime	string	否	开始时间。按照ISO 8601标准表示，并需要使用 UTC+0 时间，格式为 YYYY-MM-DDThh:mm:ssZ。如果不填，则按`EndTime`指定的时间往前查询。	2020-11-30T06:32:31Z
EndTime	string	否	结束时间。按照ISO 8601标准表示，并需要使用 UTC+0 时间，格式为 YYYY-MM-DDThh:mm:ssZ。如果不填，则按当前时间。	2020-11-31T06:32:31Z
MaxResults	integer	否	分页查询时每页行数。默认值：100。	10
NextToken	string	否	查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。	AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
OfficeSiteName	string	否	工作区名称。	test
DesktopName	string	否	云桌面名称。	test
EventTypes	array	是	要查询的事件类型组合，可以多个事件组合，查询结果包含所有组合的事件。
	string	是	要查询的事件类型。枚举值： DESKTOP_STOP：桌面关机。 GET_LITE_CONNECTION_TICKET：获取桌面自动断线重连凭证。 DESKTOP_DISCONNECT：桌面会话断开。 GET_CONNECTION_TICKET：桌面连接请求。 CLIENT_LOGIN：用户登录。 DESKTOP_REBOOT：重启桌面。 DESKTOP_CONNECT：桌面会话建立。 DESKTOP_START：桌面开机。	DESKTOP_START

返回参数

名称	类型	描述	示例值
	object	返回信息集合。
NextToken	string	下一个查询开始的 Token，NextToken 为空表示没有下一个。	AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
RequestId	string	请求 ID。	28A40F12-F340-442B-A35F-46EF6A03227B
Events	object []	用户事件。
Status	string	事件行为状态，一般在`DESKTOP_DISCONNECT`和`GET_CONNECTION_TICKET`中出现。可能值： 200，表示成功。返回失败信息，例如：FailedToGetConnectionTicket。	200
BytesReceived	string	已接收字节，单位：Byte。	8665
DesktopIp	string	云桌面的 IP 地址。	10.10..
EventTime	string	事件发生的时间。	2020-11-30T06:32:31Z
BytesSend	string	已发送字节，单位：Byte。	2345
OfficeSiteId	string	云桌面所属的工作区 ID。	cn-hangzhou+dir-bh77qa8nmjot4****
AliUid	string	事件关联的主账号信息。	112259558861****
DesktopId	string	云桌面 ID。	ecd-8fupvkhg0aayu****
RegionId	string	地域 ID。	cn-hangzhou
EventId	string	事件 ID。	5651188b-3070-d1cc-5311-75753d59****
DirectoryType	string	目录类型。	RAM
EventType	string	事件类型。	DESKTOP_DISCONNECT
EndUserId	string	登录用户信息，RAM 用户 ID 或者 AD 用户名。	28961708130834****
ClientIp	string	客户端 IP。	100.68..
ClientOS	string	客户端系统。	Darwin 17.7.0 x64
OfficeSiteType	string	工作区的账号系统类型。枚举值： SIMPLE：便捷账号。 AD_CONNECTOR：企业AD账号。	SIMPLE
DirectoryId	string	云桌面所属的目录 ID。	cn-hangzhou+dir-bh77qa8nmjot4****
ClientVersion	string	客户端版本。	1.0.4 202012021700
OfficeSiteName	string	工作区名称。	test
DesktopName	string	云桌面名称。	test
DesktopGroupId	string	桌面组 ID。	dg-kadkdfaf****
DesktopGroupName	string	桌面组名称。	testName

示例

正常返回示例

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"
    }
  ]
}