実行中の移行ジョブを一時停止する

POST / jobs/{ jobId}/一時停止

実行中の移行ジョブを一時停止する

path パラメータ

jobId string 必須

jobId

形式は次のパターンと一致する必要があります: ^[A-Za-z0-9\-]+$。

応答

200 application/ JSON

OK
応答属性の非表示応答属性の表示オブジェクト
- id string 必須
  
  形式は次のパターンと一致する必要があります: ^[A-Za-z0-9\-]+$。
- projectId string 必須
  
  形式は次のパターンと一致する必要があります: ^[A-Za-z0-9\-]+$。
- 状態 string 必須
  
  値は、RUNNING、FAILED、CANCELLING、CANCELLED、COMPLETED、または CLEANING_UP です。
- CDCStatus string
  
  値は、NOT_STARTED、RUNNING、COMPLETING、COMPLETED、FAILED、CANCELLED、または PAUSED です。デフォルト値は NOT_STARTED です。
- validationJobId string
- options オブジェクト必須
  
  追加プロパティは許可されていません。
  
  オプション属性を非表示にするオプション属性の表示オブジェクト
  
  コレクションの削除ブール値
  
  デフォルト値はfalseです。
  
  モード string 必須
  
  値は SNAPSHOT、CDC、または CDC_ONLY です。
  
  errorHandling string
  
  値は FAIL、WARN、または SKIP です。デフォルト値は FAIL です。
  
  errorsTolerance integer
  
  移行を終了する前に許容する必要がある障害の数（レコードレベル）。値は以上である必要があります。
  
  の最小値は 0 です。
- jdBCConnectionString string
- mongoDbConnectionString string
- submittedAt string(date-time) 必須
- 統計オブジェクト
  
  追加プロパティは許可されていません。
  
  統計属性を非表示にする統計属性の表示オブジェクト
  
  startedAt string(date-time)
  
  expireSeconds integer(int64)
  
  retentionTableCount integer
  
  ProcessingTables array[string]
  
  totalEventsSeen integer(int64)
  
  デフォルト値は0です。
  
  snapshotCompleted ブール値
  
  デフォルト値はfalseです。
  
  totalTableCount integer
  
  totalEvents integer(int64)
  
  totalEventSize integer(int64)
- CDCStatistics オブジェクト
  
  追加プロパティは許可されていません。
  
  CDCStatistics 属性を非表示にする CDCStatistics 属性の表示オブジェクト
  
  startedAt string(date-time)
  
  lastEventTime string(date-time)
  
  eventInLastHour integer(int64)
  
  デフォルト値は0です。
  
  eventInLastMinute integer(int64)
  
  デフォルト値は0です。
  
  totalEventsSeen integer(int64)
  
  デフォルト値は0です。
- jobUpdates array[オブジェクト]
  
  jobUpdates 属性を非表示 jobUpdates 属性の表示オブジェクト
  
  eventType string 必須
  
  値は ERROR、WARNING、または INFO です。
  
  ステージ string
  
  値は SNAPSHOTTING、STREAMING、または VERIFICATION です。
  
  メッセージ string 必須
  
  詳細 string
  
  タイムスタンプ string(date-time) 必須
  
  stackTrace array[string]
  
  errorCode string
  
  locationType string
  
  値は TABLE または COLLECTION です。
  
  locationName string
  
  フィールド名 string
  
  キーオブジェクト
  
  キー属性を非表示キー属性を表示オブジェクト
  
  * string additionalProperties
  
  count integer(int64)
  
  ロケーションオブジェクト
  
  次の 1 つ：
  tableロケーションオブジェクト collectionロケーションオブジェクト documentロケーションオブジェクト
- failError オブジェクト
  
  追加プロパティは許可されていません。
  
  failError 属性を非表示 failError 属性の表示オブジェクト
  
  errorsType string 必須
  
  メッセージ string 必須
  
  failAt string(date-time) 必須
  
  setError ブール値必須
  
  デフォルト値はfalseです。
- metadata オブジェクト
  
  追加プロパティは許可されていません。
  
  Hide metadata attributes メタデータ属性の表示オブジェクト
  
  telemetryUserId string
  
  validationRequested ブール値
  
  デフォルト値はfalseです。
  
  validationStatus string
  
  値は、VERIFYING、FAILED、CANCELLING、CANCELLED、VERIFIED、または ABORTED です。
