文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 报表统计/ 登录状态统计 - ListLoginState
更新时间:2026-01-07 GMT+08:00

登录状态统计 - ListLoginState

功能介绍

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

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    workspace:statistics:getLoginState

    Read

    -

    -

    -

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

in_use_num

Integer

使用中。

unregistered_num

Integer

未注册数目。

unable_to_connect_num

Integer

未注册数目。

ready_num

Integer

空闲数目。

disconnected_num

Integer

断开连接数目。

状态码:default

表3 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

请求示例

GET /v2/9565be6e740941c493b38a1f46ecae6f/desktops/statistics/login-state

响应示例

状态码:200

登录状态统计响应。

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

状态码

状态码

描述

200

登录状态统计响应。

default

错误响应。

错误码

请参见错误码