接口功能介绍
- 假设endTime代表前一天23点59分59秒(UTC+8),时间范围相关说明如下:
- 可供查询的数据时间范围是:[endTime - 180 天, endTime]。
- startTime的默认值是:endTime - 30天。
- endTime的默认值是:endTime。
- startTime和endTime与连接时间的关系:startTime <= startConnectTime,startConnectTime <= endTime。
- 考虑到存在延迟,如需要完整导出某天的连接会话记录,建议延后至少24小时进行导出,导出时指定时间范围(UTF+8):[此天0点, 此天23点59分59秒]。
- 单次查询的时间间距不可超过30天。
接口约束
无
URI
GET /v3/statistic/describeDesktopConnectLog
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
startTime | 否 | String | 起始时间。支持2种格式:秒级UNIX时间戳;以ISO 8601为标准,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 | 1700642186 | |
endTime | 否 | String | 结束时间。支持2种格式:秒级UNIX时间戳;以ISO 8601为标准,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 | 2023-11-22T16:36:29Z | |
limit | 否 | Integer | 返回最大记录数。取值范围:[1, 100]。默认值:10。 | 10 | |
cursor | 否 | String | 游标。指定为上一个请求返回的nextCursor,获取下一页,达到翻页效果。未设置时默认返回首页数据。 | ZWNwYzpudW1iZXI6MQ== |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 状态码。可能值: - 800:请求成功。 - 900:请求失败。 |
800 | |
error | String | 错误码。 | ECPC_1000 | |
message | String | 提示信息。 | OK. | |
returnObj | Object | 返回数据结构体。 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
nextCursor | String | 下一游标。此值为空串时,代表无更多数据。 | ZWNwYzpudW1iZXI6MQ== | |
list | Array of Objects | 数据列表。 | list |
表 list
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
desktopOid | String | 云电脑ID。 | fooId | |
pubUserOid | String | 用户ID。 | fooId | |
userName | String | 用户名称。 | fooName | |
userAccount | String | 用户账号。 | fooAccount | |
orgOid | String | 部门ID。 | fooName | |
orgName | String | (云电脑)部门名称。 | fooName | |
completeOrgName | String | (云电脑)部门完整名称。由从根部门到当前部门的名称,以半角斜线号(/)为分隔符拼接而成。 | fooRoot/fooName | |
startConnectTime | String | 开始连接时间。以ISO 8601为标准,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 | 2023-11-22T08:36:27Z | |
endConnectTime | String | 结束连接时间。以ISO 8601为标准,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 | 2023-11-22T08:36:28Z | |
deviceType | String | 终端类型。可能值: - ArmThinClient:瘦终端ARM。 - X86ThinClient:瘦终端X86。 - Iptv:IPTV。 - AndroidThinClient:Android 瘦终端。 - AndroidPhone:Android Phone。 - Windows:Windows客户端。 - Iphone:iPhone。 - AndroidPad:Android Pad。 - Ipad:iPad。 - Mac:Mac客户端。 |
Windows | |
subnetIpAddress | String | (云电脑)子网IP地址。 | 192.168.0.242 | |
deviceIpAddress | String | 终端IP地址。 | 66.66.66.66 | |
devicePrivateIpAddress | String | 终端内网IP地址。 | 66.66.66.66 | |
deviceMacAddress | String | 终端MAC地址。 | CC:CC:CC:CC:CC:CC | |
deviceSnCode | String | 终端SN码。 | cccccccc-cccc-cccc-cccc-cccccccccccc |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"nextCursor":"ZWNwYzpudW1iZXI6MQ==",
"list":[{
"desktopOid":"fooId",
"pubUserOid":"fooId",
"userName":"fooName",
"userAccount":"fooAccount",
"orgOid":"fooName",
"orgName":"fooName",
"completeOrgName":"fooRoot/fooName",
"startConnectTime":"2023-11-22T08:36:27Z",
"endConnectTime":"2023-11-22T08:36:28Z",
"deviceType":"Windows",
"subnetIpAddress":"192.168.0.242",
"deviceIpAddress":"66.66.66.66",
"deviceMacAddress":"CC:CC:CC:CC:CC:CC",
"deviceSnCode":"cccccccc-cccc-cccc-cccc-cccccccccccc"
}]
}
}
状态码
请参考 状态码
错误码
请参考 错误码