機能の概要
指定されたOB Cloudデータベースインスタンス内で復元可能なテナントのリストおよび関連するバックアップセット情報を照会するために使用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/backup/restore/tenants
リクエストパラメータ
Path
パラメータ名 |
型 |
必須 |
説明 |
|---|---|---|---|
| instanceId | String | はい | OB CloudデータベースインスタンスID |
Query
パラメータ名 |
型 |
必須 |
説明 |
|---|---|---|---|
| restoreType | String | いいえ | Restore typeパラメータ |
| openRequest | unknown | はい | Open requestパラメータ |
Header
パラメータ名 |
型 |
必須 |
説明 |
|---|---|---|---|
| X-Ob-Project-Id | String | はい | プロジェクトID |
戻り値
パラメータ名 |
型 |
説明 |
|---|---|---|
| data | Array | 復元可能なテナントリスト |
| backupSetRestoreSummaries | Array | バックアップセットの復元サマリーリスト |
| cpuNum | Integer | CPU数 |
| memoryNum | Integer | メモリ数 |
| obVersion | String | OBバージョン |
| status | String | ステータス |
| tenantId | String | テナントID |
| tenantMode | String | テナントモード |
| tenantName | String | テナント名 |
| timeIntervalList | Array | 復元可能な時間区間 |
| endTime | String | 最大復元可能時刻 |
| startTime | String | 最小復元可能時刻 |
| storageType | String | ストレージタイプ |
| unitNum | Integer | ユニット数 |
| usedDisk | Integer | 使用ディスク |
| requestId | String | リクエストID |
| success | Boolean | 成功かどうか |
例
リクエスト例
curl --digest -u '<あなたのak:sk>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/backup/restore/tenants?restoreType={restoreType}&openRequest={openRequest}' \
-H 'X-Ob-Project-Id: {X-Ob-Project-Id}'
レスポンス例
JSON形式
{
"data":[
{
"backupSetRestoreSummaries":[],
"cpuNum":1,
"memoryNum":4,
"obVersion":"3.2.4.8",
"status":"ONLINE",
"tenantId":"txxx",
"tenantMode":"MySQL",
"tenantName":"mysql_tenant",
"timeIntervalList":[
{
"endTime":"2026-01-12T10:42:26Z",
"startTime":"2026-01-12T06:11:10Z",
"storageType":"standard"
},
{
"endTime":"2026-01-12T12:06:26Z",
"startTime":"2026-01-12T12:00:12Z",
"storageType":"standard"
},
{
"endTime":"2026-01-14T03:34:22Z",
"startTime":"2026-01-14T02:05:20Z",
"storageType":"standard"
}
],
"unitNum":1,
"usedDisk":96468992
},
{
"backupSetRestoreSummaries":[],
"cpuNum":1,
"memoryNum":4,
"obVersion":"3.2.4.8",
"status":"ONLINE",
"tenantId":"t7eryoun5rl7k",
"tenantMode":"MySQL",
"tenantName":"zx_restore",
"timeIntervalList":[
{
"endTime":"2026-01-14T03:34:19Z",
"startTime":"2026-01-14T02:05:20Z",
"storageType":"standard"
}
],
"unitNum":1,
"usedDisk":88080384
},
],
"requestId":"dec235d2-6e7f-442e-84ac-ce5e22d03633",
"success":true
}