查询任务监控指标
查询数据复制任务或数据对比任务的监控指标。
请求地址：/openapi/v1/metrics/query
请求方法：POST
请求参数
| 参数 | 类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| metrics | Array | 是 | 指标名称列表。支持一次传入多个指标名称。不同任务类型支持的指标不同，详见下文指标名称。 | ["replicationThroughput", "readThroughput", "replicationRps", "readRps"] |
| taskId | String | 是 | 任务 ID。 | cd-001 |
| taskType | String | 是 | 任务类型，可选值：replication、dataCompare。 | dataCompare |
| startTime | String | 是 | 查询开始时间，UTC 时间。 | 2025-04-20T01:08:19Z |
| endTime | String | 是 | 查询结束时间，UTC 时间。 | 2025-04-27T01:08:19Z |
指标名称
数据复制
| 指标名称 | 说明 |
|---|---|
| replicationThroughput | 复制吞吐量，每秒钟任务执行的数据量。 |
| replicationRps | 复制 RPS，每秒钟写入目标实例的记录数。 |
| readThroughput | 读取吞吐量，每秒从源实例读取的数据量。 |
| readRps | 读取 RPS，每秒从源实例读取的记录数。 |
| replicationDelay | 复制延迟，全链路端到端的复制延迟。 |
| queueAccumulation | 队列堆积记录数。 |
| writeThroughput | 写入吞吐量。 |
| writeRps | 写入 RPS。 |
| readDelay | 读取延迟。 |
数据库对比
| 指标名称 | 说明 |
|---|---|
| compareRps | 对比 RPS。 |
请求示例
{
"taskId": "cd-001",
"taskType": "dataCompare",
"metrics": [
"compareRps"
],
"startTime": "2025-04-20T01:08:19Z",
"endTime": "2025-04-27T01:08:19Z"
}
返回参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| success | Boolean | 请求是否成功。 | true |
| requestId | String | 请求 ID。 | Ur7o6YBI-hnnnpXAniojy7VDdhlu0ZKL |
| data | Array | 监控指标结果列表。 | { "readDelay": "180.5", "readRps": "34.9", "time": "2026-04-24 08:48:00Z", "readThroughput": "14948.5" } |
调用成功示例
{
"success": true,
"requestId": "Ur7o6YBI-hnnnpXAniojy7VDdhlu0ZKL",
"data": [
{
"readDelay": "180.5",
"readRps": "34.9",
"time": "2026-04-24 08:48:00Z",
"readThroughput": "14948.5"
},
{
"readDelay": "0.0",
"readRps": "0.0",
"time": "2026-04-24 10:02:08Z",
"readThroughput": "0.0"
}
]
}