- retentionTableFilters オブジェクト
  
  各キーがスキーマ名を表すオブジェクト。各スキーマには、テーブルフィルターを適用できるテーブルが含まれています。
  
  retentionTableFilters 属性を非表示 relationalTableFilters 属性の表示オブジェクト
  
  * オブジェクト additionalProperties
  
  各キーがスキーマ内のテーブル名を表すオブジェクト。
  
  * 属性を非表示 * 属性を表示オブジェクト
  
  * オブジェクト additionalProperties
  
  追加プロパティは許可されていません。
  
  * 属性を非表示 * 属性を表示オブジェクト
  
  whereClaus string
  
  指定されたソーステーブルの行をフィルタリングするSQL WHERE 句の内容。
  
  returnCount integer(int64)
  
  ソーステーブルから返される行数の任意の制限。
400 application/ JSON

無効なリクエスト
応答属性の非表示応答属性の表示オブジェクト
- jobId string
  
  形式は次のパターンと一致する必要があります: ^[A-Za-z0-9\-]+$。
- メッセージ string 必須
- 説明 string
- タイムスタンプ string(date-time) 必須
404 application/ JSON

見つかりません
応答属性の非表示応答属性の表示オブジェクト
- jobId string
  
  形式は次のパターンと一致する必要があります: ^[A-Za-z0-9\-]+$。
- メッセージ string 必須
- 説明 string
- タイムスタンプ string(date-time) 必須

POST /jobs/{jobId}/一時停止

curl \
 --request POST 'http://127.0.0.1:8278/api/v1/jobs/{jobId}/pause'

応答の例（200）

{
  "id": "string",
  "projectId": "string",
  "status": "RUNNING",
  "cdcStatus": "NOT_STARTED",
  "verificationJobId": "string",
  "options": {
    "dropCollections": false,
    "mode": "SNAPSHOT",
    "errorHandling": "FAIL",
    "errorTolerance": 42
  },
  "jdbcConnectionString": "string",
  "mongoDbConnectionString": "string",
  "submittedAt": "2025-05-04T09:42:00Z",
  "statistics": {
    "startedAt": "2025-05-04T09:42:00Z",
    "elapsedSeconds": 42,
    "remainingTableCount": 42,
    "processingTables": [
      "string"
    ],
    "totalEventsSeen": 0,
    "snapshotCompleted": false,
    "totalTableCount": 42,
    "totalEvents": 42,
    "totalEventSize": 42
  },
  "cdcStatistics": {
    "startedAt": "2025-05-04T09:42:00Z",
    "lastEventTime": "2025-05-04T09:42:00Z",
    "eventsInLastHour": 0,
    "eventsInLastMinute": 0,
    "totalEventsSeen": 0
  },
  "jobUpdates": [
    {
      "eventType": "ERROR",
      "stage": "SNAPSHOTTING",
      "message": "string",
      "details": "string",
      "timestamp": "2025-05-04T09:42:00Z",
      "stackTrace": [
        "string"
      ],
      "errorCode": "string",
      "locationType": "TABLE",
      "locationName": "string",
      "fieldName": "string",
      "key": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      },
      "count": 42,
      "location": {
        "table": "string"
      }
    }
  ],
  "failureError": {
    "errorType": "string",
    "message": "string",
    "failureAt": "2025-05-04T09:42:00Z",
    "setupError": false
  },
  "metadata": {
    "telemetryUserId": "string",
    "verificationRequested": false,
    "verificationStatus": "VERIFYING"
  },
  "relationalTableFilters": {
    "schema_1_name": {
      "table_1_name": {
        "whereClause": "id > 1000 AND id <= 2000"
      },
      "table_2_name": {
        "rowCount": 10,
        "whereClause": "TRUE"
      }
    }
  }
}

応答の例（400）

{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2025-05-04T09:42:00Z"
}

応答の例（404）

{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2025-05-04T09:42:00Z"
}

実行中の移行ジョブを一時停止する

path パラメータ

応答

ロケーション オブジェクト

ロケーションオブジェクト