機能の概要
変更レコードIDに基づいて、変更レコードの詳細を取得します。CommonModifyProjectController.getModifyRecordに対応しています。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/oms/project/modifyRecord
リクエストパラメータ
Header
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| X-Ob-Project-Id | String | はい | プロジェクトID | proj-xxxxxxxx |
| X-Ob-Org-Id | String | はい | 組織ID | org-xxxxxxxx |
Query
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | いいえ | リクエストID | d04eabba-acef-4f4b-96f1-c657******** |
| id | String | はい | 変更レコードID | 123456789 |
戻り値
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| success | Boolean | 成功かどうか | true |
| requestId | String | リクエストID | req-xxx-xxx |
| cost | String | 所要時間 | 123ms |
| data | DescribeModifyRecordResponse | 変更レコードの詳細 |
dataフィールドの説明（リストインターフェースのフィールドに加え、以下のフィールドが含まれます）
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| id | Long | 変更レコードID | 123456789 |
| subProjectId | String | サブプロジェクトID（テーブル追加シナリオ） | np_xxx |
| mergeRequestId | Long | マージリクエストID | 1 |
| updateRequestId | Long | 更新リクエストID | 1 |
| type | String | 変更タイプ。列挙値：INCREASE_OBJECT、DECREASE_OBJECT、MODIFY_OBJECT、MODIFY_ETL、MODIFY_VERIFICATION_OBJECT、MODIFY_SUB_OBJECT |
INCREASE_OBJECT |
| status | String | 変更レコードの状態。列挙値：PENDING、MODIFYING、RUNNING、MERGING、TERMINATING、TERMINATED、SUCCESS、FAILED、CANCEL |
RUNNING |
| errorDetail | Object | エラーの詳細 | |
| databases | List<TransferSchema> |
今回の変更に関連するデータベース/Schemaのリスト | |
| migrationObjectsInfo | Object | 移行対象オブジェクト情報 | |
| omsProjectMappingInfo | Object | プロジェクトマッピング情報 | |
| tableEtlList | List<Object> |
テーブルETL設定リスト | |
| difference | Object | 転送オブジェクトの差異 | |
| beforeTransferMapping | Object | 変更前の転送マッピング | |
| afterTransferMapping | Object | 変更後の転送マッピング | |
| frontShowDifference | Object | フロントエンド表示用の差異（COMPLEXモード） | |
| gmtModified | String | 変更時間（UTC） | 2026-02-26T10:40:43Z |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
--request GET \
--url 'https://api-cloud.oceanbase.com/api/v2/oms/project/modifyRecord?id=123456789' \
-H 'X-Ob-Project-Id: <Project ID>' \
-H 'X-Ob-Org-Id: <Organization ID>'
レスポンス例
{
"success": true,
"requestId": "req-xxx-xxx",
"cost": "123ms",
"data": {
"id": 123456789,
"subProjectId": "np_xxx",
"type": "INCREASE_OBJECT",
"status": "RUNNING",
"errorDetail": null,
"beforeTransferMapping": {
"mode": "COMPLEX"
},
"afterTransferMapping": {
"mode": "COMPLEX"
},
"gmtModified": "2026-02-26T10:40:43Z"
}
}