Querying Desktop Login Statuses

Function

Queries desktop login statuses.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:desktops:getConnectStatus	Read	-	-	-	-

URI

GET /v2/{project_id}/connections/status

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
statics	Array of InstanceStatusStatistics objects	Statistics.

**Table 3** InstanceStatusStatistics
Parameter	Type	Description
static_name	String	Statistical object name (VM group name or desktop group name).
running_num	Integer	Number of active desktops (running, starting, failover, or migrating).
stop_num	Integer	Number of stopped desktops (stopping and stopped).
hibernate_num	Integer	Number of hibernated desktops (hibernating and hibernated).
other_num	Integer	Desktops in other statuses, such as unknown, deletion failed, and deleting.
attached_num	Integer	Number of assigned desktops.
unattached_num	Integer	Number of desktops not assigned.
cannot_attach_num	Integer	Number of desktops that cannot be assigned (assignment failed, unassignment failed, and unassigned).
in_process_num	Integer	Number of desktops being assigned or unassigned.
in_use_num	Integer	Number of desktops in use.
unregistered_num	Integer	Number of unregistered desktops.
ready_num	Integer	Number of idle desktops.
disconnected_num	Integer	Number of disconnected desktops.
unknown_num	Integer	Number of unknown desktops.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

GET /v2/0bec5db98280d2d02fd6c00c2de791ce/connections/status

Example Responses

Status code: 200

Response to the request for querying desktop login statuses.

{
  "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
  } ]
}

Status Codes

Status Code	Description
200	Response to the request for querying desktop login statuses.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
500	An internal service error occurred. For details about the error code, see the error code description.