查询DTS任务的监控指标
更新时间 2026-06-16 17:02:32
最近更新时间: 2026-06-16 17:02:32
接口功能介绍
查询 DTS 任务的监控指标。
接口约束
无
URI
POST /dts/v2/open-api/instance/describeMonitorData
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | 200000001790 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| dtsJobId | 是 | Integer | 任务id | 778899001122 | |
| metricNames | 是 | Array of Strings | 监控指标名称：SOURCE_FULL_BPS (全量阶段源端每秒读取的流量),TARGET_FULL_BPS (全量阶段目标端每秒写入的流量),SOURCE_FULL_RPS (全量阶段源端每秒读取的行数),TARGET_FULL_RPS (全量阶段目标端每秒写入的行数),SOURCE_SYNC_BPS (增量阶段源端每秒读取的流量),TARGET_SYNC_BPS (增量阶段目标端每秒写入的流量),SOURCE_SYNC_RPS (增量阶段源端每秒读取的行数),TARGET_SYNC_RPS (增量阶段目标端每秒写入的行数),SOURCE_SYNC_DELAY_TIME (增量阶段的读取延迟),TARGET_SYNC_DELAY_TIME (增量阶段的写入延迟),SOURCE_NET_DELAY_TIME (源端网络延迟),TARGET_NET_DELAY_TIME (目标端网络延迟),TARGET_FULL_EXECUTE_RT (全量阶段目标端单条记录写入消耗的时间),TARGET_SYNC_EXECUTE_RT (增量阶段目标端做单条记录写入消耗的时间) | ["SOURCE_FULL_BPS","TARGET_FULL_RPS"] | |
| beginTime | 否 | String | 开始时间 | 2026-06-09 00:00:00 | |
| endTime | 否 | String | 结束时间 | 2026-06-09 23:59:59 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| httpStatusCode | Integer | 状态码 | ||
| errCode | String | 错误码 | ||
| errMessage | String | 提示信息 | ||
| success | Boolean | 请求是否成功 | ||
| requestId | String | 请求id | ||
| data | Object | DTS监控指标数据 | DtsMetricsVO |
表 DtsMetricsVO
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| planConfigId | Integer | 任务ID | ||
| metrics | Map of String | 监控指标，键为指标名称、值为指标集合；无数据时不保留对应指标键，详见示例 | MetricUnits |
表 MetricUnit
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| pointTime | String | 数据时间点 | ||
| pointValue | Double | 监控指标数值 |
枚举参数
无
请求示例
请求url
https://{host}/dts/v2/open-api/instance/describeMonitorData
请求头header
无
请求体body
{
"dtsJobId": "513",
"beginTime": "2026-06-10 18:11:44",
"endTime": "2026-06-11 18:11:44",
"metricNames": [
"SOURCE_FULL_BPS",
"TARGET_FULL_BPS",
"SOURCE_FULL_RPS",
"TARGET_FULL_RPS"
]
}
响应示例
{
"httpStatusCode": 200,
"success": true,
"requestId": "00-6a2a89e5e287ec6ca4d18c11bc387183-8625e9c6b4a5d744-00",
"data": {
"planConfigId": 513,
"metrics": {
"SOURCE_FULL_RPS": [
{
"pointTime": "2026-06-11 17:07:05",
"pointValue": 0.0
},
{
"pointTime": "2026-06-11 17:07:25",
"pointValue": 0.0
}
],
"TARGET_FULL_BPS": [
{
"pointTime": "2026-06-11 17:07:05",
"pointValue": 0.0
},
{
"pointTime": "2026-06-11 17:07:25",
"pointValue": 0.0
}
],
"SOURCE_FULL_BPS": [
{
"pointTime": "2026-06-11 17:07:05",
"pointValue": 0.0
},
{
"pointTime": "2026-06-11 17:07:25",
"pointValue": 0.0
}
],
"TARGET_FULL_RPS": [
{
"pointTime": "2026-06-11 17:07:05",
"pointValue": 0.0
},
{
"pointTime": "2026-06-11 17:07:25",
"pointValue": 0.0
}
]
}
}
}
状态码
请参考 状态码
错误码
请参考 错误码
