機能の概要
テナントの復元タスクを作成するために使用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
POST /api/v2/instances/{instanceId}/backup/restore
リクエストパラメータ
Path
パラメータ名 |
型 |
必須 |
説明 |
|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID |
Query
パラメータ名 |
型 |
必須 |
説明 |
|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます |
Header
パラメータ名 |
型 |
必須 |
説明 |
|---|---|---|---|
| X-Ob-Project-Id | String | はい | プロジェクトID |
Body
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| sourceInstanceId | String | はい | 元のクラスタID | obxxx |
| tenantResource | Object | はい | テナントリソース構成情報 | {"cpu":1,"memory":4,"unitnum":1} |
| fromRemote | Boolean | はい | 復元をリモートから開始するかどうか | true |
| sourceTenantId | String | はい | 元テナントID | txxx |
| restoreTime | String | はい | 復元時間 | 2026-01-13T05:58:34Z |
| restoreObjectType | String | はい | 復元オブジェクトタイプ | tenant |
| restoreObjects | Array | いいえ | 復元オブジェクトの内容 | [] |
| restoreMode | String | はい | 復元モード | from_backup_set |
| targetInstanceId | String | はい | ターゲットインスタンスID | obxxx |
| targetTenantName | String | はい | ターゲットテナント名 | mysql_001 |
| targetTenantDescription | String | はい | ターゲットテナントの説明 | test |
| targetTenantPrimaryZone | String | はい | ターゲットテナントのゾーン | cn-shanghai-e |
実行結果
パラメータ名 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| data | Object | 空セットを返す | null |
例
リクエスト例
curl --digest -u '<あなたのak:sk>' \
-X POST \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/backup/restore?requestId={requestId}' \
--header "X-Ob-Project-Id: {projectId}" \
--header "Content-Type: application/json" \
--data '{
"sourceInstanceId": "obxxx",
"tenantResource": {
"cpu": 1,
"memory": 4,
"unitNum": 1
},
"fromRemote": false,
"sourceTenantId": "txxx",
"restoreTime": "2026-01-13T05:58:34Z",
"restoreObjectType": "tenant",
"restoreObjects": [],
"restoreMode": "from_backup_set",
"targetInstanceId": "obxxx",
"targetTenantName": "テナント001を復元",
"targetTenantDescription": "テスト",
"targetTenantPrimaryZone": "cn-shanghai-e"
}'
実行結果例
JSON形式
{
"data":{},
"requestId":"4d9124c3-d92b-4a6e-bccd-343f2554fa22",
"success":true,
"server": "xxx.xxx.x.xxx:xxxx"
}