機能説明
指定されたバックアップタスクの詳細情報を取得します。バックアップモード、バックアップ対象、バックアップセットの状態、ポイントインタイム、サイズ、およびテナントレベルのバックアップセットリストなどが含まれます。
呼び出し説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/backup/data/sets/{backupTaskId}
リクエストパラメータ
Path
パラメータ名 |
型 |
必須 |
説明 |
|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID |
| backupTaskId | String | はい | バックアップタスクID |
Query
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
| checkBackupSetDownloadEnable | Boolean | いいえ | ダウンロードロジックをチェックするかどうか（バックアップセットダウンロードシナリオではtrueが必須） | false |
戻り結果
パラメータ名 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| data | Object | バックアップセット情報 | - |
| backupMode | String | バックアップモード | PHYSICAL_BACKUP |
| backupObjectType | String | バックアップ対象タイプ | CLUSTER |
| backupSetId | String | バックアップセットID | bak-******** |
| checkpoint | String | バックアップセットのポイントインタイム | 2026-01-19T10:32:28Z |
| dataBackupMode | String | データバックアップモード | FULL_BACKUP |
| dataBackupSize | Double | データバックアップサイズ（単位：GB） | 0.06 |
| dataVersion | Integer | データバージョン番号 | 1 |
| downloadEnabled | Boolean | ダウンロードは可能か | false |
| downloadTaskId | Integer | ダウンロードタスクID | -1 |
| endTime | String | 終了時間 | 2026-01-19T10:32:49Z |
| startTime | String | 開始時間 | 2026-01-19T10:30:53Z |
| status | String | ステータス | DONE |
| tenantBackupSetList | Array | テナントバックアップセットリスト | - |
| - backupMode | String | バックアップモード | PHYSICAL_BACKUP |
| - backupObjectType | String | バックアップオブジェクトタイプ | TENANT |
| - backupSetId | String | バックアップセットID | bak-********-1002 |
| - checkpoint | String | バックアップセットのポイントインタイム | 2026-01-19T10:32:28Z |
| - dataBackupMode | String | データバックアップモード | FULL_BACKUP |
| - dataBackupSize | Double | データバックアップサイズ（単位：GB） | 0.06 |
| - dataVersion | Integer | データバージョン番号 | 126000001 |
| - downloadEnabled | Boolean | ダウンロードは可能か | false |
| - downloadTaskId | Integer | ダウンロードタスクID | -1 |
| - endTime | String | 終了時間 | 2026-01-19T10:32:40Z |
| - startTime | String | 開始時間 | 2026-01-19T10:31:09Z |
| - status | String | ステータス | DONE |
| - tenantId | String | テナントID | txxx |
| - tenantName | String | テナント名 | test1 |
| - triggerMode | String | トリガーモード | BACKUP_now |
| - validity | String | 有効性 | VALID |
| tenantId | String | テナントID | sys |
| tenantName | String | テナント名 | test |
| triggerMode | String | トリガーモード | BACKUP_NOW |
| validity | String | 有効性 | VALID |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/backup/data/sets/{backupTaskId}?requestId={requestId}&checkBackupSetDownloadEnable=false'
レスポンス例
JSON形式
{
"data": {
"backupMode": "PHYSICAL_BACKUP",
"backupObjectType": "CLUSTER",
"backupSetId": "bak-********",
"checkpoint": "2026-01-19T10:32:28Z",
"dataBackupMode": "FULL_BACKUP",
"dataBackupSize": 0.06,
"dataVersion": 1,
"downloadEnabled": false,
"downloadTaskId": -1,
"endTime": "2026-01-19T10:32:49Z",
"startTime": "2026-01-19T10:30:53Z",
"status": "DONE",
"tenantBackupSetList": [
{
"backupMode": "PHYSICAL_BACKUP",
"backupObjectType": "TENANT",
"backupSetId": "bak-********-1002",
"checkpoint": "2026-01-19T10:32:28Z",
"dataBackupMode": "FULL_BACKUP",
"dataBackupSize": 0.06,
"dataVersion": 126000001,
"downloadEnabled": false,
"downloadTaskId": -1,
"endTime": "2026-01-19T10:32:40Z",
"startTime": "2026-01-19T10:31:09Z",
"status": "DONE",
"tenantId": "txxx",
"tenantName": "test1",
"triggerMode": "BACKUP_NOW",
"validity": "VALID"
}
],
"tenantId": "sys",
"tenantName": "*",
"triggerMode": "BACKUP_NOW",
"validity": "VALID"
},
"requestId": "2wewqe1232",
"success": true
}