Help Center/ Data Security Center/ API Reference/ API Description/ Data Transfer/ Enabling Data Transfer Monitoring for an Instance
Updated on 2026-01-13 GMT+08:00

Enabling Data Transfer Monitoring for an Instance

Function

This API is used to enable data transfer monitoring for an instance.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/logtrace/collect-instances/open

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

instances

No

instances object

Instance information.

Table 3 instances

Parameter

Mandatory

Type

Description

instance_id

No

String

Instance ID.

instance_type

No

String

Instance type.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

msg

String

Returned message

status

String

Return status, for example, '200', '400'.

Status code: 201

Created

Example Requests

POST /v1/{project_id}/logtrace/collect-instances/open

{
  "instances" : {
    "instance_type" : "string",
    "instance_id" : "string"
  }
}

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.