获取 /jobs/{jobId}

通过ID获取迁移作业的状态

路径参数

  • jobId 字符串 必需

    jobId

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

响应

  • 200 application/json

    正常

    隐藏响应属性 显示响应属性 对象
    • id 字符串 必需

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

    • projectId 字符串 必需

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

    • 状态 字符串 必需

      取值为 NOT_STARTEDRUNNINGFAILEDCANCELLINGCANCELLEDCOMPLETEDCLEANING_UPPAUSED

    • cdcStatus 字符串

      取值为 NOT_STARTEDRUNNINGCOMPLETINGCOMPLETEDFAILEDCANCELLEDPAUSED。默认值为 NOT_STARTED

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

      不允许使用其他属性。

      隐藏选项属性 显示选项属性 对象
    • jdbcConnectionString 字符串
    • MongoDB 连接字符串 字符串
    • submittedAt string(date-time) 必需
    • 统计信息 对象

      不允许使用其他属性。

      隐藏统计属性 显示统计属性 对象
      • startedAt string(date-time)
      • elapsedSeconds integer(int64)
      • 剩余表计数 整型
      • processingTables array[string]
      • 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

    • failureError 对象

      不允许使用其他属性。

      隐藏 failureError 属性 显示 failureError 属性 对象
      • errorType 字符串 必需
      • message 字符串 必需
      • failureAt string(date-time) 必需
      • setupError 布尔 必需

        默认值为false

    • metadata 对象

      不允许使用其他属性。

      Hide metadata attributes 显示元数据属性 对象
      • telemetryUserId 字符串
      • 验证 对象
        隐藏验证属性 显示验证属性 对象
        • samplePercentage 整型

          默认值为100

        • isEmbeddedMode 布尔

          默认值为false

        • 状态 字符串

          取值为 VERIFYINGFAILEDCANCELLINGCANCELLEDVERIFIEDABORTED

    • relationalTableFilters 对象

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

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

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

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

          不允许使用其他属性。

          隐藏 * 属性 显示 * 属性 对象
          • whereClause 字符串

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

          • 行计数 integer(int64)

            从源表返回的行数限制(可选)。

    • collectionFilters 对象

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

      • include only:只有与指定的包含过滤匹配的集合才会被迁移。
      • 仅排除:将迁移所有集合,但与排除过滤匹配的集合除外。
      • 包含和排除:迁移与包含过滤匹配的集合,并排除也与排除过滤匹配的集合。
      • 无筛选器:将迁移所有集合。
      隐藏 collectionFilters 属性 显示 collectionFilters 属性 对象
      • 包括 array[string]
      • 排除 array[string]
  • 404 application/json

    未找到

    隐藏响应属性 显示响应属性 对象
    • jobId 字符串

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

    • message 字符串 必需
    • 描述 字符串
    • timestamp string(date-time) 必需
GET /jobs/{jobId}
curl \
 --request GET 'http://127.0.0.1:8278/api/v1/jobs/{jobId}'
响应示例 (200)
{
  "id": "string",
  "projectId": "string",
  "status": "NOT_STARTED",
  "cdcStatus": "NOT_STARTED",
  "verificationJobId": "string",
  "options": {
    "dropCollections": false,
    "mode": "SNAPSHOT",
    "truncationReportMode": "FAIL",
    "errorHandling": "FAIL",
    "errorTolerance": 42,
    "signalingTable": "database.schema.table"
  },
  "jdbcConnectionString": "string",
  "mongoDbConnectionString": "string",
  "submittedAt": "2026-05-04T09:42:00Z",
  "statistics": {
    "startedAt": "2026-05-04T09:42:00Z",
    "elapsedSeconds": 42,
    "remainingTableCount": 42,
    "processingTables": [
      "string"
    ],
    "totalEventsSeen": 0,
    "snapshotCompleted": false,
    "totalTableCount": 42,
    "totalEvents": 42,
    "totalEventSize": 42
  },
  "cdcStatistics": {
    "startedAt": "2026-05-04T09:42:00Z",
    "lastEventTime": "2026-05-04T09:42:00Z",
    "lastEventSourceDatabaseTime": "2026-05-04T09:42:00Z",
    "eventsInLastHour": 0,
    "eventsInLastMinute": 0,
    "totalEventsSeen": 0,
    "latestBatchMaxSourceDbLagMs": -1
  },
  "failureError": {
    "errorType": "string",
    "message": "string",
    "failureAt": "2026-05-04T09:42:00Z",
    "setupError": false
  },
  "metadata": {
    "telemetryUserId": "string",
    "verification": {
      "samplePercentage": 100,
      "isEmbeddedMode": false,
      "status": "VERIFYING"
    }
  },
  "relationalTableFilters": {
    "schema_1_name": {
      "table_1_name": {
        "whereClause": "id > 1000 AND id <= 2000"
      },
      "table_2_name": {
        "whereClause": "TRUE",
        "rowCount": 10
      }
    }
  },
  "collectionFilters": {
    "include": [
      "string"
    ],
    "exclude": [
      "string"
    ]
  }
}
响应示例 (404)
{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2026-05-04T09:42:00Z"
}