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})を設定する必要があります。
ステップ1：(オプション) テナントレベルバックアップの設定を行う
任意のobshellの /api/v1/tenant/:name/backup/config インターフェースを呼び出すことで、テナントレベルバックアップの設定を行えます。
説明
以前にテナントレベルバックアップが設定済みの場合は、このインターフェースを複数回呼び出す必要はありません。
コマンドラインで対応するAPIを呼び出す方法の説明については、単一テナントのバックアップ設定を参照してください。この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/tenant/tenant1/backup/config
暗号化前のリクエストボディの内容は以下のとおりです：
{
"data_base_uri":"file:///data/backup/tenant/data",
"archive_base_uri":"file:///data/backup/tenant/archive",
"log_archive_concurrency":50,
"ha_low_thread_score":18,
"piece_switch_interval":"3d",
"archive_lag_target":"1h",
"delete_policy":{
"policy":"",
"recovery_window":"2d"
}
}
obshell-sdk-pythonを使用して対応するAPIメソッドを呼び出す方法の紹介については、単一テナントのバックアップ設定を参照してください。
...
client = ClientSet("10.10.10.1", 2886, PasswordAuth("****"))
client.v1.post_tenant_backup_config_sync(
"file:///data/backup/tenant/data",
"file:///data/backup/tenant/archive",
log_archive_concurrency=100,
)
...
obshell-sdk-goを使用して対応するAPIメソッドを呼び出す方法の紹介については、単一テナントのバックアップ設定を参照してください。
...
client, err := services.NewClientWithPassword("10.10.10.1", 2886, "****")
request := client.V1().NewTenantBackupConfigPostRequest("tenant1", "file:///data/backup/data", "file:///data/backup/archive")
request.SetLogArchiveConcurrency(100)
dag, err := client.V1().TenantBackupConfigSyncWithRequest(request)
...
ステップ2：テナントレベルのバックアップを開始する
任意のobshellの /api/v1/tenant/:name/backup インターフェースを呼び出すことで、テナントレベルのバックアップを開始できます。
コマンドラインで対応するAPIを呼び出す方法の説明については、単一テナントのバックアップを開始するを参照してください。この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/tenant/tenant1/backup
暗号化前のリクエストボディの内容は以下のとおりです：
{
"mode":"full"
}
obshell-sdk-pythonを使用して対応するAPIメソッドを呼び出す方法の紹介については、単一テナントのバックアップを開始するを参照してください。
...
client = ClientSet("10.10.10.1", 2886, PasswordAuth("****"))
client.v1.start_tenant_backup_sync("tenant1", "full")
...
obshell-sdk-goを使用して対応するAPIメソッドを呼び出す方法の紹介については、単一テナントのバックアップを開始するを参照してください。
...
client, err := services.NewClientWithPassword("10.10.10.1", 2886, "****")
request := client.V1().NewTenantBackupRequest("tenant1")
request.SetBackupMode("full")
dag, err := client.V1().TenantBackupSyncWithRequest(request)
...
ステップ3：テナントレベルのバックアップタスクを確認する
任意のobshellで /api/v1/tenant/:name/backup/overview インターフェースを呼び出すと、テナントレベルのバックアップタスクを確認できます。
コマンドラインで対応するAPIインターフェースを呼び出す方法については、単一テナントのバックアップタスクを確認するを参照してください。
[admin@test001 ~]$ curl
-H "Content-Type: application/json"
-X GET
http://10.10.10.1:2886/api/v1/tenant/tenant1/backup/overview
obshell-sdk-pythonを使用して対応するAPIメソッドをリクエストする方法については、単一テナントのバックアップタスクを確認するを参照してください。
...
client = ClientSet("10.10.10.1", 2886, PasswordAuth("****"))
client.v1.get_tenant_backup_overview("tenant1")
...
obshell-sdk-goを使用して対応するAPIメソッドをリクエストする方法については、単一テナントのバックアップタスクを確認するを参照してください。
...
client, err := services.NewClientWithPassword("10.10.10.1", 2886, "****")
res, err := client.V1().GetTenantBackupOverview("tenant1")
...
obshellコマンドを使用したバックアップ
ステップ1：バックアップの実行
任意のノードで obshell tenant backup コマンドを実行すると、バックアップの設定が完了し、1回のバックアップがトリガーされます。コマンドの詳細については、obshell テナントコマンドグループの obshell tenant backup のセクションを参照してください。
[admin@test001 ~]$ /home/admin/oceanbase/bin/obshell tenant backup tenant1 -a 'file:///data/backup/archive' -d 'file:///data/backup/data'
ステップ2：バックアップ情報の確認
使用するコマンドの詳細については、obshell バックアップコマンドグループの obshell backup show のセクションを参照してください。
[admin@test001 ~]$ /home/admin/oceanbase/bin/obshell backup show -t tenant1