UpdateProjectConfig - プロジェクト設定の更新

機能の概要

このAPIは、データ移行/検証プロジェクトの構成パラメータを更新するために使用されます。差分更新モードを採用しており、リクエストで明示的に指定されたフィールドのみが更新され、指定されていない部分は元の値のまま維持されます。これはCommonProjectController.updateProjectConfigに対応します。

呼び出しの説明

インターフェース制約

呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。

リクエストパス

PUT /api/v2/oms/project/updateConfig

リクエストパラメータ

Header

Body

戻り値

更新モードの説明

差分更新：リクエストで明示的に指定されたフィールドのみが更新され、指定されていない部分は元の値のまま維持されます。例外：incrVerifyConfig の endCheckpoint フィールドは、「省略」と「明示的なnull指定」を区別せず、incrVerifyConfig オブジェクトが渡されれば、このフィールドも一緒に更新されます。

スロットリング制御フィールドの特別なルール

以下のフィールドに-1を指定すると、スロットリング設定が削除されます(無制限に戻ります)：

fullTransferConfig.throttleRps、fullTransferConfig.throttleIOPS、fullTransferConfig.sinkThrottleRps、fullTransferConfig.sinkThrottleIOPS、incrTransferConfig.throttleRps、incrTransferConfig.throttleIOPS

ネストされたオブジェクトフィールドの展開説明

commonTransferConfig（汎用転送設定）

fullTransferConfig（全量転送設定）

incrTransferConfig（増分転送設定）

countVerifyConfig（行数検証設定）

fullVerifyConfig（全量検証設定）

incrVerifyConfig（増分検証設定）

例

リクエスト例

例1：全量転送設定の更新

{
  "id": "project-xxx",
  "fullTransferConfig": {
    "writeWorkerNum": 128,
    "readWorkerNum": 128,
    "throttleRps": 5000,
    "throttleIOPS": 104857600
  }
}

例2：DDLタイプを含む増分転送設定の更新

{
  "id": "project-xxx",
  "incrTransferConfig": {
    "incrSyncThreadCount": 128,
    "recordTypeWhiteList": ["INSERT", "UPDATE", "DELETE", "DDL"],
    "supportDDLTypes": ["CREATE_TABLE", "DROP_TABLE", "ALTER_TABLE", "CREATE_INDEX", "DROP_INDEX"],
    "throttleRps": 3000,
    "conflictPolicy": "OVERWRITE"
  }
}

例3：制限の解除(-1を指定)

{
  "id": "project-xxx",
  "fullTransferConfig": {
    "throttleRps": -1,
    "throttleIOPS": -1
  }
}

例4：全量検証設定の更新

{
  "id": "project-xxx",
  "fullVerifyConfig": {
    "mode": "AUTO",
    "sourceThreads": 8,
    "sinkThreads": 8,
    "sourceThrottleBps": 512
  }
}

例5：増分検証終了チェックポイントの更新(継続検証)

{
  "id": "project-xxx",
  "incrVerifyConfig": {
    "startCheckpoint": "1720000000000",
    "endCheckpoint": null
  }
}

例6：既存の終了チェックポイントを保持した増分検証設定の更新

endCheckpointを省略するか、明示的にnullを指定すると、元の終了チェックポイントがクリアされます。再検証スレッド数のみを調整しつつ既存の終了チェックポイントを保持したい場合は、元の終了チェックポイントの値を明示的に指定する必要があります。

{
  "id": "project-xxx",
  "incrVerifyConfig": {
    "reInspectionThreads": 8,
    "endCheckpoint": "1720086400000"
  }
}

レスポンス例

{
  "success": true,
  "data": null,
  "requestId": "req-xxx-xxx",
  "cost": "123ms"
}