本記事では、APIを使用してクラスタレベルのバックアップ設定を更新する方法について説明します。
呼び出しの説明
インターフェース制約
パスワードが設定されている場合は、認証を通過する必要があります。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
PATCH /api/v1/obcluster/backup/config
リクエストパラメータ
| パラメータ | タイプ | 必須 | サンプル値 | 説明 |
|---|---|---|---|---|
| backup_base_uri | string | いいえ | "file:///data/backup" | バックアップファイルの基本パス。設定後、ログアーカイブとデータバックアップファイルはこの基本パスに保存されます。 |
| log_archive_concurrency | int | いいえ | 0 | ログアーカイブのワーカースレッド総数を設定します。デフォルト値は0で、値の範囲は[0, 100]です。 |
| binding | string | いいえ | "optional" | アーカイブと業務の優先モードを設定します。現在、optional（ユーザー業務優先）とmandatory（アーカイブ優先）に設定できます。この項目が設定されていない場合、デフォルトはOptionalモードです。この項目を設定する場合は、backup_base_uriも設定する必要があります。 |
| ha_low_thread_score | int | いいえ | 0 | バックアップやバックアップクリーンアップなどの高可用性低優先順位タスクの現在のワーカースレッド数を指定します。バックアップ開始前に、このパラメータの値を適宜引き上げることができ、推奨されるのは毎回値を倍増させることです。デフォルト値は0で、値の範囲は[0, 100]です。 |
| piece_switch_interval | string | いいえ | 1d | pieceの切り替え周期を設定します。この項目を設定しない場合、デフォルトは1dで、値の範囲は[1d, 7d]です。この項目を設定する場合は、backup_base_uriも設定する必要があります。 |
| archive_lag_target | string | いいえ | 7200s | テナントログアーカイブの遅延時間を制御します。デフォルトは2分で、前後の2回のアーカイブI/Oの最大間隔を指定するために使用されます。値の範囲は[0ms, 7200s]です。 |
| delete_policy | DeletePolicy | いいえ | { "delete_policy": "{ "policy": "default", "recovery_window": "7d", }, } |
バックアップ成功後、業務ニーズに応じてテナントにクリーンアップポリシーを設定できます。クリーンアップポリシーが設定されたテナントは、1時間ごとに自動クリーンアップがトリガーされ、期限切れのバックアップが適時にクリーンアップされるようになります。構成における各値の意味は以下の通りです：
|
クラスタレベルのバックアップ構成を更新する際、クラスタレベルのバックアップ構成の設定との違いは、backup_base_uri を設定しなくてもよい点です。
注意
binding と piece_switch_interval を設定する場合でも、backup_base_uri の設定は依然として必要です。これは、3つのパラメータが結びついており、増分設定はサポートされていないためです。
実行結果
| パラメータ | タイプ | 説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）です。 |
| status | int | HTTP Status規格に準拠するエンコードです。 |
| traceId | string | リクエストのトレースIDです。 |
| data | DagDetailDTO | 非同期タスク情報。詳細については、以下のDagDetailDTO情報のデータ構造を参照してください。 |
| error | ApiError | リクエストによって生成されたエラー。以下の情報が含まれます：
|
DagDetailDTO情報のデータ構造は以下のとおりです：
| パラメータ | タイプ | 説明 |
|---|---|---|
| id | string | DAG共通ID。 |
| dag_id | int | DAGのIDであり、OceanBaseデータベースに記録される主キーです。 |
| name | string | DAGの名前。 |
| stage | int | DAGの現在の実行段階。 |
| max_stage | int | DAG実行過程における総段階数。 |
| state | string | DAGの実行状態。 |
| operator | string | DAGの実行操作タイプ。 |
| start_time | time.Time | DAGの実行開始時間。 |
| end_time | time.Time | DAGの実行終了時間。 |
| additional_data | map[string]any | DAGのその他のデータ。 |
| nodes | []NodeDetailDTO | DAG内のすべてのノード情報。詳細はNodeの詳細情報を取得するを参照してください。 |
例
リクエスト例
PATCH 10.10.10.1:2886/api/v1/obcluster/backup/config
{
"backup_base_uri":"file://data/backup",
"log_archive_concurrency":100,
"binding":"Mandatory",
"ha_low_thread_score":35,
"piece_switch_interval":"6d",
"archive_lag_target":"2h",
"delete_policy":
{
"policy":"",
"recovery_window":"5d"
}
}
レスポンス例
{
"successful": true,
"timestamp": "2024-01-09T17:11:43.385889278+08:00",
"duration": 1,
"status": 200,
"traceId": "877fe32b83634153",
"data": {
"id": "22130706433028869",
"dag_id": 4,
"name": "Set obcluster backup config",
"stage": 1,
"max_stage": 2,
"state": "READY",
"operator": "RUN",
"start_time": "2024-01-09T17:11:43.384630643+08:00",
"end_time": "2024-01-09T17:11:43.384630643+08:00",
"additional_data": null,
"nodes": null
}
}
関連ドキュメント
コマンドラインからAPIを呼び出す以外に、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドのリクエスト方法の詳細については、クラスタレベルのバックアップ設定の更新を参照してください。
obshell-sdk-goを使用したAPIメソッドのリクエスト方法の詳細については、クラスタレベルのバックアップ設定の更新を参照してください。