本記事では、APIを使用してクラスタレベルバックアップを開始する方法について説明します。
呼び出しの説明
インターフェース制約
パスワードが設定されている場合は、認証を通過する必要があります。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
POST /api/v1/obcluster/backup
リクエストパラメータ
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| mode | string | いいえ | "full" | データバックアップモード。full と incremental の2つの値を指定できます。full はフルバックアップ、incremental は増分バックアップを表します。 |
| plus_archive | bool | いいえ | true | plus_archiveを追加すると、データバックアップ中にアーカイブログも同時にバックアップできるようになります。最終的に、バックアップディレクトリにはアーカイブログを含む完全なデータセットが生成されます。このデータセットは復元可能であり、アーカイブログに依存せずに、このデータセットを使用してテナントのデータをmin_restore_scnポイントまで復元できます。 |
| encryption | string | いいえ | "pwd" | バックアップ後のバックアップセットのパスワード。 |
戻り値
パラメータ |
型 |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理する時間（ミリ秒）。 |
| status | int | HTTPステータスコードに準拠したエンコードです。 |
| traceId | string | リクエストのTrace IDです。 |
| data | DagDetailDTO | 非同期タスク情報。詳細は以下のDagDetailDTOデータ構造を参照してください。 |
| error | ApiError | リクエストで発生したError。以下の情報を含みます：
|
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内の全ノード情報。ノードの詳細情報を取得するを参照してください。 |
例
リクエスト例
POST 10.10.10.1:2886/api/v1/obcluster/backup
{
"mode":"full",
}
レスポンス例
{
"successful": true,
"timestamp": "2024-01-09T17:11:43.385889278+08:00",
"duration": 1,
"status": 200,
"traceId": "877fe32b83634153",
"data": {
"id": "22130706433028869",
"dag_id": 4,
"name": "Obcluster start full backup",
"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メソッドのリクエスト方法については、クラスタレベルバックアップの開始を参照してください。