路径参数

• jobId 字符串 必需

  jobId

  格式应符合以下模式：^[A-Za-z0-9\-]+$。

响应

• 200 application/json

  正常

  隐藏响应属性 显示响应属性 对象

  • id 字符串 必需

    格式应符合以下模式：^[A-Za-z0-9\-]+$。

  • projectId 字符串 必需

    格式应符合以下模式：^[A-Za-z0-9\-]+$。

  • 状态 字符串 必需

    取值为 NOT_STARTED、RUNNING、FAILED、CANCELLING、CANCELLED、COMPLETED、CLEANING_UP 或 PAUSED。

  • cdcStatus 字符串

    取值为 NOT_STARTED、RUNNING、COMPLETING、COMPLETED、FAILED、CANCELLED 或 PAUSED。默认值为 NOT_STARTED。

  • verificationJobId 字符串
  • 选项 对象 必需

    不允许使用其他属性。

    隐藏选项属性 显示选项属性 对象

    • 删除集合 布尔

      默认值为false 。

    • 模式 字符串 必需

      取值为 SNAPSHOT、CDC、INCREMENTAL 或 VERIFICATION。

    • truncationReportMode 字符串

      值为 FAIL、WARN 或 SKIP。

    • errorHandling 字符串

      定义 Debezium 错误是会引发异常还是仅被记录下来。https://debezium.io/documentation/reference/stable/connectors/mysql.html#mysql-property-event-processing-failure-handling-mode

      值为 FAIL、WARN 或 SKIP。

    • errorTolerance 整型

      终止迁移之前应允许的（记录级别）故障次数。该值严格大于或等于。

      最小值为 0。

    • incrementalSnapshotOptions 对象

      仅适用于增量迁移模式的选项。

      不允许使用其他属性。

      隐藏incrementalSnapshotOptions 属性 显示incrementalSnapshotOptions 属性 对象

      • signalingTable 字符串

        源数据库上的信令表用于协调增量快照。

      • chunkSize 整型

        每个增量快照数据数据块的行数 (Debezium增量.快照.数据数据块.大小)。如果省略，则应用 Debezium 的默认1024。数据段越大，复制速度越快，但每个打开的数据块窗口在内存中可容纳更多行。

        最小值为 1，最大值为 100000。

  • jdbcConnectionString 字符串
  • MongoDB 连接字符串 字符串
  • submittedAt string(date-time) 必需
  • 统计信息 对象

    不允许使用其他属性。

    隐藏统计属性 显示统计属性 对象

    • startedAt string(date-time)
    • elapsedSeconds integer(int64)
    • 剩余表计数 整型
    • processingTables array[string]
    • migeratedTables array[string]

      快照副本已完成的源表。完成是指源快照读取完毕，而不是每一行都迁移成功；发生故障时，此处列出的表也可能会出现在 failureError 中。

    • totalEventsSeen integer(int64)

      默认值为0 。

    • snapshotCompleted 布尔

      默认值为false 。

    • totalTableCount 整型
    • totalEvents integer(int64)
    • totalEventSize integer(int64)
  • cdcStatistics 对象

    不允许使用其他属性。

    隐藏 cdcStatistics 属性 显示 cdcStatistics 属性 对象

    • startedAt string(date-time)
    • lastEventTime string(date-time)
    • lastEventSourceDatabaseTime string(date-time)
    • eventsInLastHour integer(int64)

      默认值为0 。

    • eventsInLastMinute integer(int64)

      默认值为0 。

    • totalEventsSeen integer(int64)

      默认值为0 。

    • latestBatchMaxSourceDbLagMs integer(int64)

      对于每个已完成的MongoDB批处理写入，从源数据库中发生更改（由数据库报告）到批处理写入完成之间的最大时间延迟。这可能会受到源数据库时钟与运行迁移的计算机之间的时钟偏差的影响。

      默认值为-1 。

  • jmxConnectivity 对象

    JMX 统计抓取的连接性（仅适用于 kafka-connect 部署配置文件）。指示迁移器是否通过 JMX 成功抓取统计信息，以及上次抓取的时间，以便在用户界面中显示配置错误/无法访问的 JMX 终结点或崩溃的连接任务。对于不通过 JMX 读取统计信息的部署，此项不存在。

    不允许使用其他属性。

    隐藏 jmxConnectivity 属性 显示 jmxConnectivity 属性 对象

    • 状态 字符串 必需

      值为 AVAILABLE 或 UNAVAILABLE。

    • lastSuccessfulScrapeAt string(date-time)

      最近成功的 JMX 统计信息抓取时间。

    • 错误消息 字符串

      当统计信息不可用时，最近的 JMX 连接错误。

  • connectorStatus 对象

    支持此迁移作业的Kafka Connect 连接器的运行时状态（仅限 kafka-connect/confluent部署文件），反映Kafka Connect 报告的实际状态，而不是假设在提交时成功。让用户界面显示哪个特定Connector/任务有问题，而不是显示看起来正常但Connector出现故障的作业。不支持不受Kafka Connect 支持的部署。

    不允许使用其他属性。

    隐藏 connectorStatus 属性 显示 connectorStatus 属性 对象

    • 来源 对象

      一个Kafka ConnectConnector（源或接收器）及其任务的运行时状态。

      不允许使用其他属性。

      隐藏源属性 显示源属性 对象

      • 名称 字符串

        在Kafka Connect 中注册的连接器名称。

      • 州 字符串 必需

        Kafka Connect 报告Connector或其任务之一的运行时状态（请参阅https://kafka.apache.org/documentation/#connect_administration ）。 UNKNOWN 是 Relational Migrator 自身针对无法检索的状态的值，例如，当Kafka Connect 工作线程无法访问时。

        取值为 RUNNING、PAUSED、FAILED、UNASSIGNED、RESTARTING、STOPPED 或 UNKNOWN。

      • 任务 大量[对象]

        此Connector的每个任务运行时状态。

        隐藏任务属性 显示任务属性 对象

        单个Kafka Connect任务的运行时状态，由Kafka Connect 报告。

        • id 整型 必需

          Connector中的任务 ID。

        • 州 字符串 必需

          Kafka Connect 报告Connector或其任务之一的运行时状态（请参阅https://kafka.apache.org/documentation/#connect_administration ）。 UNKNOWN 是 Relational Migrator 自身针对无法检索的状态的值，例如，当Kafka Connect 工作线程无法访问时。

          取值为 RUNNING、PAUSED、FAILED、UNASSIGNED、RESTARTING、STOPPED 或 UNKNOWN。

        • workerId 字符串

          任务分配到的Kafka Connect 工作线程（如果已知）。

        • TRACE 字符串

          故障堆栈跟踪，在任务状态为 FAILED 时显示。

    • 接收器 对象

      一个Kafka ConnectConnector（源或接收器）及其任务的运行时状态。

      不允许使用其他属性。

      隐藏 Sink 属性 显示接收器属性 对象

      • 名称 字符串

        在Kafka Connect 中注册的连接器名称。

      • 州 字符串 必需

        Kafka Connect 报告Connector或其任务之一的运行时状态（请参阅https://kafka.apache.org/documentation/#connect_administration ）。 UNKNOWN 是 Relational Migrator 自身针对无法检索的状态的值，例如，当Kafka Connect 工作线程无法访问时。

        取值为 RUNNING、PAUSED、FAILED、UNASSIGNED、RESTARTING、STOPPED 或 UNKNOWN。

      • 任务 大量[对象]

        此Connector的每个任务运行时状态。

        隐藏任务属性 显示任务属性 对象

        单个Kafka Connect任务的运行时状态，由Kafka Connect 报告。

        • id 整型 必需

          Connector中的任务 ID。

        • 州 字符串 必需

          Kafka Connect 报告Connector或其任务之一的运行时状态（请参阅https://kafka.apache.org/documentation/#connect_administration ）。 UNKNOWN 是 Relational Migrator 自身针对无法检索的状态的值，例如，当Kafka Connect 工作线程无法访问时。

          取值为 RUNNING、PAUSED、FAILED、UNASSIGNED、RESTARTING、STOPPED 或 UNKNOWN。

        • workerId 字符串

          任务分配到的Kafka Connect 工作线程（如果已知）。

        • TRACE 字符串

          故障堆栈跟踪，在任务状态为 FAILED 时显示。

  • failureError 对象

    不允许使用其他属性。

    隐藏 failureError 属性 显示 failureError 属性 对象

    • errorType 字符串 必需
    • message 字符串 必需
    • failureAt string(date-time) 必需
    • setupError 布尔 必需

      默认值为false 。

    • failedLocation 字符串 | null

      作业失败前最后一个错误的位置。有关完整的错误细分，请参阅作业日志。

    • failedLocationType 字符串 | null

      TABLE = 源表，COLLECTION = 目标集合。

      值为 TABLE 或 COLLECTION。

  • metadata 对象

    不允许使用其他属性。

    Hide metadata attributes 显示元数据属性 对象

    • telemetryUserId 字符串
    • 验证 对象
      隐藏验证属性 显示验证属性 对象

      • samplePercentage 整型

        默认值为100 。

      • isEmbeddedMode 布尔

        默认值为false 。

      • 状态 字符串

        取值为 VERIFYING、FAILED、CANCELLING、CANCELLED、VERIFIED 或 ABORTED。

  • relationalTableFilters 对象

    一个对象，其中每个键代表一个模式名称。每个模式都包含可应用表筛选器的表。

    隐藏关系表筛选器属性 显示关系表筛选器属性 对象

    • * 对象 additionalProperties

      一个对象，其中每个键代表模式中的一个表名称。

      隐藏 * 属性 显示 * 属性 对象

      • * 对象 additionalProperties

        不允许使用其他属性。

        隐藏 * 属性 显示 * 属性 对象

        • whereClause 字符串

          用于过滤指定源表的行的SQL WHERE 子句的内容。

        • 行计数 integer(int64)

          从源表返回的行数限制（可选）。

          最小值为 1。

  • collectionFilters 对象

    在此迁移中包含或排除集合。

    • include only：只有与指定的包含过滤匹配的集合才会被迁移。
    • 仅排除：将迁移所有集合，但与排除过滤匹配的集合除外。
    • 包含和排除：迁移与包含过滤匹配的集合，并排除也与排除过滤匹配的集合。
    • 无筛选器：将迁移所有集合。
    隐藏 collectionFilters 属性 显示 collectionFilters 属性 对象

    • 包括 array[string]
    • 排除 array[string]
