DescribeClientEvents

Queries end-user operation logs, including cloud desktop start, stop, reboot, and session disconnect events.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:DescribeClientEvents

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. Call DescribeRegions to query supported regions.	cn-hangzhou
EndUserId	string	No	The end user ID (RAM user ID or AD username). If not specified, returns events for all users in the region.	28961708130834****
DesktopId	string	No	The cloud desktop ID. If not specified, returns events for all cloud desktops in the region.	ecd-8fupvkhg0aayu****
DesktopIp	string	No	The cloud desktop IP address. If not specified, returns events for all cloud desktops in the region.	10.10..
DirectoryId	string	No	Note This parameter is not in use.	To be hidden.
OfficeSiteId	string	No	The office network ID. If not specified, returns events for all office networks in the region.	cn-hangzhou+dir-bh77qa8nmjot4****
EventType	string	No	The event type. Ignored if EventTypes is specified. If neither is set, all events are returned. Valid values: DESKTOP_STOP : stop GET_LITE_CONNECTION_TICKET : automatic reconnection ticket request DESKTOP_DISCONNECT : session disconnection GET_CONNECTION_TICKET : cloud desktop connection request CLIENT_LOGIN : user login DESKTOP_REBOOT : reboot DESKTOP_CONNECT : session establishment DESKTOP_START : start	DESKTOP_DISCONNECT
StartTime	string	No	The start of the time range, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ, UTC). If not specified, returns events before `EndTime`.	2020-11-30T06:32:31Z
EndTime	string	No	The end of the time range, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ, UTC). Defaults to the current time.	2020-11-31T06:32:31Z
MaxResults	integer	No	The maximum number of entries per page. Default: 100.	10
NextToken	string	No	The pagination token returned in the previous response. Use this to retrieve the next page.	AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
OfficeSiteName	string	No	The name of the office network.	test
DesktopName	string	No	The name of the cloud desktop.	test
EventTypes	array	No	The event types to query. Returns events matching any specified type.
	string	No	The event type. Valid values: DESKTOP_STOP : stop GET_LITE_CONNECTION_TICKET : automatic reconnection ticket request DESKTOP_DISCONNECT : session disconnection GET_CONNECTION_TICKET : cloud desktop connection request CLIENT_LOGIN : user login DESKTOP_REBOOT : reboot DESKTOP_CONNECT : session establishment DESKTOP_START : start	DESKTOP_START
Language	string	No
FillHardwareInfo	boolean	No

Response elements

Element	Type	Description	Example
	object	The response object.
NextToken	string	The pagination token. Empty if all results have been returned.	AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
RequestId	string	The request ID.	28A40F12-F340-442B-A35F-46EF6A03227B
Events	array<object>	The list of user events.
	array<object>	A user event.
Status	string	The event status. Returned only for `DESKTOP_DISCONNECT` and `GET_CONNECTION_TICKET` events. Valid values: `200`: Success. An error message, such as `FailedToGetConnectionTicket`.	200
BytesReceived	string	The number of bytes received.	8665
DesktopIp	string	The IP address of the cloud desktop.	10.10.XX.XX
EventTime	string	The time the event occurred.	2020-11-30T06:32:31Z
BytesSend	string	The number of bytes sent.	2345
OfficeSiteId	string	The office network ID of the cloud desktop.	cn-hangzhou+dir-bh77qa8nmjot4****
AliUid	string	The Alibaba Cloud account ID associated with the event.	112259558861****
DesktopId	string	The ID of the cloud desktop.	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.	DESKTOP_DISCONNECT
EndUserId	string	The end user ID (RAM user ID or AD username).	28961708130834****
ClientIp	string	The IP address of the client.	100.68..
ClientOS	string	The operating system of the client.	Darwin 17.7.0 x64
OfficeSiteType	string	The account type of the office network. Valid values: SIMPLE : convenience account AD_CONNECTOR : enterprise AD account	SIMPLE
DirectoryId	string	The directory ID of the cloud desktop.	cn-hangzhou+dir-bh77qa8nmjot4****
ClientVersion	string	The client version.	1.0.4 202012021700
OfficeSiteName	string	The name of the office site.	test
DesktopName	string	The name of the cloud desktop.	test
DesktopGroupId	string	The ID of the computer pool.	dg-kadkdfaf****
DesktopGroupName	string	The name of the computer pool.	testName
Description	string	The description of the event.	test
TerminalInfo	object
ProductName	string
SerialNumber	string
Model	string

Examples

Success response

JSON format

{
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****",
  "RequestId": "28A40F12-F340-442B-A35F-46EF6A03227B",
  "Events": [
    {
      "Status": "200",
      "BytesReceived": "8665",
      "DesktopIp": "10.10.XX.XX",
      "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",
      "Description": "test",
      "TerminalInfo": {
        "ProductName": "",
        "SerialNumber": "",
        "Model": ""
      }
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.