查询任务监控指标

查询数据复制任务或数据对比任务的监控指标。

请求地址：/openapi/v1/metrics/query

请求方法：POST

请求参数

参数	类型	是否必填	说明	示例
metrics	Array	是	指标名称列表。支持一次传入多个指标名称。不同任务类型支持的指标不同，详见下文指标名称。	["replicationThroughput", "readThroughput", "replicationRps", "readRps"]
taskId	String	是	任务 ID。复制场景传入复制任务 ID，对比场景传入数据对比任务 ID。	rp-di3twoi1mjzx
taskType	String	是	任务类型，可选值：replication、dataCompare。	replication
startTime	String	是	查询开始时间，UTC 时间。	2026-04-27T00:00:00Z
endTime	String	是	查询结束时间，UTC 时间。	2026-04-28T08:00:00Z

指标名称

数据复制

指标名称	说明
replicationThroughput	复制吞吐量，每秒钟任务执行的数据量。
replicationRps	复制 RPS，每秒钟写入目标实例的记录数。
readThroughput	读取吞吐量，每秒从源实例读取的数据量。
readRps	读取 RPS，每秒从源实例读取的记录数。
replicationDelay	复制延迟，全链路端到端的复制延迟。
queueAccumulation	队列堆积记录数。
writeThroughput	写入吞吐量。
writeRps	写入 RPS。
readDelay	读取延迟。

数据复制指标别名

部分调用场景也可使用如下指标名。返回数据中的字段名与请求传入的指标名保持一致。

指标名称	说明
ReaderLatency	读取延迟。
ReplicationLatency	复制延迟。
ReaderThroughput	读取吞吐量，每秒从源实例读取的数据量。
ReplicationThroughput	复制吞吐量，每秒复制到目标实例的数据量。
ReaderRPS	读取 RPS，每秒从源实例读取的记录数。
WriterRPS	写入 RPS，每秒写入目标实例的记录数。
PendingRecords	堆积记录数。

数据库对比

指标名称	说明
compareRps	对比 RPS。

请求示例

{
  "taskId": "rp-di3twoi1mjzx",
  "taskType": "replication",
  "metrics": [
    "replicationThroughput",
    "replicationRps",
    "replicationDelay"
  ],
  "startTime": "2026-04-27T00:00:00Z",
  "endTime": "2026-04-28T08:00:00Z"
}

返回参数

参数	类型	说明	示例
success	Boolean	请求是否成功。	true
requestId	String	请求 ID。	Ik5z4TZX-flllvBUnhkga4PMdggi6PND
data	Array	监控指标结果列表。每个元素包含 time 字段和本次请求返回的指标值字段。	{ "replicationThroughput": "2222435.3", "replicationRps": "11670.9", "time": "2026-04-27 09:46:40Z" }

调用成功示例

{
  "success": true,
  "requestId": "Ik5z4TZX-flllvBUnhkga4PMdggi6PND",
  "data": [
    {
      "replicationThroughput": "2222435.3",
      "replicationRps": "11670.9",
      "time": "2026-04-27 09:46:40Z"
    },
    {
      "replicationThroughput": "5014587.6",
      "replicationRps": "26237.8",
      "time": "2026-04-27 10:10:00Z"
    },
    {
      "time": "2026-04-27 10:52:30Z",
      "replicationDelay": "1899538.8"
    }
  ]
}