DescribeProjectSteps - 查询项目步骤的详情 - 云数据库 OceanBase

本接口用于查询数据迁移或数据同步项目运行步骤的详情。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
Id	string	是	数据迁移或数据同步项目的 ID。	np_4w3a****

返回参数

名称	类型	描述	示例值
	object	返回结果。
Success	boolean	是否调用成功。	true
ErrorDetail	object	错误详情。
Code	string	错误码（新）。	CM-RESOAT1111
Level	string	包括 FATAL、ERROR、WARNING 和 CRITICAL。	ERROR
Message	string	错误描述（新）。	A system error occurred.
ExtraContext	object	用于填充 Message 中的占位符。
	any	用于填充 Message 中的占位符。	null
MessageMcmsKey	string	错误信息的 Key。	null
MessageMcmsContext	object	用于填充 MessageMcmsKey 中的占位符。
	string	用于填充 MessageMcmsKey 中的占位符。	null
Reason	string	错误原因。	null
ReasonMcmsKey	string	错误原因的 Key。	null
ReasonMcmsContext	object	错误原因的上下文。
	string	错误原因的上下文。	null
Proposal	string	建议（新）。	Contact the administrator.
ProposalMcmsKey	string	建议内容的 Key。	null
ProposalMcmsContext	object	建议内容的上下文。
	string	建议内容的上下文。	null
UpstreamErrorDetail	any	上游错误详情，用于处理 HTTP 请求。	null
Code	string	错误码（旧）。	INNER_ERROR
Message	string	错误描述（旧）。	A system error occurred.
Advice	string	建议（旧）。	Contact the administrator.
RequestId	string	请求 ID。	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
PageNumber	integer	页序号，分页查询时生效。	1
PageSize	integer	页大小，分页查询时生效。	10
TotalCount	long	总数，分页查询时生效。	4
Cost	string	请求耗时，单位为秒。	1
Data	array<object>	项目步骤的相关信息。
Data	object	项目步骤的相关信息。
Order	integer	步骤的运行顺序。	1
Name	string	步骤的名称。	PRE_CHECK
Description	string	步骤描述，包括预检查、结构迁移、结构同步、全量迁移、全量同步、全量校验、索引迁移、增量日志拉取、增量同步、增量校验和正向切换。	预检查
Status	string	步骤的运行状态，包括 INIT（初始化）、RUNNING（运行中）、FAILED（失败）、 FINISHED（已完成）、SUSPEND（已暂停）、MONITORING（持续监控状态，用于增量同步和增量校验的持续监控态）。	RUNNING
ExtraInfo	object	补充信息。
ErrorDetails	array<object>	错误详情。
ErrorDetail	object
Code	string	错误码（新）。	CM-RESOAT1111
Level	string	包括 FATAL、ERROR、WARNING 和 CRITICAL。	ERROR
Message	string	错误描述（新）。	A system error occurred.
ExtraContext	object	用于填充 Message 中的占位符。
	any	用于填充 Message 中的占位符。	null
MessageMcmsKey	string	错误信息的 Key。	null
MessageMcmsContext	object	用于填充 MessageMcmsKey 中的占位符。
	string	用于填充 MessageMcmsKey 中的占位符。	null
Reason	string	错误原因。	null
ReasonMcmsKey	string	错误原因的 Key。	null
ReasonMcmsContext	object	错误原因的上下文。
	string	错误原因的上下文。	null
Proposal	string	建议。	null
ProposalMcmsKey	string	建议内容的 Key。	null
ProposalMcmsContext	object	建议内容的上下文。
	string	建议内容的上下文。	null
UpstreamErrorDetail	any	上游错误详情，用于处理 HTTP 请求。	null
ErrorCode	string	错误码。	INNER_ERROR
ErrorMsg	string	错误描述。	The ResourceDirectoryId is invalid.
ErrorParam	object	错误的相关参数。
	string	错误相关参数。	null
FailedTime	string	错误时间。	null
StartTime	string	开始时间，以 UTC + 0 时区的时间格式展示。	2020-05-22T17:04:18
FinishTime	string	结束时间，以 UTC + 0 时区的时间格式展示。	2020-05-22T17:04:18
Progress	integer	步骤的运行进度。	100
StepInfo	object	各步骤的运行详情。具体包含的信息请参见《StepInfo 数据结构》。	null

StepInfo 数据结构

不同步骤的 stepInfo 参数返回不同的字段。

TRANSFER_APP_SWITCH（正向切换）

参数类型描述
checkpointSampleTimestamp long 位点采集时间。格式为 Unix timestamp，单位为秒。

参数	类型	描述
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 内部配置变更，不影响调用	查看变更详情