调用DescribeDesktopSessions查询桌面会话详情_无影云电脑(WUYING Workspace)-阿里云帮助中心

查询桌面的详细会话信息。

接口说明

当前仅支持 30 天以内的数据查询。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
OfficeSiteId	string	是	工作区 ID。	cn-hangzhou+dir-363353****
EndUserId	string	否	终端用户 ID。	testUser
SessionStatus	string	否	会话状态。可能值： Connected：已连接。 Disconnected：已断开。	Connected
StartTime	string	否	查询开始时间。	2023-01-28T02:31:43Z
EndTime	string	否	查询结束时间。	2023-02-13T02:51:43Z
PageNumber	integer	否	分页查询时，当前页的页码。	1
PageSize	integer	否	分页查询时，每页最大行数。	10

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	查询结果总数。	1
RequestId	string	请求 ID。	3EC4A6DB-EC8D-55B0-9038-543DE671****
Sessions	object []	会话详情。
SessionStatus	string	会话连接状态。 Connected：已连接。 Disconnected：已断开。	Connected
EndUserId	string	终端用户 ID。	testUser
OfficeSiteId	string	工作区 ID。	cn-hangzhou+dir-8904****
ClientIp	string	客户端 IP。	172.21.XX.XX
ClientOS	string	客户端系统。	windows_\"Windows10Enterprise\"10.0(Build22000)
DesktopId	string	云桌面 ID。	ecd-g6t1ukbaea****
DesktopName	string	云桌面名称。	testDesktop
OfficeSiteName	string	工作区名称。	测试工作区
ClientVersion	string	客户端版本。	2.0.0-R-20221030.08****
ProtocolType	string	桌面协议类型。可能值： HDX ASP	ASP
LatestConnectionTime	long	最近一次连接云桌面的时长，单位：秒。	120
TotalConnectionTime	long	总连接时长，单位：秒。	240
SessionStartTime	string	会话的开始时间。	2023-01-28T02:31:43Z
SessionEndTime	string	会话结束时间。	2023-01-28T02:31:43Z
SessionIdleTime	long	会话空闲时长，单位：秒。	120
OsType	string	操作系统类型。包括： Windows Linux	Windows
EndUserApplyCoordinateTime	long	终端用户远程协助时长，单位：秒。	120

示例

正常返回示例

JSON格式

{
  "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": "测试工作区",
      "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
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史