obshellを使用して、OceanBaseデータベースのクラスタレベル（すべてのテナント）バックアップを開始する方法は2種類あります：
APIを呼び出してバックアップを開始する
obshellコマンドを使用してバックアップを開始する
本記事では、3レプリカのOceanBaseクラスタを例に、obshellを使用したクラスタレベルのバックアップの開始方法について説明します。
前提条件
OceanBaseクラスタがobshellで運用管理されており、詳細な判断方法と引き継ぎ操作については非obshellデプロイメントクラスタの引き継ぎを参照してください。
OceanBaseクラスタのすべてのOBServerノードとobshellが正常に稼働しています。
デプロイメントモード
本記事では、3台のマシンを使用する場合の状況を以下に示します（obshellはデフォルトポート2886を使用します）：
| ロール | マシン | 備考 |
|---|---|---|
| OBServerノード | 10.10.10.1 | OceanBaseデータベースzone1 |
| OBServerノード | 10.10.10.2 | OceanBaseデータベースzone2 |
| OBServerノード | 10.10.10.3 | OceanBaseデータベースzone3 |
APIによるバックアップ
説明
obshellは呼び出されたAPIに対してセキュリティ検証を行います。そのため、APIを呼び出す前に、APIハイブリッド暗号化の記事を参照し、リクエストを暗号化する必要があります。また、curlコマンドに暗号化済みのリクエストヘッダー（${request_headers}）とリクエストボディ（${request_body}）を設定してください。
ステップ１：（オプション）クラスタレベルのバックアップ設定を設定する
任意の obshell の /api/v1/obcluster/backup/config インターフェースを呼び出すことで、クラスタレベルのバックアップ設定を行うことができます。
説明
以前にクラスタレベルのバックアップが設定されている場合は、このインターフェースを複数回呼び出す必要はありません。
コマンドラインで対応するAPIインターフェースを呼び出す方法については、クラスタレベルのバックアップ設定を参照してください。このインターフェースは非同期タスクを作成します。タスクの進捗状況を確認する方法については、タスクの詳細情報を取得するを参照してください。タスクが完了するまで待機すると、設定が完了します。
[admin@test001 ~]$ curl -H "Content-Type: application/json" -H 'X-OCS-Header:${request_headers}' -X POST -d '${request_body}' http://10.10.10.1:2886/api/v1/obcluster/backup/config
暗号化前のリクエストボディの内容は次のとおりです：
{
"backup_base_uri":"file:///data/backup",
"log_archive_concurrency":50
}
obshell-sdk-pythonを使用して、対応するAPIメソッドをリクエストする方法については、クラスタレベルのバックアップ設定を参照してください。
...
client = ClientSet("10.10.10.1", 2886, PasswordAuth("****"))
client.v1.post_cluster_backup_config_sync(
"file:///data/backup",
log_archive_concurrency=100,
)
...
obshell-sdk-goで対応するAPIメソッドをリクエストする方法については、クラスタレベルのバックアップ設定の設定を参照してください。
...
client, err := services.NewClientWithPassword("10.10.10.1", 2886, "****")
request := client.V1().NewClusterBackupConfigPostRequest("file:///data/backup")
request.SetArchiveLagTarget("10s").SetLogArchiveConcurrency(100).
dag, err := client.V1().ClusterBackupConfigSyncWithRequest(request)
...
ステップ2：クラスタレベルのバックアップを開始する
任意のobshellの/api/v1/obcluster/backupインターフェースを呼び出すことで、クラスタレベルのバックアップを開始できます。
コマンドラインで対応するAPIインターフェースを呼び出す方法については、クラスタレベルのバックアップを開始するを参照してください。このインターフェースは非同期タスクを作成します。タスクの進行状況を確認する方法については、タスクの詳細情報を取得するを参照してください。タスクが完了するまで待機すると、バックアップが終了します。
[admin@test001 ~]$ curl -H "Content-Type: application/json" -H 'X-OCS-Header:${request_headers}' -X POST -d '${request_body}' http://10.10.10.1:2886/api/v1/obcluster/backup
暗号化前のリクエストボディの内容は次のとおりです：
{
"mode":"full"
}
obshell-sdk-pythonを使用して対応するAPIメソッドを呼び出す方法については、クラスタレベルのバックアップを開始するを参照してください。
...
client = ClientSet("10.10.10.1", 2886, PasswordAuth("****"))
client.v1.start_cluster_backup_sync("full")
...
obshell-sdk-goで対応するAPIメソッドを呼び出す方法については、クラスタレベルのバックアップを開始するを参照してください。
...
client, err := services.NewClientWithPassword("10.10.10.1", 2886, "****")
request := client.V1().NewClusterBackupRequest()
request.SetBackupMode("full")
dag, err := client.V1().ClusterBackupWithRequest(request)
...
ステップ3：クラスタレベルのバックアップタスクを確認する
任意のobshellの/api/v1/obcluster/backup/overviewインターフェースを呼び出すことで、クラスタレベルのバックアップタスクを確認できます。
コマンドラインで対応するAPIインターフェースを呼び出す方法については、クラスタレベルのバックアップタスクの確認を参照してください。
[admin@test001 ~]$ curl -H "Content-Type: application/json" -H 'X-OCS-Header:${request_headers}' -X GET http://10.10.10.1:2886/api/v1/obcluster/backup/overview
obshell-sdk-pythonを使用して対応するAPIメソッドをリクエストする方法については、クラスタレベルのバックアップタスクの確認を参照してください。
...
client = ClientSet("10.10.10.1", 2886, PasswordAuth("****"))
client.v1.get_cluster_backup_overview()
...
obshell-sdk-goを使用して対応するAPIメソッドをリクエストする方法については、クラスタレベルのバックアップタスクの確認を参照してください。
...
client, err := services.NewClientWithPassword("10.10.10.1", 2886, "****")
res, err := client.V1().GetClusterBackupOverview()
...
obshellコマンドによるバックアップ
ステップ1：クラスタのバックアップ実行
任意のノードでobshell cluster backupコマンドを実行することで、バックアップ設定が完了し、1回のバックアップがトリガーされます。詳細については、obshell クラスタコマンドグループのobshell cluster backupセクションを参照してください。
[admin@test001 ~]$ /home/admin/oceanbase/bin/obshell cluster backup -u 'file:///data/backup'
ステップ2：バックアップタスクの確認
使用するコマンドの詳細については、obshell バックアップコマンドグループのobshell backup showセクションを参照してください。
[admin@test001 ~]$ /home/admin/oceanbase/bin/obshell backup show