更新时间:2024-03-21 GMT+08:00

查询用户使用统计数据

功能介绍

查询用户使用统计信息; 最多查询30天内的数据;

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/statistics/metrics/users

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

start_time

String

查询起始时间(0时区)

end_time

String

查询截至时间(0时区)

username

String

用户名(模糊匹配)

usage_min_hours

Integer

使用时长最小值

usage_max_hours

Integer

使用时长最大值 usage_min_hours和usage_max_hours同时存在时,usage_max_hours必须大于等于usage_min_hours

sort_field

String

按照指标进行排序

  • user_usage - 按照用户使用时长排序

sort_type

String

按照指标进行排序的方向;需配合sort_field一起使用

  • DESC - 降序返回数据

  • ASC - 升序返回数据

offset

Integer

查询的偏移量,默认值0

limit

Integer

单次查询的大小[1-100],默认值10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

总数

items

Array of UserMetric objects

用户统计指标

表5 UserMetric

参数

参数类型

描述

username

String

用户名称

metric

Array of Metric objects

桌面使用统计信息

  • user_usage - 用户使用时长(单位:秒),同一时间登录多台PC的话;相应的时间会累加

  • user_login_count - 用户登录次数(单位:次)

  • user_login_success_count - 用户登录成功次数(单位:次)

  • user_login_fail_count - 用户登录失败次数(单位:次)

表6 Metric

参数

参数类型

描述

metric_name

String

指标名称

metric_value

Double

指标值

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

响应示例

状态码

状态码

描述

200

响应成功

400

客户端请求有误

401

鉴权失败

500

内部错误

错误码

请参见错误码