• 404 application/json

  未找到

  隐藏响应属性 显示响应属性 对象

  • errorType 字符串 必需

    标识发生的错误类别的错误类别。

  • message 字符串 必需

    对出错原因的人可读解释。

  • timestamp string(date-time) 必需

    发生错误的日期和时间。

  • 问题 大量[对象]

    构成此错误的单个问题。

    至少 1 个元素。

    隐藏问题属性 显示 问题 属性 对象

    • 类型 字符串 必需

      用于标识发生的问题类型的错误类别 (SNAKE_CASE)。

    • message 字符串 必需

      对出错原因的人可读解释。

    • 指针 字符串

      JSON Pointer (RFC 6901)，指向有问题的节点。

• 500 application/json

  内部服务器错误

  隐藏响应属性 显示响应属性 对象

  • errorType 字符串 必需

    标识发生的错误类别的错误类别。

  • message 字符串 必需

    对出错原因的人可读解释。

  • timestamp string(date-time) 必需

    发生错误的日期和时间。

  • 问题 大量[对象]

    构成此错误的单个问题。

    至少 1 个元素。

    隐藏问题属性 显示 问题 属性 对象

    • 类型 字符串 必需

      用于标识发生的问题类型的错误类别 (SNAKE_CASE)。

    • message 字符串 必需

      对出错原因的人可读解释。

    • 指针 字符串

      JSON Pointer (RFC 6901)，指向有问题的节点。