DescribeDesktopSessions - Elastic Desktop Service - Alibaba Cloud Documentation Center

Queries the detailed session information of a cloud computer.

Operation description

You can only query data within the last 30 days.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region. You can call the DescribeRegions operation to query the regions supported by Elastic Desktop Service.	cn-hangzhou
OfficeSiteId	string	Yes	The ID of the office network.	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 Disconnected	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

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	1
RequestId	string	The request ID.	3EC4A6DB-EC8D-55B0-9038-543DE671****
Sessions	array<object>	Details of the session.
Session	object
SessionStatus	string	The state of the session. Valid values: Connected Disconnected	Connected
EndUserId	string	The ID of the end user.	testUser
OfficeSiteId	string	The ID of the office network.	cn-hangzhou+dir-8904****
ClientIp	string	The IP address of the client.	172.21.XX.XX
ClientOS	string	The client OS.	windows_\"Windows10Enterprise\"10.0(Build22000)
DesktopId	string	The ID of the cloud computer.	ecd-g6t1ukbaea****
DesktopName	string	The name of the cloud computer.	testDesktop
OfficeSiteName	string	The name of the office network.	DemoOfficeSite
ClientVersion	string	The client version.	2.0.0-R-20221030.08****
ProtocolType	string	The protocol type. Valid values: HDX ASP	ASP
LatestConnectionTime	long	The duration of the last connection to the cloud computer. Unit: seconds.	120
TotalConnectionTime	long	The total connection duration. Unit: seconds.	240
SessionStartTime	string	The start time of the session.	2023-01-28T02:31:43Z
SessionEndTime	string	The end time of the session.	2023-01-28T02:31:43Z
SessionIdleTime	long	The idle duration of the session. Unit: seconds.	120
OsType	string	The OS. Valid values: Linux Windows	Windows
EndUserApplyCoordinateTime	long	The duration of the remote assistance. Unit: seconds.	120

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

Error codes

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

Change history

Change time	Summary of changes	Operation
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