Queries the detailed session information of a cloud computer.
Operation description
You can only query data within the last 30 days.
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:DescribeDesktopSessions | list | *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 regions supported by Elastic Desktop Service (EDS). | cn-hangzhou |
| OfficeSiteId | string | No | The office network ID. | cn-hangzhou+dir-363353**** |
| EndUserId | string | No | The ID of the end user. | testUser |
| SessionStatus | string | No | The state of the session. Valid values:
| Connected |
| StartTime | string | No | The start of the time range to query. | 2023-01-28T02:31:43Z |
| EndTime | string | No | The end of the time range to query. | 2023-02-13T02:51:43Z |
| PageNumber | integer | No | The page number. | 1 |
| PageSize | integer | No | The number of entries returned per page. | 10 |
| DesktopId | array | No | The IDs of the cloud computers. You can specify the IDs of 1 to 100 cloud computers. | |
| string | No | The ID of the cloud computer. | ecd-gx2x1dhsmucyy**** | |
| DesktopName | string | No | The name of the cloud computer. | DemoComputer |
| SubPayType | string | No | The billing method of cloud computers. Valid values:
| monthPackage |
| CheckOsSession | boolean | No | Specifies whether to turn on the switch to check session status of cloud computers. | true |
| EndUserIdFilter | string | No | The user ID. This parameter functions the same as the | alice |
Response parameters
Examples
Sample success responses
JSONformat
{
"TotalCount": 1,
"RequestId": "3EC4A6DB-EC8D-55B0-9038-543DE671****",
"Sessions": [
{
"SessionStatus": "Connected",
"EndUserId": "testUser",
"OfficeSiteId": "cn-hangzhou+dir-8904****",
"ClientIp": "172.21.XX.XX",
"ClientOS": "windows_\\\"Windows10Enterprise\\\"10.0(Build22000)",
"DesktopId": "ecd-g6t1ukbaea****",
"DesktopName": "testDesktop",
"OfficeSiteName": "DemoOfficeSite",
"ClientVersion": "2.0.0-R-20221030.08****",
"ProtocolType": "ASP",
"LatestConnectionTime": 120,
"TotalConnectionTime": 240,
"SessionStartTime": "2023-01-28T02:31:43Z\n",
"SessionEndTime": "2023-01-28T02:31:43Z",
"SessionIdleTime": 120,
"OsType": "Windows",
"EndUserApplyCoordinateTime": 120,
"SubPayType": "monthPackage",
"OsSessionStatus": true
}
]
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-10-17 | The response structure of the API has changed | View Change Details |
| 2024-12-09 | The request parameters of the API has changed | View Change Details |
| 2024-07-08 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2024-07-01 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2024-04-15 | The request parameters of the API has changed | View Change Details |
