機能の概要
このAPIは、クラスタのバックアップポリシーを変更するために使用されます。このAPIを通じて、クラスタのバックアップスケジュールの周期、時間、ストレージアドレス、期限切れデータのクリーンアップ、アラートのしきい値、セカンダリバックアップの設定などの情報を変更できます。
呼び出しの説明
インターフェース制約
呼び出し元は、対象クラスタに対するバックアップ・リストアの更新権限を持っている必要があります。
呼び出し元は、OCPアプリケーションサービスの認証を通過している必要があります。
リクエストパス
PATCH /api/v2/ob/clusters/{id}/backup/config/backupStrategy
path:
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| id | Integer | はい | 1 | バックアップポリシーを変更するクラスタのIDです。 |
リクエストパラメータ
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| backupMode | String | はい | LOGICAL_BACKUP | バックアップモード。 値の範囲: |
| obBackupScheduleConfig | Object | はい | NA | バックアップスケジュール設定については、obBackupScheduleConfigのデータ構造を参照してください。 |
| obBackupThresholdConfig | Object | はい | NA | バックアップアラートしきい値設定については、obBackupThresholdConfigのデータ構造を参照してください。 |
| obBackupServiceStorageConfig | Object | はい | NA | バックアップストレージ設定については、obBackupServiceStorageConfigのデータ構造を参照してください。 |
| secondaryBackupEnabled | Boolean | いいえ | false | 二次バックアップのスイッチです。デフォルト値はfalseです。OceanBase V2.2.77以降でのみ二次バックアップがサポートされます。 |
| obSecondaryBackupConfig | Object | いいえ | NA | 二次バックアップ設定については、obSecondaryBackupConfigのデータ構造を参照してください。 |
obBackupScheduleConfigのデータ構造
パラメータ |
型 |
必須 |
説明 |
|---|---|---|---|
| backupScheduleMode | String | はい | バックアップスケジュールの周期。WEEK、MONTHを指定できます。 |
| backupScheduleEnabled | Boolean | はい | バックアップのスイッチです。 |
| backupScheduleTime | OffsetTime | はい | バックアップスケジュールの時間です。例:"02:00:00.000+08:00"。 |
| dayAndDataBackupModelMap | Map | はい | スケジュール日とそのデータバックアップ方式です。例:{ "2": "FULL_BACKUP", "4": "FULL_BACKUP", "6": "INCREMENTAL_BACKUP" }は、火曜日と木曜日にフルデータバックアップ、土曜日に増分データバックアップを行うことを表します。 |
| startLogBackup | Boolean | はい | ログバックアップを同時に開始するかどうかです。通常はtrueに設定します。 |
| cleanEnabled | Boolean | いいえ | 期限切れデータのクリーンアップスイッチです。 |
| backupDataRetentionDays | Long | いいえ | バックアップデータの保持日数です。例:7日間とした場合、直近7日間のバックアップデータを最低限保持します。このパラメータはcleanEnabled=trueの場合に有効になります。 |
| cleanScheduleTime | OffsetTime | いいえ | 期限切れデータのクリーンアップスケジュール時間です。 |
obBackupThresholdConfigのデータ構造
パラメータ |
型 |
必須 |
説明 |
|---|---|---|---|
| dataBackupTimeoutMinutes | Long | はい | データバックアップスケジュールのタイムアウト時間です。単位は分です。 |
| noSuccessfulDataBackupAlarmDays | Long | はい | データバックアップが成功していない場合にアラートを発生させるまでの最大日数です。 |
| libObLogExpireDays | Long | いいえ | liboblogの保持日数です。論理バックアップモードでのみ有効です。 |
| logBackupDelaySeconds | Long | はい | ログバックアップ遅延アラートのしきい値です。単位は秒です。 |
obBackupServiceStorageConfigのデータ構造
パラメータ |
型 |
必須 |
説明 |
|---|---|---|---|
| configName | String | はい | ストレージ設定名。英字で始まり、英字または数字で終わる必要があります。英字、数字、アンダースコアを含み、長さは2~32文字です。 |
| obBackupStorageBaseInfo | Object | はい | ストレージ設定の基本パラメータ。 |
| |--backupStorageType | String | はい | ストレージタイプ。現在、BACKUP_STORAGE_FILE、BACKUP_STORAGE_OSS、BACKUP_STORAGE_S3のタイプをサポートしています。 |
| |--storageUrl | String | はい | ストレージディレクトリ。プロトコルなしのディレクトリに設定してください。例:/obbackup/ または osstest/backup。 |
| |--ossAccessKey | Object | いいえ | OSS情報。backupStorageType=BACKUP_STORAGE_OSS の場合にのみ有効です。 |
| |--endpoint | String | はい | アクセスドメイン名。 |
| |--accessKeyId | String | はい | アクセスユーザーID。 |
| |--accessKeySecret | String | はい | アクセス秘密鍵。 |
| |--endpoint | String | はい | アクセスドメイン名。 |
| |--accessKeyId | String | はい | アクセスユーザーID。 |
| |--accessKeySecret | String | はい | アクセス秘密鍵。 |
| |--appId | String | はい | アプリケーションID。 |
| |--s3AccessKey | Object | いいえ | S3情報。backupStorageType=BACKUP_STORAGE_S3 の場合にのみ有効です。 |
| |--endpoint | String | はい | アクセスドメイン名。 |
| |--accessKeyId | String | はい | アクセスユーザーID。 |
| |--accessKeySecret | String | はい | アクセス秘密鍵。 |
| |--region | String | はい | リージョン。 |
| |--alarmStoragePercentageThreshold | Long | はい | バックアップストレージ容量アラートのしきい値。パーセンテージで設定してください。 |
| storageId | Long | いいえ | ストレージ設定ID。 |
| serviceType | String | いいえ | サービスタイプ。バックアップ・リストアサービス(論理バックアップ・リストア)またはOceanBaseクラスタ(物理バックアップ・リストア)。BACKUP_RESTORE_SERVICE、OB_CLUSTER、OTHERSを含みます。 |
| serviceId | Long | いいえ | サービスID。 |
| serviceName | String | いいえ | サービス名。 |
| hostIdList | Array | いいえ | ホストIDリスト。グローバル復元時の解析に使用するホストのリストです。 |
obSecondaryBackupConfigのデータ構造
パラメータ |
型 |
必須 |
説明 |
|---|---|---|---|
| scheduleConfig | Object | はい | 2次バックアップのスケジューリング設定。 |
| |--dataBackupScheduleEnabled | Boolean | はい | データ2次バックアップのスイッチ。 |
| |--logBackupScheduleEnabled | Boolean | はい | ログ2次バックアップのスイッチ。 |
| |--logSecondaryBackupPeriod | String | はい | ログ2次バックアップのスケジューリング間隔。現在、ONCE_A_DAYのみサポートしています。 |
| storageConfig | Object | はい | ストレージ設定。詳細については、obBackupServiceStorageConfigのデータ構造を参照してください。 |
戻り値
パラメータ |
型 |
説明 |
|---|---|---|
| data | Object | バックアップオブジェクトの汎用応答。詳細は BackupCommonResponseのデータ構造 を参照してください。 |
| successful | Boolean | リクエストが成功したかどうかを示します。 |
| timestamp | Datetime | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | Integer | サーバーがリクエストを処理した時間(ミリ秒)。 |
| status | Integer | HTTPステータスコードです。 |
| traceId | String | リクエストのTrace IDで、問題の調査に使用されます。 |
| server | String | リクエストに応答したアプリケーションサービスのアドレスです。 |
BackupCommonResponseのデータ構造
パラメータ |
型 |
説明 |
|---|---|---|
| obBackupTaskType | String | バックアップ操作のタイプ。例:CREATE_BACKUP_STRATEGY。 |
| backupObjectOpsResultList | Array | バックアップオブジェクト操作結果セット。 |
| |--obBackupObjectList | Array | バックアップオブジェクトリスト。 |
| |--clusterId | Long | クラスタID。 |
| |--tenantId | Long | テナントID。 |
| |--backupDimension | String | バックアップの次元。例:CLUSTER、TENANT。分表はクラスタバックアップ、テナントはテナントバックアップを表します。現在、テナントバックアップはサポートされていません。 |
| |--beSuccessful | Boolean | 操作が成功したかどうかを示します。 |
| |--taskIdList | Array | タスク番号リスト。非同期タスクがある場合に返されます。 |
| |--errorCode | Object | エラーコード。 |
| |--hint | String | ヒント情報。 |
例
リクエスト例
{
"backupMode": "PHYSICAL_BACKUP",
"obSecondaryBackupConfig": {
"storageConfig": {
"configName": "nfs0907_1451",
"obBackupStorageBaseInfo": {
"backupStorageType": "BACKUP_STORAGE_FILE",
"storageUrl": "/obbackup/backup_backup"
},
"alarmStoragePercentageThreshold": 80,
"storageId": 2000035
},
"scheduleConfig": {
"logSecondaryBackupPeriod": "ONCE_AN_HOUR",
"logBackupScheduleEnabled": true,
"dataBackupScheduleEnabled":true
}
},
"obBackupThresholdConfig": {
"dataBackupTimeoutMinutes": 7,
"logBackupDelaySeconds": 300,
"noSuccessfulDataBackupAlarmDays": 2
},
"secondaryBackupEnabled": true,
"obBackupObjectList": [
{
"clusterId": 1000005,
"backupDimension": "CLUSTER"
}
],
"obBackupScheduleConfig": {
"dayAndDataBackupModelMap": {
"2": "FULL_BACKUP",
"4": "FULL_BACKUP",
"6": "FULL_BACKUP"
},
"startLogBackup": true,
"backupScheduleMode": "WEEK",
"backupScheduleTime": "15:18:00.000+08:00"
},
"obBackupServiceStorageConfig": {
"configName": "nfs0907_1452",
"obBackupStorageBaseInfo": {
"backupStorageType": "BACKUP_STORAGE_FILE",
"storageUrl": "/obbackup/"
},
"storageId": 2000034,
"alarmStoragePercentageThreshold": 80
}
}
レスポンス例
{
"data": {
"backupObjectOpsResultList": [
{
"beSuccessful": true,
"obBackupObjectList": [
{
"backupDimension": "CLUSTER",
"clusterId": 1000005
}
],
"taskIdList": []
}
],
"obBackupTaskType": "UPDATE_BACKUP_STRATEGY"
},
"duration": 110,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-09-07T15:16:14.651+08:00",
"traceId": "042fbebcb14742e9"
}