文档

DescribeProjectComponents - 查询项目的组件信息

更新时间:

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

调试

您可以在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

页大小,分页查询时生效。

10
TotalCountlong

总数,分页查询时生效。

9
Coststring

请求耗时,单位为秒。

48
Dataobject

数据

StoreListobject []

增量拉取组件 Store 列表。

Namestring

Store 组件的名称。

xxx.xxx.xxx.1-7145:OB_ORACLE_np_4w3r***_4w:0000***97
Ipstring

Store 组件所在的 IP 地址。

xxx.xxx.xxx.1
Regionstring

Store 组件所在的地域。

cn-shanghai
Topicstring

Topic。

OB_ORACLE_np_4w3r29c_4w3****
Subtopicstring

SubTopic。

OB_ORACLE_np_4w3***c_4w3**-0
Tpslong

每秒处理的事务数(Transactions Per Second,TPS)。

0
Delaylong

延迟时间,单位为秒。

24
Gmtlong

位点采集时间。

1689250049
Connlong

连接数。

1
Statusstring

状态,包括 EXCEPTION(Store 运行异常)、ACTIVE(Store 正常运行中)、STOP(Store 人为操作停止)、UNEXPECTED_EXIT(Store reader 非预期退出)和 CHANGE_SOURCE。

EXCEPTION
ErrorDetailsobject []

错误详情。

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
ToSwitchboolean

是否需要主备切换,供 HA 判断。

false
Portinteger

对外服务端口。

2883
StorePortinteger

Store 组件的端口。

2882
BeginCheckpointstring

开始安全位点。

2023-07-13T09:19:53
EndCheckpointstring

结束安全位点。

2023-07-13T09:19:53
ErrMsgstring

当前错误信息。

null
GmtCreatestring

创建时间,以 UTC + 0 时区的时间格式展示。

2023-07-13T17:29:54
GmtModifiedstring

更新时间,以 UTC + 0 时区的时间格式展示。

2023-07-13T17:29:54
LatelyHeartbeatTimeSeclong

最近一次心跳时间戳。

1689250071
ReverseStoreListobject []

反向增量拉取组件列表。

Namestring

反向增量拉取组件的名称。

xxx.xxx.xxx.1-9000:connector_v2:np_4w****9jxc-incr_trans-1-0:0000000277
Ipstring

反向增量组件所在的 IP 地址。

xxx.xxx.xxx.1
Regionstring

反向增量组件所在的地域。

cn-shenzhen
Topicstring

Topic。

null
Subtopicstring

SubTopic。

null
Tpslong

每秒处理的事务数(Transactions Per Second,TPS)。

1
Delaylong

延迟时间,单位为秒。

1
Gmtlong

位点采集时间。

1689250071
Connlong

连接数。

1
Statusstring

状态,包括 EXCEPTION(Store 运行异常)、ACTIVE(Store 正常运行中)、STOP(Store 人为操作停止)、UNEXPECTED_EXIT(Store reader 非预期退出)和 CHANGE_SOURCE。

EXCEPTION
ErrorDetailsobject []

错误详情。

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
ToSwitchboolean

是否需要主备切换,供 HA 判断。

false
Portinteger

对外服务端口。

2883
StorePortinteger

Store 组件的端口。

2882
BeginCheckpointstring

开始安全位点。

2023-07-13T09:19:53
EndCheckpointstring

结束安全位点。

2023-07-13T09:19:53
ErrMsgstring

当前错误信息。

null
GmtCreatestring

创建时间,以 UTC + 0 时区的时间格式展示。

2023-07-13T18:04:36
GmtModifiedstring

更新时间,以 UTC + 0 时区的时间格式展示。

2023-07-13T18:04:36
LatelyHeartbeatTimeSeclong

最近一次心跳时间戳。

1689250071
FullVerifyComponentsobject []

全量校验组件列表。

Regionstring

全量校验组件所在的地域。

cn-beijing
Namestring

全量校验组件的名称。

xxx.xxx.xxx.1-9000:90247:0000000033
InconsistentQuantitylong

校验不一致的数量。

0
ConsistentQuantitylong

校验一致的数量。

100
Progressstring

表级别的进度。

100
RecordProgressinteger

记录级别的进度。

