查询云电脑的详细会话信息。
接口说明
当前仅支持查询 30 天以内的数据。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 |
cn-hangzhou |
| OfficeSiteId |
string |
否 |
办公网络 ID。 |
cn-hangzhou+dir-363353**** |
| EndUserId |
string |
否 |
终端用户 ID。 |
alice |
| SessionStatus |
string |
否 |
会话连接状态。 枚举值：
|
Connected |
| StartTime |
string |
否 |
查询开始时间。 |
2023-01-28T02:31:43Z |
| EndTime |
string |
否 |
查询结束时间。 |
2023-02-13T02:51:43Z |
| PageNumber |
integer |
否 |
分页查询时，当前页的页码。 |
1 |
| PageSize |
integer |
否 |
分页查询时，每页最大行数。 |
10 |
| DesktopId |
array |
否 |
云电脑 ID。可设置 1~100 个。 |
|
|
string |
否 |
云电脑 ID。 |
ecd-gx2x1dhsmucyy****" |
|
| DesktopName |
string |
否 |
云电脑名称。 |
DemoComputer |
| SubPayType |
string |
否 |
云电脑购买方式。 枚举值：
|
monthPackage |
| CheckOsSession |
boolean |
否 |
检查云电脑内会话状态的开关。 |
true |
| EndUserIdFilter |
string |
否 |
终端用户 ID。与参数 |
alice |
| ResourceGroupId |
string |
否 |
||
| FillHardwareInfo |
boolean |
否 |
是否增加终端信息返回。 |
|
| Language |
string |
否 |
返回信息的语言类型。 |
zh-CN |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| TotalCount |
integer |
查询结果总数。 |
1 |
| RequestId |
string |
请求 ID。 |
3EC4A6DB-EC8D-55B0-9038-543DE671**** |
| Sessions |
array<object> |
会话详情。 |
|
|
array<object> |
会话详情。 |
||
| SessionStatus |
string |
会话连接状态。 枚举值：
|
Connected |
| EndUserId |
string |
终端用户 ID。 |
alice |
| 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 |
云电脑名称。 |
DemoComputer |
| OfficeSiteName |
string |
办公网络名称。 |
TestOfficeSite |
| ClientVersion |
string |
客户端版本。 |
2.0.0-R-20221030.08**** |
| ProtocolType |
string |
协议类型。 枚举值：
|
ASP |
| LatestConnectionTime |
integer |
最近一次连接云电脑的时长。单位：秒。 |
120 |
| TotalConnectionTime |
integer |
总连接时长。单位：秒。 |
240 |
| SessionStartTime |
string |
会话的开始时间。 |
2023-01-28T02:31:43Z |
| SessionEndTime |
string |
会话的结束时间。 |
2023-01-28T02:31:43Z |
| SessionIdleTime |
integer |
会话空闲时长。单位：秒。 |
120 |
| OsType |
string |
操作系统类型。 枚举值：
|
Windows |
| EndUserApplyCoordinateTime |
integer |
终端用户远程协助时长。单位：秒。 |
120 |
| SubPayType |
string |
云电脑购买方式。 枚举值：
|
monthPackage |
| OsSessionStatus |
string |
检查云电脑内会话状态的开关。 |
true |
| TerminalInfo |
object |
终端设备信息描述。 |
|
| ProductName |
string |
终端设备类型。 |
Mac |
| SerialNumber |
string |
终端设备序列号。 |
96c530bc-6095-4014-8bbc-d461b8ac**** |
| Model |
string |
终端设备信息。 |
Mac |
| Uuid |
string |
登录设备的 UUID。 |
EBFDC7773BEBAD418A9F89429652**** |
| DirectoryType |
string |
办公网络类型 |
SIMPLE |
| AccountType |
string |
账号类型 |
SIMPLE |
| ResourceGroups |
array<object> |
资源组信息 |
|
|
object |
资源组 |
||
| Id |
string |
资源组 ID |
rg-8whrmo2gtsb8bxxxx |
| Name |
string |
资源组名称 |
RgTest |
SessionIdleTime 仅当云电脑操作系统为 Windows 时返回。
示例
正常返回示例
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",
"TerminalInfo": {
"ProductName": "Mac",
"SerialNumber": "96c530bc-6095-4014-8bbc-d461b8ac****",
"Model": "Mac",
"Uuid": "EBFDC7773BEBAD418A9F89429652****"
},
"DirectoryType": "SIMPLE",
"AccountType": "SIMPLE",
"ResourceGroups": [
{
"Id": "rg-8whrmo2gtsb8bxxxx",
"Name": "RgTest"
}
]
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。