機能の概要
指定されたOceanBase Cloudインスタンスのバックアップポリシー設定の詳細を照会します。返される情報には、バックアップサイクル、保持期間、増分バックアップの有無、地理的冗長化バックアップの有無、アーカイブバックアップの有無、およびスパースバックアップポリシーなど、完全なバックアップ設定情報が含まれます。このインターフェースを通じて、現在のインスタンスのバックアップポリシー設定を確認し、その後の調整や管理を行うことができます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances/{instanceId}/backup/strategy
リクエストパラメータ
Path
パラメータ |
タイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
Query
パラメータ |
タイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| Action | String | はい | APIアクション。DescribeBackupStrategyに固定されます | DescribeBackupStrategy |
| requestId | String | はい | リクエストID。追跡に使用されます | d04eabba**** |
戻り値
フィールド |
タイプ |
説明 |
例 |
|---|---|---|---|
| success | Boolean | 成功かどうか | true |
| errorCode | String | エラーコード | INVALID_PARAMETER |
| errorMessage | String | エラーメッセージ | Invalid parameter |
| data | Object | 業務データ(object) | None |
| cost | Number | 所要時間 | 1.0 |
| server | String | サーバーのアドレス、通常はOBServerノードのIP | 10.0.0.10 |
| requestId | String | リクエストID | d04eabba**** |
| totalCount | Number | 総レコード数。 | 100.0 |
| extra | Object | 拡張情報。 | {} |
dataオブジェクトのフィールド
フィールド |
タイプ |
説明 |
例 |
|---|---|---|---|
| scheduleTime | String | スケジュール時間。 | 2026-02-25T15:40:43+00:00 |
| instanceId | String | OceanBaseクラスタID | obcluster-***** |
| backupModel | Object | なし | None |
| timeList | Array | バックアップまたはスケジュールの時間リスト。 | None |
| lastDayOfMonth | Boolean | 月の最終日かどうか。 | true |
| backupDataType | String | バックアップデータタイプ。 | NORMAL |
| launchIncBackup | Boolean | 増分バックアップを有効にするかどうか。 | true |
| launchExpirationCleanup | Boolean | 期限切れバックアップのクリーンアップを有効にするかどうか。 | true |
| cleanupScheduleTime | String | クリーンアップタスクのスケジュール時間。 | 2026-02-25T15:40:43+00:00 |
| dataMaintainDays | Integer | データバックアップの保持日数。 | 30 |
| nextBackupTime | String | 次回の予定されているデータバックアップ時間 | 2026-02-25T15:40:43+00:00 |
| offsite | String | 地域外バックアップを有効にするかどうか。 | OFF |
| crossRegionFlag | Boolean | 複数リージョンにまたがるバックアップを有効にするかどうか。 | true |
| crossBorder | Boolean | 国境を越えるかどうか。 | true |
| retainMode | String | 保持ポリシーモード。 | DAYS |
| remoteBackupRegion | String | 地域外バックアップ地域。 | cn-hangzhou |
| localBackupRegion | String | ローカルバックアップ地域。 | cn-hangzhou |
| remoteBackupStrategy | Object | 地域外バックアップ戦略設定 | None |
| remoteBackupStrategy.backupScheduleMode | String | バックアップのスケジュールモード。例：週単位または月単位で実行 | WEEK |
| remoteBackupStrategy.timeList | Array | バックアップまたはスケジュールの時間リスト。 | ["2026-02-25 15:40:43+00:00", "2026-02-25 15:41:43+00:00"] |
| remoteBackupStrategy.backupTimesInMonth | String | 1か月あたりのバックアップ回数 | 2026-02-25T15:40:43+00:00 |
| remoteBackupStrategy.dataMaintainDays | Integer | データバックアップの保持日数。 | 30 |
| archiveFlag | Boolean | アーカイブバックアップを有効にするかどうか。 | true |
| archiveBackupStrategy | Object | ローカルアーカイブバックアップ戦略設定 | None |
| archiveBackupStrategy.backupScheduleMode | String | バックアップのスケジュールモード。例：週単位または月単位で実行 | WEEK |
| archiveBackupStrategy.timeList | Array | バックアップまたはスケジュールの時間リスト。 | None |
| archiveBackupStrategy.backupTimesInMonth | String | 1か月あたりのバックアップ回数 | 2026-02-25T15:40:43+00:00 |
| archiveBackupStrategy.dataMaintainDays | Integer | データバックアップの保持日数。 | 30 |
| remoteArchiveFlag | Boolean | 地域外アーカイブバックアップを有効にするかどうか。 | true |
| remoteArchiveBackupStrategy | Object | 地域外アーカイブバックアップ戦略設定 | None |
| remoteArchiveBackupStrategy.backupScheduleMode | String | バックアップのスケジュールモード。例：週単位または月単位で実行する場合 | WEEK |
| remoteArchiveBackupStrategy.timeList | Array | バックアップまたはスケジュールの時間リスト。 | None |
| remoteArchiveBackupStrategy.backupTimesInMonth | String | 月間バックアップ回数 | 2026-02-25T15:40:43+00:00 |
| remoteArchiveBackupStrategy.dataMaintainDays | Integer | データバックアップの保持日数。 | 30 |
| sparseBackupFlag | Boolean | スパースバックアップを有効にするかどうか。 | true |
| sparseBackupStrategies | Array | スパースバックアップ戦略のリスト。 | [{"id": "resource-123456"}] |
| backupMode | String | バックアップモード。例：物理バックアップまたは論理バックアップ。 | physical |
| backupStorageConfig | String | バックアップストレージ設定。 | 200 |
| tenantIds | Array | テナントIDのリスト。 | ["t4louaeei****"] |
| tenantScopeInfos | Array | バックアップポリシーが適用されるテナント範囲のリスト。 | [{"tenantId": "t4louaeei****", "tenantName": "pay_core"}] |
data.sparseBackupStrategies[] オブジェクトフィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| backupMaintainMatchRule | Object | スパースバックアップ保持ポリシーのマッチングルール | None |
| backupMaintainMatchRule.backupScheduleMode | Object | なし | None |
| backupMaintainMatchRule.weeks | Array | 週単位スケジュール：1～7 | [1, 3, 5] |
| backupMaintainMatchRule.days | Array | 月単位スケジュール：1～31日 | [1, 15] |
| backupMaintainMatchRule.month | Integer | 年単位スケジュール：1～12月 | 1 |
| backupMaintainStrategy | Object | スパースバックアップ保持ポリシー設定 | None |
| backupMaintainStrategy.backupMaintainMode | Object | なし | None |
| backupMaintainStrategy.maintainDay | Integer | 保持期間（永久保持の場合、この値は無効）。 | 1 |
| backupMaintainStrategy.reserveLogBackup | Boolean | ログバックアップを保持するかどうか。 | true |
data.tenantIds[] 要素フィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| data.tenantIds[] | String | テナントIDのリスト。 | None |
data.tenantScopeInfos[] オブジェクトフィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| tenantId | String | テナントID | t4louaeei**** |
| tenantName | String | テナント名 | xxxxxx |
| tenantMode | String | テナントモード。例：MySQLまたはOracle。 | xxxxxx |
data.timeList[]要素フィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| data.timeList[] | Integer | バックアップまたはスケジューリングの時間リスト。 | None |
例
リクエスト例
curl --digest -u '<Your AccessKey ID:AccessKey Secret>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/backup/strategy?requestId=d04eabba****'
レスポンス例
JSON 形式
{
"success": true,
"errorCode": null,
"errorMessage": null,
"data": {
"scheduleTime": "2026-02-25T15:40:43+00:00",
"instanceId": "obcluster-*****",
"backupModel": "xxxxxx",
"timeList": [],
"lastDayOfMonth": true,
"backupDataType": "NORMAL",
"launchIncBackup": true,
"launchExpirationCleanup": true,
"cleanupScheduleTime": "2026-02-25T15:40:43+00:00",
"dataMaintainDays": 30,
"nextBackupTime": "2026-02-25T15:40:43+00:00",
"offsite": "OFF",
"crossRegionFlag": true,
"crossBorder": true,
"retainMode": "DAYS",
"remoteBackupRegion": "cn-hangzhou",
"localBackupRegion": "cn-hangzhou",
"remoteBackupStrategy": {
"backupScheduleMode": "WEEK",
"timeList": [
"2026-02-25 15:40:43+00:00",
"2026-02-25 15:41:43+00:00"
],
"backupTimesInMonth": "2026-02-25T15:40:43+00:00",
"dataMaintainDays": 30
},
"archiveFlag": true,
"archiveBackupStrategy": {
"backupScheduleMode": "WEEK",
"timeList": [],
"backupTimesInMonth": "2026-02-25T15:40:43+00:00",
"dataMaintainDays": 30
},
"remoteArchiveFlag": true,
"remoteArchiveBackupStrategy": {
"backupScheduleMode": "WEEK",
"timeList": [],
"backupTimesInMonth": "2026-02-25T15:40:43+00:00",
"dataMaintainDays": 30
},
"sparseBackupFlag": true,
"sparseBackupStrategies": [
{
"id": "resource-123456",
"backupMaintainMatchRule": {
"backupScheduleMode": "xxxxxx",
"weeks": [
1,
3,
5
],
"days": [
1,
15
],
"month": 1
},
"backupMaintainStrategy": {
"backupMaintainMode": "xxxxxx",
"maintainDay": 1,
"reserveLogBackup": true
}
}
],
"backupMode": "physical",
"backupStorageConfig": "200",
"tenantIds": [
"t4louaeei****"
],
"tenantScopeInfos": [
{
"tenantId": "t4louaeei****",
"tenantName": "xxxxxx",
"tenantMode": "xxxxxx"
}
]
},
"cost": 1.0,
"server": "xxx.xxx.x.xxx:xxx",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": "{}"
}