100
Statusstring

全量校验组件的状态,包括 INIT、RUNNING、DONE、FAILED、SHUTDOWNED 和 DELETED。

RUNNING
ErrorDetailsobject []

错误信息。

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
Ipstring

全量校验组件所在的 IP 地址。

xxx.xxx.xxx.1
TaskIdlong

全量校验组件的 ID。

1345***
FullImportComponentsobject []

全量导入组件列表。

Regionstring

全量导入组件所在的地域。

cn-hangzhou
Namestring

全量导入组件的名称。

xxx.xxx.xxx.1-9000:connector_v2:np_4w8v****c-full_trans-1-0:0000000276
Ipstring

全量导入组件所在的 IP 地址。

xxx.xxx.xxx.1
Identitystring

项目 ID。

p_4w8v****
Progressinteger

全量导入组件的进度。

90
Statusstring

全量导入组件的状态,包括 RUNNING、STOPPED、EXCEPTION 和 FINISHED。

RUNNING
GmtCreatestring

创建时间,以 UTC + 0 时区的时间格式展示。

2023-07-13T18:04:36
GmtModifystring

更新时间,以 UTC + 0 时区的时间格式展示。

2023-07-13T18:04:36
ErrorDetailsobject []

错误信息。

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
IncrSyncComponentsobject []

增量同步组件列表。

Regionstring

增量同步组件所在的地域。

cn-zhangjiakou
Namestring

增量同步组件的名称。

xxx.xxx.xxx.1-9000:connector_v2:np_4w****jxc-incr_trans-1-0:0000000277
Ipstring

增量同步组件所在的 IP 地址。

xxx.xxx.xxx.1
Identitystring

项目 ID。

np_4w***
Subtopicsarray

SubTpoics 集合。

string

SubTopic。

null
Statusstring

状态,包括 RUNNING、STOPPED、EXCEPTION 和 FINISHED。

RUNNING
Checkpointstring

当前位点,以 UTC + 0 时区的时间格式展示。

2023-07-13T09:19:53
Tpslong

每秒处理的事务数(Transactions Per Second,TPS)。

1
Delaylong

延迟时间,单位为秒。

1
CheckpointSampleTimestamplong

位点采集时间,单位为秒。

1689250071
GmtCreatestring

创建时间,以 UTC + 0 时区的时间格式展示。

2023-07-13T18:04:36
GmtModifystring

修改时间,以 UTC + 0 时区的时间格式展示。

2023-07-13T18:04:36
ErrorDetailsobject []

错误信息。

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
ReverseIncrSyncComponentsobject []

反向增量同步组件。

Regionstring

反向增量同步组件所在的地域。

cn-shanghai
Namestring

反向增量同步组件的名称。

xxx.xxx.xxx.1-9000:connector_v2:np_4w8****9jxc-incr_trans-1-0:0000000277
Ipstring

反向增量同步组件所在的 IP 地址。

xxx.xxx.xxx.1
Identitystring

项目 ID。

np_4w8****
Subtopicsarray

Subtopics 集合。

string

Subtopic。

null
Statusstring

状态,包括 RUNNING、STOPPED、EXCEPTION 和 FINISHED。

RUNNING
Checkpointstring

当前位点,以 UTC + 0 时区的时间格式展示。

2023-07-13T09:19:53
Tpslong

每秒处理的事务数(Transactions Per Second,TPS)。

1
Delaylong

延迟时间,单位为秒。

1
CheckpointSampleTimestamplong

位点采集时间,单位为秒。

1689250049
GmtCreatestring

创建时间,以 UTC + 0 时区的时间格式展示。

2023-07-13T18:04:36
GmtModifystring

修改时间,以 UTC + 0 时区的时间格式展示。

2023-07-13T18:04:36
ErrorDetailsobject []

错误信息。

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

示例

