Help Center/ Data Replication Service/ API Reference/ APIs V5.0/ Task Details/ Querying Monitoring Data
Updated on 2026-09-07 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Monitoring Data

Function

This API is used to obtain task monitoring data.

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 and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

GET /v5/{project_id}/jobs/{job_id}/monitor-data

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

job_id

Yes

String

Definition

Task ID, which uniquely identifies a data replication task and serves as the identifier for operations such as query, modification, and deletion.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Definition

MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type.

Constraints

N/A

Range

application/json

Default Value

application/json

X-Auth-Token

Yes

String

Definition

User token obtained from IAM. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The token is the value of X-Subject-Token in the response header.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us: English
  • zh-cn: Chinese

Default Value

en-us

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

bandwidth

String

Definition

EIP bandwidth, which is used to evaluate whether the public network transmission rate meets the migration requirements. Unit: MB/s.

Constraints

N/A

Range

N/A

is_src_normal

Boolean

Definition

Whether the source database connection is normal.

Constraints

N/A

Range

  • true: The source database connection is normal.
  • false: The source database connection is abnormal.

is_dst_normal

Boolean

Definition

Whether the destination database connection is normal.

Constraints

N/A

Range

  • true: The destination database connection is normal.
  • false: The destination database connection is abnormal.

src_offset

String

Definition

Offset position of the source database, which is used to determine the data synchronization progress of the source database.

Constraints

N/A

Range

N/A

node_offset

String

Definition

Offset position of the replication instance, which is used to determine the data synchronization progress of the replication instance.

Constraints

N/A

Range

N/A

dst_offset

String

Definition

Offset position of the destination database, which is used to determine the data synchronization progress of the destination database.

Constraints

N/A

Range

N/A

src_delay

Integer

Definition

Source database delay, which is used to determine the real-time performance of data synchronization.

Constraints

N/A

Range

N/A

dst_delay

Integer

Definition

Destination database delay, which is used to determine the real-time performance of data synchronization.

Constraints

N/A

Range

N/A

src_rps

String

Definition

Requests per second (RPS) of the source database, which is used to evaluate the data change rate of the source database.

Constraints

N/A

Range

N/A

src_io

String

Definition

Input/Output (I/O) of the source database, which is used to evaluate the disk read/write load of the source database.

Constraints

N/A

Range

N/A

dst_rps

String

Definition

RPS of the destination database, which is used to evaluate the data write rate of the destination database.

Constraints

N/A

Range

N/A

dst_io

String

Definition

I/O of the destination database, which is used to evaluate the disk read/write load of the destination database.

Constraints

N/A

Range

N/A

trans_data

String

Definition

Amount of migrated data, which is used to evaluate the migration progress. Unit: MB.

Constraints

N/A

Range

N/A

trans_lines

String

Definition

Number of migrated rows, which is used to evaluate the migration progress.

Constraints

N/A

Range

N/A

used_volumes

String

Definition

Disk usage of the replication instance, which is used to monitor the storage capacity of the replication instance. Unit: GB.

Constraints

N/A

Range

N/A

used_memory

String

Definition

Memory usage of the replication instance, which is used to monitor the memory consumption of the replication instance. Unit: MB.

Constraints

N/A

Range

N/A

used_cpu_percent

String

Definition

CPU usage (%) of the replication instance, which is used to monitor the computing load of the replication instance.

Constraints

N/A

Range

N/A

node_volume_size

Integer

Definition

Total disk size of the replication instance, which is used together with used_volumes to evaluate the disk usage. Unit: GB.

Constraints

N/A

Range

N/A

node_memory_size

Integer

Definition

Total memory size of the replication instance, which is used together with used_memory to evaluate the memory usage. Unit: MB.

Constraints

N/A

Range

N/A

update_time

String

Definition

Time when the monitoring data is updated. The value is in UTC format, for example, 2023-07-19T03:09:25Z.

Constraints

N/A

Range

N/A

apply_rate

Integer

Definition

Synchronization speed, which is used to evaluate the data replay rate. Unit: byte/s.

Constraints

N/A

Range

N/A

Example Request

Querying task monitoring data

https://{endpoint}/v5/04f9aca88c00d3202fd4c01ed679daf0/jobs/ee5ed538-90c6-4f70-bd2e-ac084abjb502/monitor-data

Example Response

Status code: 200

OK

{
  "bandwidth" : "37",
  "is_src_normal" : true,
  "is_dst_normal" : true,
  "src_offset" : "mysql-bin.000646:196",
  "node_offset" : "mysql-bin.000646:196",
  "dst_offset" : "mysql-bin.000646:196",
  "src_delay" : 0,
  "dst_delay" : 0,
  "src_rps" : "0",
  "src_io" : "0.0",
  "dst_rps" : "0",
  "dst_io" : "0.0",
  "trans_data" : "0",
  "trans_lines" : "29",
  "used_volumes" : "4",
  "used_memory" : "2124",
  "used_cpu_percent" : "1.4",
  "node_volume_size" : 500,
  "node_memory_size" : 8192,
  "update_time" : "2023-07-19T03:09:25Z",
  "apply_rate" : 0
}

Status Code

Status Code

Description

200

OK

For other statuses, see Status Code.

Error Code

For details, see Error Code.

Parent topic: Task Details