查询参数

• sort 字符串

  检索结果的顺序

  格式应符合以下模式：^\w+,(DESC|ASC)$。默认值为 submittedAt,DESC。

• limit 整型

  限制结果

  最小值为 0。

• 类型 字符串

  仅筛选特定作业类型的作业

  值为 IN_PROGRESS。

• projectId 字符串

  按 projectId 筛选职位

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

响应

• 200 application/json

  正常

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

  • id 字符串 必需

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

  • projectId 字符串 必需

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

  • 状态 字符串 必需

    Values are NOT_STARTED, RUNNING, FAILED, CANCELLING, CANCELLED, COMPLETED, CLEANING_UP, or 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 对象

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

      不允许使用其他属性。

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

      • signalingTable 字符串

        源数据库上的信令表用于协调增量快照。接受模式.table（MySQL：数据库.table），其中包含从源连接或完整数据库中获取的数据库段。 模式名称。

      • chunkSize 整型

        每个增量快照数据块的行数 (Debezium incremental.snapshot.chunk.size)。如果省略，则应用 Debezium 的默认值 1024。较大的数据块复制速度较快，但每个开放数据块窗口在内存中保持的行数较多。

        Minimum value is 1, maximum value is 100000.

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

    不允许使用其他属性。

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

    • startedAt string(date-time)
    • elapsedSeconds integer(int64)
    • 剩余表计数 整型
    • processingTables array[string]
    • migratedTables 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 报告的实际状态，而不是假设提交时成功。允许用户界面显示具体的连接器/任务存在问题，而不是在连接器失败时显示健康的作业。不适用于未由 Kafka Connect 支持的部署。

    不允许使用其他属性。

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

    • 来源 对象

      一个 Kafka Connect 连接器（源或目标）及其任务的运行时状态。

      不允许使用其他属性。

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

      • 名称 字符串

        在 Kafka Connect 中注册的 Connector 名称。

      • 州 字符串 必需

        Kafka Connect 为连接器或其任务之一报告的运行时状态（请参阅 https://kafka.apache.org/documentation/#connect_administration）。UNKNOWN 是 Relational Migrator 自己的值，用于无法检索的状态，例如 Kafka Connect 工作进程无法访问。

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

      • 任务 大量[对象]

        此连接器的每个任务运行时状态。

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

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

        • id 整型 必需

          连接器内的任务 ID。

        • 州 字符串 必需

          Kafka Connect 为连接器或其任务之一报告的运行时状态（请参阅 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 Connect 连接器（源或目标）及其任务的运行时状态。

      不允许使用其他属性。

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

      • 名称 字符串

        在 Kafka Connect 中注册的 Connector 名称。

      • 州 字符串 必需

        Kafka Connect 为连接器或其任务之一报告的运行时状态（请参阅 https://kafka.apache.org/documentation/#connect_administration）。UNKNOWN 是 Relational Migrator 自己的值，用于无法检索的状态，例如 Kafka Connect 工作进程无法访问。

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

      • 任务 大量[对象]

        此连接器的每个任务运行时状态。

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

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

        • id 整型 必需

          连接器内的任务 ID。

        • 州 字符串 必需

          Kafka Connect 为连接器或其任务之一报告的运行时状态（请参阅 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 string | null

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

    • failedLocationType string | 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]
• 500 application/json

  内部服务器错误

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

  • errorType 字符串 必需

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

  • message 字符串 必需

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

  • timestamp string(date-time) 必需

    发生错误的日期和时间。

  • 问题 大量[对象]

    构成此错误的单个问题。

    At least 1 element.

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

    • 类型 字符串 必需

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

    • message 字符串 必需

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

    • 指针 字符串

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