正常返回示例

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": 10,
  "TotalCount": 9,
  "Cost": "48",
  "Data": {
    "StoreList": [
      {
        "Name": "xxx.xxx.xxx.1-7145:OB_ORACLE_np_4w3r***_4w:0000***97",
        "Ip": "xxx.xxx.xxx.1",
        "Region": "cn-shanghai",
        "Topic": "OB_ORACLE_np_4w3r29c_4w3****",
        "Subtopic": "OB_ORACLE_np_4w3***c_4w3**-0",
        "Tps": 0,
        "Delay": 24,
        "Gmt": 1689250049,
        "Conn": 1,
        "Status": "EXCEPTION",
        "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"
          }
        ],
        "ToSwitch": false,
        "Port": 2883,
        "StorePort": 2882,
        "BeginCheckpoint": "2023-07-13T09:19:53",
        "EndCheckpoint": "2023-07-13T09:19:53",
        "ErrMsg": "null",
        "GmtCreate": "2023-07-13T17:29:54",
        "GmtModified": "2023-07-13T17:29:54",
        "LatelyHeartbeatTimeSec": 1689250071
      }
    ],
    "ReverseStoreList": [
      {
        "Name": "xxx.xxx.xxx.1-9000:connector_v2:np_4w****9jxc-incr_trans-1-0:0000000277",
        "Ip": "xxx.xxx.xxx.1",
        "Region": "cn-shenzhen",
        "Topic": "null",
        "Subtopic": "null",
        "Tps": 1,
        "Delay": 1,
        "Gmt": 1689250071,
        "Conn": 1,
        "Status": "EXCEPTION",
        "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"
          }
        ],
        "ToSwitch": false,
        "Port": 2883,
        "StorePort": 2882,
        "BeginCheckpoint": "2023-07-13T09:19:53",
        "EndCheckpoint": "2023-07-13T09:19:53",
        "ErrMsg": "null",
        "GmtCreate": "2023-07-13T18:04:36",
        "GmtModified": "2023-07-13T18:04:36",
        "LatelyHeartbeatTimeSec": 1689250071
      }
    ],
    "FullVerifyComponents": [
      {
        "Region": "cn-beijing",
        "Name": "xxx.xxx.xxx.1-9000:90247:0000000033",
        "InconsistentQuantity": 0,
        "ConsistentQuantity": 100,
        "Progress": "100",
        "RecordProgress": 100,
        "Status": "RUNNING",
        "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"
          }
        ],
        "Ip": "xxx.xxx.xxx.1",
        "TaskId": 0
      }
    ],
    "FullImportComponents": [
      {
        "Region": "cn-hangzhou",
        "Name": "xxx.xxx.xxx.1-9000:connector_v2:np_4w8v****c-full_trans-1-0:0000000276",
        "Ip": "xxx.xxx.xxx.1",
        "Identity": "p_4w8v****",
        "Progress": 90,
        "Status": "RUNNING",
        "GmtCreate": "2023-07-13T18:04:36",
        "GmtModify": "2023-07-13T18:04:36",
        "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"
          }
        ]
      }
    ],
    "IncrSyncComponents": [
      {
        "Region": "cn-zhangjiakou",
        "Name": "xxx.xxx.xxx.1-9000:connector_v2:np_4w****jxc-incr_trans-1-0:0000000277",
        "Ip": "xxx.xxx.xxx.1",
        "Identity": "np_4w***",
        "Subtopics": [
          "null"
        ],
        "Status": "RUNNING",
        "Checkpoint": "2023-07-13T09:19:53",
        "Tps": 1,
        "Delay": 1,
        "CheckpointSampleTimestamp": 1689250071,
        "GmtCreate": "2023-07-13T18:04:36",
        "GmtModify": "2023-07-13T18:04:36",
        "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"
          }
        ]
      }
    ],
    "ReverseIncrSyncComponents": [
      {
        "Region": "cn-shanghai",
        "Name": "xxx.xxx.xxx.1-9000:connector_v2:np_4w8****9jxc-incr_trans-1-0:0000000277",
        "Ip": "xxx.xxx.xxx.1",
        "Identity": "np_4w8****",
        "Subtopics": [
          "null"
        ],
        "Status": "RUNNING",
        "Checkpoint": "2023-07-13T09:19:53",
        "Tps": 1,
        "Delay": 1,
        "CheckpointSampleTimestamp": 1689250049,
        "GmtCreate": "2023-07-13T18:04:36",
        "GmtModify": "2023-07-13T18:04:36",
        "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"
          }
        ]
      }
    ]
  }
}

错误码

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

变更历史

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