文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 连接信息/ 查询桌面登录状态
更新时间：2024-12-27 GMT+08:00
查看PDF
分享

查询桌面登录状态

功能介绍

该接口用于查询桌面登录状态。

调试

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

URI

GET /v2/{project_id}/desktops/status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

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

Content-Type

否

String

发送的实体的MIME类型。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

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

statics

Array of InstanceStatusStatistics objects

统计信息。
表4 InstanceStatusStatistics

参数

参数类型

描述

static_name

String

统计对象名称(虚拟机组名称、桌面组名称)。

running_num

Integer

运行数目(运行中、启动中、故障迁移中、迁移中)。

stop_num

Integer

关机数目(关机中、已关机)。

hibernate_num

Integer

休眠数目(休眠中、已休眠)。

other_num

Integer

其他(未知、删除失败、删除中)。

in_use_num

Integer

使用中数目。

unregistered_num

Integer

未注册数目。

ready_num

Integer

空闲数目。

disconnected_num

Integer

断开连接数目。

unknown_num

Integer

未知数目。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

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

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

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

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

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

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

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

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

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

请求示例

无

响应示例

状态码： 200

查询计算机登录状态响应。

{
  "error_code" : "string",
  "error_msg" : "string",
  "encoded_authorization_message" : "string",
  "statics" : [ {
    "static_name" : "string",
    "running_num" : 2147483647,
    "stop_num" : 2147483647,
    "hibernate_num" : 2147483647,
    "other_num" : 2147483647,
    "attached_num" : 2147483647,
    "unattached_num" : 2147483647,
    "cannot_attach_num" : 2147483647,
    "in_process_num" : 2147483647,
    "in_use_num" : 2147483647,
    "unregistered_num" : 2147483647,
    "ready_num" : 2147483647,
    "disconnected_num" : 2147483647,
    "unknown_num" : 2147483647
  } ]
}

状态码

状态码

描述

200

查询计算机登录状态响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误，具体返回错误码请参见错误码说明。

错误码

请参见错误码。

父主题： 连接信息

相关文档