本記事では、APIを使用して単一テナントのバックアップタスクを確認する方法について説明します。
呼び出しの説明
インターフェース制約
パスワードが設定されている場合は、認証を通過する必要があります。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
GET /api/v1/tenant/:name/backup/overview
実行結果
| パラメータ | タイプ | 説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）です。 |
| status | int | HTTP Status規格に準拠したエンコードです。 |
| traceId | string | リクエストのトレースIDです。 |
| data | CdbObBackupTask | バックアップタスクリストです。 |
| error | ApiError | リクエストによって生成されたエラーで、以下の情報が含まれます：
|
CdbObBackupTaskのデータ構造：
| パラメータ | タイプ | 説明 |
|---|---|---|
| tenant_id | int | テナントID。 |
| task_id | int | タスクレベルのバックアップタスクID。1つのバックアップセットに対応するタスクを表します。 |
| job_id | int | このタスクが属するJOB_ID。 |
| incarnation | int | フラッシュバックデータベース後の第何回目の分身を表します。 |
| backup_set_id | int | このタスクに対応するバックアップセットID。 |
| start_timestamp | time.Time | タスクの開始時間。 |
| end_timestamp | time.Time | タスクの終了時間。 |
| status | string | バックアップの状態。 |
| start_scn | int | バックアップ開始時のSCN。 |
| end_scn | int | バックアップ終了時のSCN。 |
| user_ls_start_scn | int | バックアップログログストリームMETAのSCN。 |
| encryption_mode | string | 暗号化モード。以下の値があります：
NoneとPasswordの2種類のモードのみサポートしています。 |
| input_bytes | int | 入力バイト数。 |
| output_bytes | int | 出力バイト数。 |
| output_rate_bytes | int | 1秒あたりの出力バイト数。 |
| extra_meta_bytes | int | 追加バイト数。 |
| tablet_count | int | TABLETの総数。 |
| finish_tablet_count | int | バックアップ完了のTABLETの総数。 |
| macro_block_count | int | マクロブロック数。 |
| finish_macro_block_count | int | バックアップ完了のマクロブロック数。 |
| file_count | int | バックアップファイル数。 |
| meta_turn_id | int | バックアップMETAのラウンド。 |
| data_turn_id | int | バックアップDATAのラウンド。 |
| result | int | バックアップエラーコード結果。 |
| comment | string | エラーコードの説明。 |
| path | string | バックアップパス。 |
例
リクエスト例
GET 10.10.10.1:2886/api/v1/tenant/tenant1/backup/overview
レスポンス例
{
"successful": true,
"timestamp": "2024-10-12T18:16:17.54002369+08:00",
"duration": 36,
"status": 200,
"traceId": "11ae266d93f6e7c7",
"data": {
"status": {
"tenant_id": 1002,
"task_id": 1,
"job_id": 1,
"incarnation": 1,
"backup_set_id": 1,
"start_timestamp": "2024-10-12T18:08:08.723714+08:00",
"end_timestamp": "2024-10-12T18:10:43.487426+08:00",
"status": "COMPLETED",
"start_scn": 1728727696264250400,
"end_scn": 1728727843446713000,
"user_ls_start_scn": 1728727710694531300,
"encryption_mode": "NONE",
"input_bytes": 128825794,
"output_bytes": 22320897,
"output_rate_bytes": 144225.6503,
"extra_meta_bytes": 0,
"tablet_count": 596,
"finish_tablet_count": 596,
"macro_block_count": 61,
"finish_macro_block_count": 61,
"file_count": 0,
"meta_turn_id": 1,
"data_turn_id": 0,
"result": 0,
"comment": "",
"path": "oss://oss-328067-1012-obshell/backup/archive/test/1/1002/data?host=oss-cn-hangzhou.aliyuncs.com"
}
}
}
関連ドキュメント
APIインターフェースをコマンドラインで呼び出す以外に、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドのリクエスト方法の紹介については、単一テナントのバックアップタスクの表示を参照してください。
obshell-sdk-goを使用したAPIメソッドのリクエスト方法の紹介については、単一テナントのバックアップタスクの表示を参照してください。