Updated on 2026-02-10 GMT+08:00

Exporting Connection Records

Function

Exports connection records.

Data within a maximum of 30 days can be exported.

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, no identity policy-based permission required for calling this API.

URI

GET /v3/{project_id}/desktops/connections/export

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 time format is 2016-08-20T21:11:11Z. If the end time is not empty, the start time is optional. The start time must be within the last 30 days.

end_time

No

String

End time of the query. If this parameter is specified, all login records before the specified time are returned. The time format is 2016-08-20T21:11:11Z. If the start time is not empty, the start time is optional. The end time must be within the last 30 days.

user_name

No

String

Username for logging in to the desktop.

computer_name

No

String

Computer name, which is included in the OS information.

terminal_type

No

String

OS type of the terminal used to log in to the desktop, for example, Windows 10. Fuzzy search is supported.

language

No

String

Language of the exported records, which is English by default.

  • zh_CN: Chinese

  • en_US: English

min_e2e_rtt

No

Integer

Queries the minimum E1E latency.

max_e2e_rtt

No

Integer

Queries the maximum E1E latency.

enterprise_project_id

No

String

Enterprise project ID.

public_ip

No

String

Egress IP address of the client.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

task_id

String

Export task ID.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Task ID.

Error Codes

See Error Codes.