機能の概要
このAPIは、プロジェクトの変更レコード（テーブルの追加・削除）を作成するために使用されます。RUNNING/FAILED/SUSPEND状態のプロジェクトのみをサポートします。CommonModifyProjectController.createProjectModifyRecordsに対応しています。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
PUT /api/v2/oms/project/modifyRecords
リクエストパラメータ
ヘッダー
プロパティ |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| X-Ob-Project-Id | String | はい | プロジェクトID | proj-xxxxxxxx |
| X-Ob-Org-Id | String | はい | 組織ID | org-xxxxxxxx |
ボディ
プロパティ |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| id | String | はい | プロジェクトID | np_7befdmp08juo |
| databases | List<TransferSchema> |
いいえ | 変更後のデータベース/Schemaリスト (transferMappingとどちらか一方を指定するか、両方を組み合わせて使用する) | |
| transferMapping | Object | いいえ | 変更後の転送オブジェクトマッピング。CreateProjectのtransferMappingと構造は同じです |
transferMappingを指定しなかった場合、システムはdatabasesに対してSPECIFICモードで転送マッピングを構築します。
TransferSchema構造
フィールド名 |
型 |
説明 |
|---|---|---|
| name | String | 元のデータベース/Schema名 |
| mappedName | String | マッピング後のデータベース/Schema名 |
| tables | List<TransferTable> |
テーブル設定リスト |
| views | List<TransferView> |
ビュー設定リスト |
戻り値
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| success | Boolean | 成功したかどうか | true |
| data | Long | 変更レコードID | 123456789 |
| requestId | String | リクエストID | req-xxx-xxx |
| cost | String | 所要時間 | 123ms |
例
リクエスト例
curl --digest -u '<あなたのak:sk>' \
--request PUT \
--url 'https://api-cloud.oceanbase.com/api/v2/oms/project/modifyRecords' \
-H 'Content-Type: application/json' \
-H 'X-Ob-Project-Id: <プロジェクトID>' \
-H 'X-Ob-Org-Id: <組織ID>' \
--data @request.json
{
"id": "np_xxx",
"transferMapping": {
"mode": "COMPLEX",
"schemas": [
{
"name": "source_db",
"mappedName": "target_db",
"tables": [
{ "name": "table_1", "mappedName": "table_1" }
]
}
]
}
}
レスポンス例
{
"success": true,
"data": 123456789,
"requestId": "req-xxx-xxx",
"cost": "123ms"
}