查询复制任务指标
查询指定复制任务在指定时间范围内的监控指标。单次查询的时间范围不能超过 1 天。
请求地址:/openapi/v1/replication/metrics/query
请求方法:GET
请求参数
| 参数 | 类型 | 是否必选 | 说明 | 示例 |
|---|---|---|---|---|
| replicationId | String | 是 | 复制任务 ID。 | rp-div0t0awwobr |
| metricsTypes | Array | 是 | 指标类型列表,取值见指标类型枚举。可使用逗号分隔值,例如 metricsTypes=readRps,writeRps。 | readRps,writeRps,replicationDelay,pendingRecords |
| beginMillis | Long | 是 | 查询开始时间,Unix 毫秒时间戳。 | 1780041679619 |
| endMillis | Long | 是 | 查询结束时间,Unix 毫秒时间戳。 | 1780045279619 |
返回参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| success | Boolean | 请求是否成功。 | true |
| requestId | String | 请求 ID。 | Nd7x4PFS-flmetNVneijx5SEdgme5SXN |
| data | Object | 指标查询结果,字段见data 字段说明。 | 见下方示例 |
data 字段说明
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| replicationId | String | 复制任务 ID。 | rp-div0t0awwobr |
| metricsValues | Array | 指标数据点列表。每个元素包含 ts 和请求的指标字段,指标值以数字字符串返回。 | 见下方示例 |
metricsValues 字段说明
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| ts | Long | 数据点时间,Unix 毫秒时间戳。 | 1780044000000 |
| readDelay | String | 读取延迟。仅请求该指标时返回。 | "0.0" |
| readThroughput | String | 读取吞吐。仅请求该指标时返回。 | "0.0" |
| readRps | String | 读取 RPS。仅请求该指标时返回。 | "0.0" |
| replicationDelay | String | 复制延迟。仅请求该指标时返回。 | "0.0" |
| writeThroughput | String | 写入吞吐。仅请求该指标时返回。 | "0.0" |
| writeRps | String | 写入 RPS。仅请求该指标时返回。 | "0.0" |
| pendingRecords | String | 待处理记录数。仅请求该指标时返回。 | "0.0" |
调用成功示例
{
"success": true,
"requestId": "Nd7x4PFS-flmetNVneijx5SEdgme5SXN",
"data": {
"replicationId": "rp-div0t0awwobr",
"metricsValues": [
{
"readRps": "0.0",
"ts": 1780043776000
},
{
"writeRps": "0.0",
"replicationDelay": "0.0",
"pendingRecords": "0.0",
"ts": 1780044000000
}
]
}
}
指标类型枚举
readDelay、readThroughput、readRps、replicationDelay、writeThroughput、writeRps、pendingRecords。