DescribeDesktopSessions - 查询云电脑会话详情

查询云电脑的详细会话信息。

接口说明

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

调试

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

授权信息

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

请求参数

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

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-hangzhou
OfficeSiteIdstring

办公网络 ID。

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

终端用户 ID。

alice
SessionStatusstring

会话连接状态。

枚举值:
  • Connected已连接
  • Disconnected已断开
Connected
StartTimestring

查询开始时间。

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

查询结束时间。

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

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

1
PageSizeinteger

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

10
DesktopIdarray

云电脑 ID。可设置 1~100 个。

string

云电脑 ID。

ecd-gx2x1dhsmucyy****"
DesktopNamestring

云电脑名称。

DemoComputer
SubPayTypestring

云电脑购买方式。

枚举值:
  • duration时长包 [白名单]
  • postPaid按需购买
  • monthPackage按月购买(120小时/250小时)
  • prePaid按月购买(不限时长)
monthPackage
CheckOsSessionboolean

检查云电脑内会话状态的开关。

true

返回参数

名称类型描述示例值
object
TotalCountinteger

查询结果总数。

1
RequestIdstring

请求 ID。

3EC4A6DB-EC8D-55B0-9038-543DE671****
Sessionsarray<object>

会话详情。

Sessionobject

会话详情。

SessionStatusstring

会话连接状态。

枚举值:
  • Connected已连接
  • Disconnected已断开
Connected
EndUserIdstring

终端用户 ID。

alice
OfficeSiteIdstring

办公网络 ID。

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

客户端 IP。

172.21.XX.XX
ClientOSstring

客户端操作系统。

windows_\"Windows10Enterprise\"10.0(Build22000)
DesktopIdstring

云电脑 ID。

ecd-g6t1ukbaea****
DesktopNamestring

云电脑名称。

DemoComputer
OfficeSiteNamestring

办公网络名称。

TestOfficeSite
ClientVersionstring

客户端版本。

2.0.0-R-20221030.08****
ProtocolTypestring

协议类型。

枚举值:
  • HDXHDX协议
  • ASP阿里云自研ASP协议
ASP
LatestConnectionTimelong

最近一次连接云电脑的时长。单位:秒。

120
TotalConnectionTimelong

总连接时长。单位:秒。

240
SessionStartTimestring

会话的开始时间。

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

会话的结束时间。

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

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

120
OsTypestring

操作系统类型。

枚举值:
  • LinuxLinux
  • WindowsWindows
Windows
EndUserApplyCoordinateTimelong

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

120
SubPayTypestring

云电脑购买方式。

枚举值:
  • duration时长包 [白名单]
  • postPaid按需购买
  • monthPackage按月购买(120小时/250小时)
  • prePaid按月购买(不限时长)
monthPackage
OsSessionStatusstring

检查云电脑内会话状态的开关。

true

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "3EC4A6DB-EC8D-55B0-9038-543DE671****",
  "Sessions": [
    {
      "SessionStatus": "Connected",
      "EndUserId": "alice",
      "OfficeSiteId": "cn-hangzhou+dir-8904****",
      "ClientIp": "172.21.XX.XX",
      "ClientOS": "windows_\\\"Windows10Enterprise\\\"10.0(Build22000)",
      "DesktopId": "ecd-g6t1ukbaea****",
      "DesktopName": "DemoComputer",
      "OfficeSiteName": "TestOfficeSite",
      "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"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-07-08OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-07-01OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-04-15OpenAPI 入参发生变更查看变更详情