文档

DescribeProjectProgress - 查询项目的进度

更新时间:

本接口用于查询数据迁移或数据同步项目的进度信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Idstring

数据迁移或数据同步项目的 ID。

np_4w3a****

返回参数

名称类型描述示例值
object

返回结果。

Successboolean

是否调用成功。

true
ErrorDetailobject

错误详情。

Codestring

错误码(新)。

CM-RESOAT1111
Levelstring

包括 FATAL、ERROR、WARNING 和 CRITICAL。

ERROR
Messagestring

错误描述(新)。

A system error occurred.
ExtraContextobject

用于填充 Message 中的占位符。

any

用于填充 Message 中的占位符。

null
MessageMcmsKeystring

错误信息的 Key。

null
MessageMcmsContextobject

用于填充 MessageMcmsKey 中的占位符。

string

用于填充 MessageMcmsKey 中的占位符。

null
Reasonstring

错误原因。

null
ReasonMcmsKeystring

错误原因的 Key。

null
ReasonMcmsContextobject

错误原因的上下文。

string

错误原因的上下文。

null
Proposalstring

建议(新)。

null
ProposalMcmsKeystring

建议内容的 Key。

null
ProposalMcmsContextobject

建议内容的上下文。

string

建议内容的上下文。

null
UpstreamErrorDetailany

上游错误详情,用于处理 HTTP 请求。

null
Codestring

错误码(旧)。

INNER_ERROR
Messagestring

错误描述(旧)。

A system error occurred.
Advicestring

建议(旧)。

Contact the administrator.
RequestIdstring

请求 ID。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
PageNumberinteger

页序号,分页查询时生效。

1
PageSizeinteger

页大小,分页查询时生效

1
TotalCountlong

总数,分页查询时生效。

1
Coststring

请求耗时,单位为秒。

1
Dataobject

项目进度的相关信息。

ProjectIdstring

项目的 ID。

np_fe****
Statusstring

项目的状态,包括 INIT(未启动)、RUNNING(运行中)、SUSPEND(已暂停)、FAILED(已失败)、FINISHED(已完成)、RELEASING(释放中)、RELEASED(已释放)、DELETED(已删除)、RUNNING_MODIFYING(修改中)和 RUNNING_MERGING。

RUNNING
AlarmLevelstring

告警保障等级,包括 HIGH(高保护状态)、MEDIUM(中保护状态)、LOW(低保护状态)和 IGNORE(无保护状态)。

MEDIUM
EnableIncrSyncboolean

是否有正向增量同步。

true
CurrentStepstring

当当前项目运行所处的步骤(PRE_CHECK, TRANSFER_PRECHECK, PREPARE, STRUCT_TRANSFER, STRUCT_MIGRATION, INDEX_MIGRATION, INDEX_TRANSFER, STRUCT_SYNC, FULL_MIGRATION, FULL_TRANSFER, APP_SWITCH, TRANSFER_APP_SWITCH, REVERSE_INCR_SYNC, REVERSE_INCR_TRANSFER, FULL_VALIDATION, FULL_VERIFIER, INCR_LOG_PULL, TRANSFER_INCR_LOG_PULL, INCR_SYNC, INCR_TRANSFER, INCR_VERIFIER, SYNC_PREPARE, TRANSFER_PREPARE, SYNC_INCR_LOG_PULL, CONNECTOR_FULL_SYNC, CONNECTOR_INCR_SYNC)。

PRE_CHECK
IncrSyncCheckpointlong

正向增量同步位点。当源端为 DB2 LUW、OceanBase、MySQL 或 Oracle 数据库时,格式均为 Unix timestamp,单位为秒。

1689248064
EnableStructTransferboolean

是否有结构传输。

true
EnableFullTransferboolean

是否有全量数据传输。

true
StructTransferProgressinteger

结构传输进度的百分比,取值范围为 0~100。

100
FullTransferProgressinteger

全量传输进度的百分比,取值范围为 0~100。

100
EnableReverseIncrTransferboolean

是否有反向增量同步。

true
ReverseIncrTransferCheckpointlong

反向增量同步位点。格式为 Unix timestamp,单位为秒。

1689248075

示例

正常返回示例

JSON格式

{
  "Success": true,
  "ErrorDetail": {
    "Code": "CM-RESOAT1111\n",
    "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"
  },
  "Code": "INNER_ERROR",
  "Message": "A system error occurred.",
  "Advice": "Contact the administrator. ",
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "PageNumber": 1,
  "PageSize": 1,
  "TotalCount": 1,
  "Cost": "1",
  "Data": {
    "ProjectId": "np_fe****",
    "Status": "RUNNING",
    "AlarmLevel": "MEDIUM",
    "EnableIncrSync": true,
    "CurrentStep": "PRE_CHECK",
    "IncrSyncCheckpoint": 1689248064,
    "EnableStructTransfer": true,
    "EnableFullTransfer": true,
    "StructTransferProgress": 100,
    "FullTransferProgress": 100,
    "EnableReverseIncrTransfer": true,
    "ReverseIncrTransferCheckpoint": 1689248075
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-05-07API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (0)