DescribeClientEvents - WUYING Workspace - Alibaba Cloud Documentation Center

Queries the operation logs of end users. For example, the logs record the events that end users start and stop cloud desktops, and disconnect desktop sessions.

Operation description

You can audit the operation logs of regular users to improve security. The operation logs record events such as desktop startup, shutdown, and session disconnection.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
EndUserId	string	No	The information about the end user that connects to the cloud desktop from the Elastic Desktop Service (EDS) client. The information can be a Resource Access Management (RAM) user ID or an Active Directory (AD) username. If you do not specify a value for this parameter, the events of all end users in the specified region are queried.	28961708130834****
DesktopId	string	No	The cloud desktop ID. If you do not specify a value for this parameter, events of all cloud desktops in the specified region are queried.	ecd-8fupvkhg0aayu****
DesktopIp	string	No	The IP address of the cloud desktop. If you do not specify a value for this parameter, the events of all cloud desktops in the specified region are queried.	10.10..
DirectoryId	string	No	This parameter is not available to the public.	cn-hangzhou+dir-bh77qa8nmjot4****
OfficeSiteId	string	No	The ID of the workspace to which the cloud desktop belongs. If you do not specify a value for this parameter, the events of all workspaces in the specified region are queried.	cn-hangzhou+dir-bh77qa8nmjot4****
EventType	string	No	The type of the events that you want to query. If you specify multiple values for the EventTypes parameter, the events of all specified types are returned. If you do not specify values for the EventTypes and EventType parameters, all events of end users in the specified region are returned. Valid values: DESKTOP_STOP: End users stop the cloud desktop. GET_LITE_CONNECTION_TICKET: End users obtain the credential for reconnecting to the cloud desktop upon disconnection. DESKTOP_DISCONNECT: End users disconnect desktop sessions. GET_CONNECTION_TICKET: End users request to connect to the cloud desktop. CLIENT_LOGIN: End users log on to the cloud desktop. DESKTOP_REBOOT: End users restart the cloud desktop. DESKTOP_CONNECT: End users establish desktop sessions. DESKTOP_START: End users start the cloud desktop.	DESKTOP_DISCONNECT
StartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. If you do not specify a value for this parameter, all events that occurred before the point in time that you specify for `EndTime` are queried.	2020-11-30T06:32:31Z
EndTime	string	No	The end of the time range to query. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. If you do not specify a value for this parameter, the current time is used.	2020-11-31T06:32:31Z
MaxResults	integer	No	The number of entries per page. Default value: 100.	10
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.	AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
OfficeSiteName	string	No	The workspace name.	test
DesktopName	string	No	The cloud desktop name.	test
EventTypes	array	Yes	The array of event types that you want to query. You can specify multiple event types. The response contains all or specified types of events.
	string	Yes	The type of the events that you want to query. Valid values: DESKTOP_STOP: End users stop the cloud desktop. GET_LITE_CONNECTION_TICKET: End users obtain the credential for reconnecting to the cloud desktop upon disconnection. DESKTOP_DISCONNECT: End users disconnect desktop sessions. GET_CONNECTION_TICKET: End users request to connect to the cloud desktop. CLIENT_LOGIN: End users log on to the cloud desktop. DESKTOP_REBOOT: End users restart the cloud desktop. DESKTOP_CONNECT: End users establish desktop sessions. DESKTOP_START: End users start the cloud desktop.	DESKTOP_START

Response parameters

Parameter	Type	Description	Example
	object	Schema of response.
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.	AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
RequestId	string	The request ID.	28A40F12-F340-442B-A35F-46EF6A03227B
Events	object []	The information about the events of an end user.
Status	string	The status of the event. If you set the EventType parameter to `DESKTOP_DISCONNECT` or `GET_CONNECTION_TICKET`, this parameter is returned. Valid values: 200. The value indicates that the request is successful. An error message. The value indicates that the request failed. Example: FailedToGetConnectionTicket.	200
BytesReceived	string	The number of bytes that are received.	8665
DesktopIp	string	The IP address of the cloud desktop.	10.10..
EventTime	string	The time when the event occurred.	2020-11-30T06:32:31Z
BytesSend	string	The number of bytes that are sent.	2345
OfficeSiteId	string	The ID of the workspace to which the cloud desktop belongs.	cn-hangzhou+dir-bh77qa8nmjot4****
AliUid	string	The ID of the Alibaba Cloud account with which the event is associated.	112259558861****
DesktopId	string	The cloud desktop ID.	ecd-8fupvkhg0aayu****
RegionId	string	The region ID.	cn-hangzhou
EventId	string	The event ID.	5651188b-3070-d1cc-5311-75753d59****
DirectoryType	string	The directory type.	RAM
EventType	string	The event type. Valid values:	DESKTOP_DISCONNECT
EndUserId	string	The information about the end user that connects to the cloud desktop from the EDS client. The information can be a RAM user ID or an AD username.	28961708130834****
ClientIp	string	The IP address of the client.	100.68..
ClientOS	string	The OS that the client runs.	Darwin 17.7.0 x64
OfficeSiteType	string	The account type of the workspace. Valid values: SIMPLE: convenience account AD_CONNECTOR: enterprise AD account	SIMPLE
DirectoryId	string	The ID of the directory to which the cloud desktop belongs.	cn-hangzhou+dir-bh77qa8nmjot4****
ClientVersion	string	The client version.	1.0.4 202012021700
OfficeSiteName	string	The workspace name.	test
DesktopName	string	The cloud desktop name.	test
DesktopGroupId	string	The desktop group ID.	dg-kadkdfaf****
DesktopGroupName	string	The desktop group name.	testName

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2022-09-08

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: EventTypes

2021-08-19

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.