DescribeDesktopSessions - 查询桌面会话详情

更新时间: 2024-01-24 15:14:24

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

接口说明

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

调试

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

调试

授权信息

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

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
OfficeSiteIdstring

工作区 ID。

cn-hangzhou+dir-363353****
EndUserIdstring

终端用户 ID。

testUser
SessionStatusstring

会话状态。可能值:

  • Connected:已连接。
  • Disconnected:已断开。
Connected
StartTimestring

查询开始时间。

2023-01-28T02:31:43Z
EndTimestring

查询结束时间。

2023-02-13T02:51:43Z
PageNumberinteger

分页查询时,当前页的页码。

1
PageSizeinteger

分页查询时,每页最大行数。

10

返回参数

名称类型描述示例值
object
TotalCountinteger

查询结果总数。

1
RequestIdstring

请求 ID。

3EC4A6DB-EC8D-55B0-9038-543DE671****
Sessionsobject []

会话详情。

SessionStatusstring

会话连接状态。

  • Connected:已连接。
  • Disconnected:已断开。
Connected
EndUserIdstring

终端用户 ID。

testUser
OfficeSiteIdstring

工作区 ID。

cn-hangzhou+dir-8904****
ClientIpstring

客户端 IP。

172.21.XX.XX
ClientOSstring

客户端系统。

windows_\"Windows10Enterprise\"10.0(Build22000)
DesktopIdstring

云桌面 ID。

ecd-g6t1ukbaea****
DesktopNamestring

云桌面名称。

testDesktop
OfficeSiteNamestring

工作区名称。

测试工作区
ClientVersionstring

客户端版本。

2.0.0-R-20221030.08****
ProtocolTypestring

桌面协议类型。可能值:

  • HDX
  • ASP
ASP
LatestConnectionTimelong

最近一次连接云桌面的时长,单位:秒。

120
TotalConnectionTimelong

总连接时长,单位:秒。

240
SessionStartTimestring

会话的开始时间。

2023-01-28T02:31:43Z
SessionEndTimestring

会话结束时间。

2023-01-28T02:31:43Z
SessionIdleTimelong

会话空闲时长,单位:秒。

120
OsTypestring

操作系统类型。包括:

  • Windows
  • Linux
Windows
EndUserApplyCoordinateTimelong

终端用户远程协助时长,单位:秒。

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

错误码

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

阿里云首页 无影云电脑 相关技术圈