Help Center/ Data Security Center/ API Reference/ API Description/ Data Transfer/ Obtaining the Data Transfer Instance List
Updated on 2026-01-13 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the Data Transfer Instance List

Function

This API is used to obtain the data transfer instance list.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/logtrace/collect-instances

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which is used to identify a specific project.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

project_id

String

Project ID.

instance_type

String

Instance type.

instance_name

String

Instance name.

instance_id

String

Instance ID.

status_enum

String

Status.

status_msg

String

Status information.

last_heartbeat_time

String

Last heartbeat report time.

log_trace_switch

Boolean

Transfer monitoring switch.

Status code: 201

Created

Example Requests

GET /v1/{project_id}/logtrace/collect-instances

Example Responses

None

Status Codes

Status Code

Description

200

OK

201

Created

401

Unauthorized. The user is not logged in or the token is invalid.

403

Unauthorized to access the resource.

404

The specified project does not exist.

Error Codes

See Error Codes.

Parent topic: Data Transfer