Help Center/ Data Replication Service/ API Reference/ APIs V3.0 (Deprecated)/ Real-Time Disaster Recovery Management/ Querying DR Monitoring Data
Updated on 2025-11-19 GMT+08:00
View PDF

Querying DR Monitoring Data

Function

This API is used to query DR monitoring data based on the task ID.

Constraints

You can call a maximum of 10 APIs in batches.

URI

POST /v3/{project_id}/jobs/disaster-recovery-monitoring-data

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

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

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

The content type.

The default value is application/json.

X-Auth-Token

Yes

String

User token obtained from IAM.

X-Language

No

String

Request language type

Default value: en-us

Values:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

jobs

Yes

Array of strings

Task query request body.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

results

Array of objects

DR monitoring data response body set.

For details, see Table 5.

count

Integer

Total number of queries.
Table 5 Data structure description of field results

Parameter

Type

Description

id

String

Task ID.

data_guard_minitor

object

DR task monitoring data.

For details, see Table 6.
Table 6 Data structure description of field data_guard_minitor

Parameter

Type

Description

bandwidth

String

Bandwidth.

cpuUsed_percent

String

CPU usage.

dst_delay

Long

Delay of the destination database.

dst_io

String

Destination database I/O.

dst_normal

Boolean

Connection status of the destination database.

dst_offset

String

Offset of the destination database.

dst_rps

String

destination database RPS.

mem_used_inMB

String

Memory usage

node_mem_inMB

Long

Total memory size of a node.

node_offset

String

Offset of the replication instance.

node_volume_inGB

Long

Total disk size of a node.

sr_delay

Long

Delay of the source database.

sr_offset

String

Offset of the source database.

src_io

String

Source database I/O.

src_normal

Boolean

Connection status of the source database.

src_rps

String

Source database RPS.

trans_inMB

String

Amount of migrated data

trans_lines

String

Number of rows to be migrated.

volume_used_inGB

String

Disk usage.

migration_bytes_per_second

Long

Number of bytes migrated per second.

Example Request

Example of querying DR monitoring data:

https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/disaster-recovery-monitoring-data

{
  "jobs" : [ "9a470239-2308-4bb5-a6bc-1040402fjb21" ]
}

Example Response

Status code: 200

OK

{
  "results" : [ {
    "id" : "b683ea69-a29c-456f-952f-2b682180jb52",
    "data_guard_minitor" : {
      "src_normal" : true,
      "dst_normal" : true,
      "sr_offset" : "mysql-bin.000445:191",
      "node_offset" : "mysql-bin.000445:191",
      "dst_offset" : "N/A",
      "sr_delay" : 0,
      "dst_delay" : 81046806,
      "src_rps" : "0",
      "src_io" : "0.0",
      "bandwidth" : "37",
      "dst_rps" : "0",
      "dst_io" : "0.0",
      "trans_inMB" : "0",
      "trans_lines" : "0",
      "volume_used_inGB" : "5",
      "mem_used_inMB" : "2166",
      "cpuUsed_percent" : "1.4",
      "node_volume_inGB" : 100,
      "node_mem_inMB" : 8192,
      "migration_bytes_per_second": 789456
    }
  } ],
  "count" : 1
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.