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.
URI
GET /v2/{project_id}/connections/status
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Content-Type |
No |
String |
MIME type of the request body. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
statics |
Array of InstanceStatusStatistics objects |
Statistics. |
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
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error description. |
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
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error description. |
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
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error description. |
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
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error description. |
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
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error description. |
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
None
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, see the error code description. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot