Queries the logs that track cloud computer startup, shutdown, and session disconnection events.
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
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecd:DescribeClientEvents | get | *All Resources * |
| none |
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_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. | 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. | 2020-11-31T06:32:31Z |
| MaxResults | integer | No | The number of entries per page. | 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_START |
Response parameters
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",
"Description": "test"
}
]
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-01-11 | The response structure of the API has changed | View Change Details |
| 2022-09-08 | The request parameters of the API has changed | View Change Details |
| 2021-08-19 | The response structure of the API has changed | View Change Details |