文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 桌面统计/ 查询在指定时间段未使用的桌面
更新时间：2023-09-18 GMT+08:00
查看PDF
分享

查询在指定时间段未使用的桌面

功能介绍

查询在指定时间段未使用的桌面。

调试

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

URI

GET /v2/{project_id}/desktops/statistics/unused

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

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

limit

否

Integer

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

start_time

否

String

开始时间：由日期加时间组成，UTC格式，格式：yyyy-MM-ddTHH:mm:ss.SSSZ，若未输入，则查询现在到前一天的未使用的桌面。

end_time

否

String

结束时间：由日期加时间组成，UTC格式，格式：yyyy-MM-ddTHH:mm:ss.SSSZ，若未输入，则查询现在到前一天的未使用的桌面。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

否

String

发送的实体的MIME类型。

X-Auth-Token

是

String

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

unused_desktops

Array of UnusedDesktopInfo objects

指定时间段内未使用桌面列表。

total_count

Integer

总数。
表5 UnusedDesktopInfo

参数

参数类型

描述

desktop_id

String

桌面id。

compute_name

String

桌面名称。

create_time

String

桌面创建时间。

disconnect_time

String

最近一次断连时间。

状态码： default

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

/v2/13d4944fcfc7448893f50d81a6a2edd3/desktops/statistics/unused

响应示例

状态码： 200

查询在指定时间段未使用的桌面响应。

{
  "unused_desktops" : [ {
    "desktop_id" : "e0367f84-1d64-498e-9b92-093002ac3ce8",
    "compute_name" : "ZYZ08",
    "create_time" : "2022-08-08T02:34:05.202Z",
    "disconnect_time" : "2022-08-08T02:39:00.000Z"
  }, {
    "desktop_id" : "b8eb2ac0-4540-4409-857f-df5e2de07546",
    "compute_name" : "wangyan8301",
    "create_time" : "2022-08-08T02:34:05.202Z",
    "disconnect_time" : "2022-08-08T02:39:00.000Z"
  } ],
  "total_count" : 2
}

状态码

状态码

描述

200

查询在指定时间段未使用的桌面响应。

default

错误响应。

错误码

请参见错误码。

父主题： 桌面统计

相关文档