调用DescribeClientEvents查询终端用户的操作日志。

接口说明

为提高安全性，您可以按需审计终端用户的操作日志，支持查询的操作日志包括桌面开机、桌面关机、桌面会话断开等事件。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeClientEvents

系统规定参数。取值：DescribeClientEvents。
RegionId String 是 cn-hangzhou

云桌面所在的地域ID。
EndUserId String 否 28961708130834****

登录用户信息，RAM用户ID或AD用户名。不指定时，表示查询该地域下所有用户的事件。
DesktopId String 否 ecd-8fupvkhg0aayu****

云桌面ID。不指定时，表述查询该地域下所有云桌面的事件。
DesktopIp String 否 10.10.*.*

云桌面的IP地址。不指定时，表示查询该地域下所有云桌面的事件。
DirectoryId String 否 cn-hangzhou+dir-bh77qa8nmjot4****

云桌面所属的目录ID。不指定时，表示查询该地域下所有目录下的用户事件。
EventType String 否 DESKTOP_DISCONNECT

要查询的事件类型。取值范围：

  • DESKTOP_CONNECT：桌面会话建立
  • DESKTOP_DISCONNECT：桌面会话断开
  • DESKTOP_REBOOT：重启桌面
  • CLIENT_AD_LOGIN：AD用户登录
  • GET_CONNECTION_TICKET：桌面连接请求
  • DESKTOP_START：桌面开机
  • DESKTOP_STOP：桌面关机

如果为空，则查询所有事件。
StartTime String 否 2020-11-30T06:32:31Z

开始时间。按照ISO8601标准表示，并需要使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。

如果不填，则按EndTime指定的时间往前查询。

EndTime String 否 2020-11-31T06:32:31Z

结束时间。按照ISO8601标准表示，并需要使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。

如果不填，则按当前时间。
MaxResults Integer 否 10

分页查询时每页行数。

默认值：100。
NextToken String 否 AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****

查询凭证（Token），取值为上一次API调用返回的NextToken参数值。

返回数据

名称 类型 示例值 描述
Events Array of Event

用户事件数组。
AliUid String 112259558861****

事件关联的主账号信息。
BytesReceived String 8665

已接收字节，单位：Byte。
BytesSend String 2345

已发送字节，单位：Byte。
ClientIp String 100.68.*.*

客户端IP。
ClientOS String Darwin 17.7.0 x64

客户端系统。
ClientVersion String 1.0.4 202012021700

客户端版本。
DesktopId String ecd-8fupvkhg0aayu****

云桌面ID。
DesktopIp String 10.10.*.*

云桌面的IP地址。
DirectoryId String cn-hangzhou+dir-bh77qa8nmjot4****

云桌面所属的目录ID。
DirectoryType String RAM

目录类型。
EndUserId String 28961708130834****

登录用户信息，RAM用户ID或者AD用户名。
EventId String 5651188b-3070-d1cc-5311-75753d59****

事件ID。
EventTime String 2020-11-30T06:32:31Z

事件发生的时间。
EventType String DESKTOP_DISCONNECT

事件类型。
RegionId String cn-hangzhou

地域ID。
Status String 200

事件行为状态。
NextToken String AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****

本次调用返回的查询凭证值。
RequestId String 28A40F12-F340-442B-A35F-46EF6A03227B

请求ID。

示例

请求示例

https://ecd.cn-hangzhou.aliyuncs.com/?Action=DescribeClientEvents
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式 

<DescribeClientEventsResponse>
      <NextToken>AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL</NextToken>
      <RequestId>28A40F12-F340-442B-A35F-46EF6A03227B</RequestId>
      <Events>
            <Status>200</Status>
            <EventType>DESKTOP_DISCONNECT</EventType>
            <BytesSend>2345</BytesSend>
            <DesktopId>ecd-8fupvkhg0aayu****</DesktopId>
            <ClientVersion>1.0.4 202012021700</ClientVersion>
            <ClientIp>100.68.*.*</ClientIp>
            <DirectoryType>RAM</DirectoryType>
            <ClientOS>Darwin 17.7.0 x64</ClientOS>
            <BytesReceived>8665</BytesReceived>
            <DirectoryId>cn-hangzhou+dir-bh77qa8nmjot4****</DirectoryId>
            <EndUserId>28961708130834****</EndUserId>
            <EventTime>2020-11-30T06:32:31Z</EventTime>
            <EventId>5651188b-3070-d1cc-5311-75753d59****</EventId>
            <RegionId>cn-hangzhou</RegionId>
            <DesktopIp>10.10.*.*</DesktopIp>
            <AliUid>112259558861****</AliUid>
      </Events>
</DescribeClientEventsResponse>

JSON 格式 

{
	"NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL",
	"RequestId": "28A40F12-F340-442B-A35F-46EF6A03227B",
	"Events": [{
		"Status": "200",
		"EventType": "DESKTOP_DISCONNECT",
		"BytesSend": "2345",
		"DesktopId": "ecd-8fupvkhg0aayu****",
		"ClientVersion": "1.0.4 202012021700",
		"ClientIp": "100.68.*.*",
		"DirectoryType": "RAM",
		"ClientOS": "Darwin 17.7.0 x64",
		"BytesReceived": "8665",
		"DirectoryId": "cn-hangzhou+dir-bh77qa8nmjot4****",
		"EndUserId": "28961708130834****",
		"EventTime": "2020-11-30T06:32:31Z",
		"EventId": "5651188b-3070-d1cc-5311-75753d59****",
		"RegionId": "cn-hangzhou",
		"DesktopIp": "10.10.*.*",
		"AliUid": "112259558861****"
	}]
}

错误码

访问错误中心查看更多错误码。