文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 桌面统计/ 查询使用桌面的时长
更新时间：2024-01-11 GMT+08:00
查看PDF
分享

查询使用桌面的时长

功能介绍

查询使用桌面的时长。

调试

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

URI

POST /v2/{project_id}/desktops/statistics/used

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

否

String

发送的实体的MIME类型。

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

desktop_ids

否

Array of strings

桌面id集合。

start_time

否

String

开始时间，格式：yyyy-MM-dd（UTC时间，不传查默认最近15天）最多查31天数据。

end_time

否

String

结束时间，格式：yyyy-MM-dd（UTC时间，不传查默认最近15天）最多查31天数据。

group_by_type

否

String

统计方式，不传则默认按天。可选值为：

  • DAY: 按天。

  • HOUR: 按小时。

desktop_username

否

String

若传桌面的用户名，则查询使用时间只有该用户的使用时间。

offset

否

Integer

从查询结果中的第几条数据开始返回,用于分页查询，取值范围0-2000，默认从0开始。

limit

否

Integer

查询结果中想要返回的信息条目数量,用于分页查询，取值范围0-100，默认值100。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

desktop_used_info_list

Array of DesktopUsedHoursInfo objects

桌面使用信息（以桌面Id划分）。

total_count

Integer

总数。
表5 DesktopUsedHoursInfo

参数

参数类型

描述

desktop_id

String

桌面Id。

desktop_username

String

使用的用户。

used_info_list

Array of DesktopUsedInfo objects

桌面使用时间列表。
表6 DesktopUsedInfo

参数

参数类型

描述

date

String

日期，格式：yyyy-MM-dd（UTC时间）。

use_time

String

总共在线时间单位:小时数（h）,精确到两位小数，如：1.32。

状态码： default

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

无

响应示例

状态码： 200

查询使用桌面的时长响应。

{
  "desktop_used_info_list" : [ {
    "desktop_id" : "c6e6dbd7-c950-471d-a6a7-01d0fb62f450",
    "used_info_list" : [ {
      "date" : "2022-12-09",
      "use_time" : 12.62
    }, {
      "date" : "2022-12-10",
      "use_time" : 2.62
    }, {
      "date" : "2022-12-11",
      "use_time" : 1.02
    }, {
      "date" : "2022-12-12",
      "use_time" : 0
    }, {
      "date" : "2022-12-13",
      "use_time" : 0
    }, {
      "date" : "2022-12-14",
      "use_time" : 3.87
    }, {
      "date" : "2022-12-15",
      "use_time" : 3.56
    } ]
  }, {
    "desktop_id" : "d5367f84-1d64-498e-9b92-093002ac6ce9",
    "used_info_list" : [ {
      "date" : "2022-12-09",
      "use_time" : 10.56
    }, {
      "date" : "2022-12-10",
      "use_time" : 1.38
    }, {
      "date" : "2022-12-11",
      "use_time" : 0
    }, {
      "date" : "2022-12-12",
      "use_time" : 0
    }, {
      "date" : "2022-12-13",
      "use_time" : 0
    }, {
      "date" : "2022-12-14",
      "use_time" : 3.87
    }, {
      "date" : "2022-12-15",
      "use_time" : 3.56
    } ]
  } ],
  "total_count" : 2
}

状态码

状态码

描述

200

查询使用桌面的时长响应。

default

错误响应。

错误码

请参见错误码。

父主题： 桌面统计

相关文档