Login Status Statistics
Function
Statistics on the login statuses of tenant desktops.
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}/desktops/statistics/login-state
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
No |
String |
MIME type of the request body. |
X-Auth-Token |
No |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
in_use_num |
Integer |
Number of desktops in use. |
unregistered_num |
Integer |
Number of unregistered desktops. |
unable_to_connect_num |
Integer |
Number of unregistered desktops. |
ready_num |
Integer |
Number of idle desktops. |
disconnected_num |
Integer |
Number of disconnected desktops. |
Status code: default
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 collecting statistics on the login statuses of desktops.
{ "in_use_num" : 0, "unregistered_num" : 0, "unable_to_connect_num" : 0, "ready_num" : 0, "disconnected_num" : 0 }
Status Codes
Status Code |
Description |
---|---|
200 |
Response to the request for collecting statistics on the login statuses of desktops. |
default |
Error response. |
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