更新时间:2025-07-09 GMT+08:00

登录状态统计

功能介绍

查询租户桌面登录状态统计。

调试

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

URI

GET /v2/{project_id}/desktops/statistics/login-state

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

发送的实体的MIME类型。

X-Auth-Token

String

用户Token。

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

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

in_use_num

Integer

使用中。

unregistered_num

Integer

未注册数目。

unable_to_connect_num

Integer

未注册数目。

ready_num

Integer

空闲数目。

disconnected_num

Integer

断开连接数目。

状态码:default

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

响应示例

状态码:200

登录状态统计响应。

{
  "in_use_num" : 0,
  "unregistered_num" : 0,
  "unable_to_connect_num" : 0,
  "ready_num" : 0,
  "disconnected_num" : 0
}

状态码

状态码

描述

200

登录状态统计响应。

default

错误响应。

错误码

请参见错误码