本接口用于查询数据迁移或数据同步任务运行步骤的详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Id | string | 是 | 数据迁移或数据同步任务的 ID。 | np_4w3a**** |
返回参数
StepInfo 数据结构
不同步骤的 stepInfo 参数返回不同的字段。
-
TRANSFER_APP_SWITCH（正向切换）
参数 类型 描述 checkpointSampleTimestamp long 位点采集时间。格式为 Unix timestamp，单位为秒。 -
INCR_TRANSFER（增量同步）
参数 类型 描述 incrTimestampCheckpoint long 位点时间。格式为 Unix timestamp，单位为秒。 checkpointSampleTimestamp long 位点采集时间。格式为 Unix timestamp，单位为秒。 enableIncrStatistics boolean 是否开启 DML/DDL 统计。 -
FULL_VERIFIER（全量校验）和 FULL_TRANSFER（全量迁移）
参数 类型 描述 processedRecords long 已完成迁移行数/实际行数。 capacity long 预估总行数。 srcRps long 源端读取 RPS，单位为记录数/秒。 srcRt string 源端读取 RT，单位为毫秒/条。 srcIops long 源端读取流量，单位为字节数/秒。 dstRps long 目标端读取/写入 RPS，单位为记录数/秒。 dstRt long 目标端读取/写入 RT，单位为毫秒/条。 dstIops long 目标端读取/写入流量，单位为字节数/秒。 srcRpsRef long 源端读取 RPS 的基准值。 dstRpsRef long 目标端读取/写入 RPS 的基准值。 dstRtRef long 目标端读取/写入 RT 基准值。
示例
正常返回示例
JSON格式
{
"Success": true,
"ErrorDetail": {
"Code": "CM-RESOAT1111",
"Level": "ERROR",
"Message": "A system error occurred.",
"ExtraContext": {
"key": "null"
},
"MessageMcmsKey": "null",
"MessageMcmsContext": {
"key": "null"
},
"Reason": "null",
"ReasonMcmsKey": "null",
"ReasonMcmsContext": {
"key": "null"
},
"Proposal": "Contact the administrator. ",
"ProposalMcmsKey": "null",
"ProposalMcmsContext": {
"key": "null"
},
"UpstreamErrorDetail": "null"
},
"Code": "INNER_ERROR",
"Message": "A system error occurred.",
"Advice": "Contact the administrator. ",
"RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 4,
"Cost": "1",
"Data": [
{
"Order": 1,
"Name": "PRE_CHECK",
"Description": "预检查",
"Status": "RUNNING",
"ExtraInfo": {
"ErrorDetails": [
{
"Code": "CM-RESOAT1111",
"Level": "ERROR",
"Message": "A system error occurred.",
"ExtraContext": {
"key": "null"
},
"MessageMcmsKey": "null",
"MessageMcmsContext": {
"key": "null"
},
"Reason": "null",
"ReasonMcmsKey": "null",
"ReasonMcmsContext": {
"key": "null"
},
"Proposal": "null",
"ProposalMcmsKey": "null",
"ProposalMcmsContext": {
"key": "null"
},
"UpstreamErrorDetail": "null"
}
],
"ErrorCode": "INNER_ERROR",
"ErrorMsg": "The ResourceDirectoryId is invalid.",
"ErrorParam": {
"key": "null"
},
"FailedTime": "null"
},
"StartTime": "2020-05-22T17:04:18",
"FinishTime": "2020-05-22T17:04:18",
"Progress": 100,
"StepInfo": null
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-05-07 | API 内部配置变更，不影响调用 | 查看变更详情 |