Queries login information.

Function

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/desktops

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
start_time	No	String	Start time of the query. If this parameter is specified, all login records after the specified time are returned. The format is 2016-08-20T21:11Z. If the end time is specified, the start time is mandatory.
end_time	No	String	End time of the query. If this parameter is specified, all login records before the specified time are returned. The format is 2016-08-20T21:11Z. If the start time is specified, the end time is mandatory.
user_name	No	String	Username for logging in to the desktop.
computer_name	No	String	Computer name, which is displayed in the OS information.
terminal_type	No	String	System type of the terminal used to log in to the desktop. Currently, the value can be WI (Workspace client).
limit	No	String	Pagination query. The value ranges from 0 to 100 and defaults to 20.
offset	No	String	Start position for pagination query. The value starts from 0.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	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	Yes	String	MIME type of the request body, for example, application/json.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_count	Integer	Total number of user login records.
records	Array of Record objects	User login record.

**Table 5** Record
Parameter	Type	Description
computer_name	String	Computer name.
user_name	String	Username.
terminal_mac	String	Terminal MAC address.
terminal_name	String	Terminal name.
terminal_ip	String	Terminal IP address.
client_version	String	AccessClient version.
terminal_type	String	Terminal OS type.
agent_version	String	AccessAgent version.
desktop_ip	String	Desktop IP address.
connection_start_time	String	Time when a connection starts.
connection_setup_time	String	Time when a connection is set up.
connection_end_time	String	Time when a connection ends.
is_reconnect	Boolean	Whether to reconnect.
connection_failure_reason	String	Connection failure cause.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 405

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 503

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

GET /v2/0e69423d4400f4a82f67c0059a1e4cc8/connections/desktops?offset=258

Example Responses

Status code: 200

{
  "total_count" : 4,
  "records" : [ {
    "computer_name" : "JY011",
    "user_name" : "jy01@local.com",
    "terminal_mac" : "00-ac-9c-c7-9a-df",
    "terminal_name" : "DESKTOP-EG0P3TR",
    "terminal_ip" : "8.5.60.58",
    "client_version" : "1.8.00005",
    "terminal_type" : "Windows 10",
    "agent_version" : "1.8.00005.10546",
    "desktop_ip" : "172.16.148.250",
    "connection_start_time" : "2020-04-24T03:02:47Z",
    "connection_setup_time" : "2020-04-24T03:02:49Z",
    "connection_end_time" : "2020-04-24T03:36:43Z",
    "is_reconnect" : false
  }, {
    "computer_name" : "JY011",
    "user_name" : "jy01@local.com",
    "terminal_mac" : "00-ac-9c-c7-9a-df",
    "terminal_name" : "DESKTOP-EG0P3TR",
    "terminal_ip" : "8.5.60.58",
    "client_version" : "1.8.00005",
    "terminal_type" : "Windows 10",
    "agent_version" : "1.8.00005.10546",
    "desktop_ip" : "172.16.148.250",
    "connection_start_time" : "2020-04-23T08:58:02Z",
    "connection_setup_time" : "2020-04-23T08:58:05Z",
    "connection_end_time" : "2020-04-23T22:45:00Z",
    "is_reconnect" : false
  } ]
}

Status Codes

Status Code	Description
200	Login information query response.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	You do not have required permissions.
404	No resource found.
405	The request method is not allowed.
500	An internal service error occurred. For details about the error code, see the error code description.
503	The service is unavailable.