文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 报表统计/ 查询用户使用统计数据 - ListUserUsageMetric
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

查询用户使用统计数据 - ListUserUsageMetric

功能介绍

查询用户使用统计信息;

最多查询30天内的数据;

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    workspace:statistics:listUserMetrics

    List

    -

    -

    -

    -

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

enterprise_project_id

否

String

企业项目ID。

sort_field

否

String

按照指标进行排序

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

sort_type

否

String

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

  • DESC - 降序返回数据

  • ASC - 升序返回数据

offset

否

Integer

查询的偏移量,默认值0。

limit

否

Integer

limit范围[1-100],默认值0。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

count

Integer

总数。

items

Array of UserMetric objects

用户统计指标。
表4 UserMetric

参数

参数类型

描述

username

String

用户名称。

enterprise_project_id

String

企业项目ID。

metric

Array of Metric objects

桌面使用统计信息

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

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

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

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

参数

参数类型

描述

metric_name

String

指标名称。

metric_value

Double

指标值。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

无

响应示例

状态码：200

响应成功。

{
  "count" : 0,
  "items" : [ {
    "username" : "xxxx",
    "metric" : [ {
      "metric_name" : "desktop_state",
      "metric_value" : 10
    } ]
  } ]
}

状态码

状态码

描述

200

响应成功。

400

客户端请求有误。

401

鉴权失败。

500

内部错误。

错误码

请参见错误码。

父主题： 报表统计

相关文档