查询复制任务状态
查询指定复制任务的状态信息,包括当前执行的子任务、进度和增量延迟。
请求地址:/openapi/v1/replication/status
请求方法:GET
请求参数
| 参数 | 类型 | 是否必选 | 说明 | 示例 |
|---|---|---|---|---|
| replicationId | String | 是 | 复制任务 ID。 | rp-div0t0awwobr |
返回参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| success | Boolean | 请求是否成功。 | true |
| requestId | String | 请求 ID。 | Zo7y2QBS-djkcnZHncghz7KWdekc9PRT |
| data | Object | 复制任务状态详情,字段见data 字段说明。 | 见下方示例 |
data 字段说明
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| replicationId | String | 复制任务 ID。 | rp-div0t0awwobr |
| status | String | 任务状态,取值见任务状态枚举。 | running |
| currentSubTaskType | String | 当前执行的子任务类型,取值见子任务类型枚举。 | inc_writer |
| subTaskList | Array | 子任务列表,元素字段见子任务字段说明。 | 见下方示例 |
子任务字段说明
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| subTaskType | String | 子任务类型,取值见子任务类型枚举。 | schema |
| status | String | 子任务状态,取值见任务状态枚举。 | success |
| percent | Number | 子任务进度百分比,取值范围为 0 到 100。增量复制子任务运行时通常返回 0。 | 100.0 |
| delay | Integer | 增量同步延迟,单位为毫秒。非增量子任务可能不返回该字段。 | 0 |
调用成功示例
{
"success": true,
"requestId": "Zo7y2QBS-djkcnZHncghz7KWdekc9PRT",
"data": {
"replicationId": "rp-div0t0awwobr",
"status": "running",
"currentSubTaskType": "inc_writer",
"subTaskList": [
{
"subTaskType": "schema",
"status": "success",
"percent": 100.0
},
{
"subTaskType": "full",
"status": "success",
"percent": 100.0
},
{
"subTaskType": "inc_writer",
"status": "running",
"percent": 0.0,
"delay": 0
}
]
}
}
任务状态枚举
createSuccess、preChecking、preCheckSuccess、preCheckFailed、notStarted、starting、running、success、failed、suspended、abnormal、stopped、locked。
子任务类型枚举
| 取值 | 说明 |
|---|---|
| schema | 结构复制。 |
| full | 全量复制。 |
| inc_writer | 增量复制。 |
| trigger | 触发器复制。 |