Querying Desktop Connection Statuses
Function
Queries desktop connection 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}/connect-desktops
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
user_names |
No |
Array of strings |
Desktop user. Up to 100 users can be filtered in batches. |
connect_status |
No |
String |
Desktop connection status.
|
offset |
No |
Integer |
Sequence number of the first data record to be returned. This parameter is used for pagination query. The value ranges from 0 (default) to 2,000. |
limit |
No |
Integer |
Number of data records to be returned in the query result. This parameter is used for pagination query. The value ranges from 0 to 2,000. The default value is 100. |
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 |
---|---|---|
desktops |
Array of ConnectDesktopsInfo objects |
Desktop connection data list. |
total_count |
Integer |
Total number of desktops. |
Parameter |
Type |
Description |
---|---|---|
desktop_id |
String |
Desktop ID. |
desktop_name |
String |
Desktop name. |
connect_status |
String |
Desktop connection status.
|
attach_users |
Array of AttachUsersInfo objects |
List of users or user groups to which desktops have been assigned. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
If type is set to USER, enter the user ID. If type is set to GROUP, enter the user group ID. The backend service checks whether the group ID exists. |
name |
String |
Name of the object assigned with a desktop. If type is set to USER, enter the username. If type is set to GROUP, enter the user group name.
|
user_group |
String |
User group to which the desktop user belongs.
|
type |
String |
Object type. Options:
|
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
/v2/0bec5db98280d2d02fd6c00c2de791ce/connect-desktops
Example Responses
Status code: 200
Response to the request for querying cloud desktop details.
{ "desktops" : [ { "desktop_id" : "string", "desktop_name" : "string", "connect_status" : "string", "attach_users" : [ { "id" : "string", "name" : "string", "user_group" : "string", "type" : "USER" } ] } ], "total_count" : 0 }
Status Codes
Status Code |
Description |
---|---|
200 |
Response to the request for querying cloud desktop details. |
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