查询指定条件下授权用户的桌面连接时长统计,支持按每日累计时长或单次连接明细进行统计。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DataDate |
string |
否 |
统计数据的日期,格式为 yyyy-MM-dd。为空时默认统计前一天的数据。 |
2026-06-24 |
| ComparisonOperator |
string |
否 |
连接时长的比较运算符,与 Threshold 配合按阈值筛选用户。GreaterThanThreshold:大于阈值;LessThanThreshold:小于阈值。 |
GreaterThanThreshold |
| Threshold |
integer |
否 |
连接时长阈值,单位为秒,需与 ComparisonOperator 配合使用。 |
3600 |
| UserName |
string |
否 |
终端用户名称,支持模糊搜索;使用该参数时需同时指定 IsAdUser。 |
alice |
| IsAdUser |
boolean |
否 |
是否只查询 AD 用户。指定 UserName 或 WithDetail 时必须同时设置该参数。 |
|
| WithDetail |
boolean |
否 |
是否回填用户详情(如显示名、昵称等),支持 AD 用户和便捷用户;使用时需同时指定 IsAdUser。 |
|
| PageNum |
integer |
否 |
分页页码,从 1 开始,默认值为 1。仅在按每日累计时长统计(StatisticType=Daily)时生效。 |
1 |
| PageSize |
integer |
否 |
分页大小,默认值和最大值均为 100。 |
100 |
| StatisticType |
string |
否 |
统计类型。
|
Daily |
| NextToken |
string |
否 |
分页查询凭证。仅在按单次连接明细统计(StatisticType=SingleSession)时使用;首次查询无需传入,后续传入上一次返回的 NextToken 获取下一页。 |
d129c6c0e8c04c8a9f0e2b7c1a3f5e6d |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| AuthUserConnectDurationList |
array<object> |
授权用户的连接时长列表。 |
|
|
object |
|||
| ConnectDuration |
integer |
用户的连接时长,单位为秒。 |
3600 |
| ConnectEndTime |
string |
本次连接的结束时间,为 Unix 毫秒时间戳。仅在按单次连接明细统计(StatisticType=SingleSession)时返回。 |
1719208800000 |
| ConnectStartTime |
string |
本次连接的开始时间,为 Unix 毫秒时间戳。仅在按单次连接明细统计(StatisticType=SingleSession)时返回。 |
1719205200000 |
| Description |
string |
用户备注,仅便捷用户且 WithDetail=true 时返回。 |
研发部员工 |
| DesktopId |
string |
云桌面 ID。 |
ecd-gx2x1dhsmusr2**** |
| DesktopName |
string |
云桌面名称。 |
test-desktop |
| DirectoryType |
integer |
用户所属目录的类型。1:便捷账号;2:RAM 账号;3:AD 账号;4:个人版。 |
3 |
| DisplayName |
string |
用户显示名,仅 AD 用户且 WithDetail=true 时返回。 |
Zhang San |
| DisplayNameNew |
string |
用户新版显示名,仅 AD 用户且 WithDetail=true 时返回。 |
Zhang San |
| DomainName |
string |
AD 域名。 |
example.com |
| EndUserId |
string |
终端用户 ID。 |
alice |
| NickName |
string |
用户昵称,仅便捷用户且 WithDetail=true 时返回。 |
小张 |
| RegionId |
string |
地域 ID。 |
cn-hangzhou |
| UserPrincipalName |
string |
用户主体名称(UPN),仅 AD 用户且 WithDetail=true 时返回。 |
alice@example.com |
| NextToken |
string |
下一页查询凭证。当结果超过一页时返回,可作为下一次请求的 NextToken 继续查询。仅在按单次连接明细统计时返回。 |
d129c6c0e8c04c8a9f0e2b7c1a3f5e6d |
| RequestId |
string |
本次请求的 ID。 |
1CBAFFAB-B697-4049-A9B1-67E1FC5F0F0F |
| TotalCount |
integer |
符合条件的记录总数。 |
100 |
示例
正常返回示例
JSON格式
{
"AuthUserConnectDurationList": [
{
"ConnectDuration": 3600,
"ConnectEndTime": "1719208800000",
"ConnectStartTime": "1719205200000",
"Description": "研发部员工",
"DesktopId": "ecd-gx2x1dhsmusr2****",
"DesktopName": "test-desktop",
"DirectoryType": 3,
"DisplayName": "Zhang San",
"DisplayNameNew": "Zhang San",
"DomainName": "example.com",
"EndUserId": "alice",
"NickName": "小张",
"RegionId": "cn-hangzhou",
"UserPrincipalName": "alice@example.com"
}
],
"NextToken": "d129c6c0e8c04c8a9f0e2b7c1a3f5e6d",
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F0F0F",
"TotalCount": 100
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。