本記事では、APIを使用してクラスタレベルのバックアップタスクを確認する方法について説明します。
呼び出しの注意事項
インターフェース制約
パスワードが設定されている場合、認証が必要です。詳細については、API混合暗号化を参照してください。
リクエストパス
GET /api/v1/obcluster/backup/overview
返却結果
| パラメータ | タイプ | 説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理に要した時間（ミリ秒）です。 |
| status | int | HTTP Status 標準に準拠するエンコードです。 |
| traceId | string | リクエストのTrace IDです。 |
| data | []CdbObBackupTask | バックアップタスクのリスト。詳細については、以下の CdbObBackupTask のデータ構造を参照してください。 |
| error | ApiError | リクエストで発生したエラー情報。以下の情報が含まれます：
|
CdbObBackupTaskのデータ構造：
| パラメータ | タイプ | 説明 |
|---|---|---|
| tenant_id | int | テナントID。 |
| task_id | int | バックアップタスクID、バックアップセットに対応するタスク。 |
| job_id | int | このタスクが属するJOB_ID。 |
| incarnation | int | Flashback Database後の分身回数を表す。 |
| 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 | 毎秒の出力バイト数。 |
| extra_meta_bytes | int | 追加バイト数。 |
| tablet_count | int | TABLETの総数。 |
| finish_tablet_count | int | バックアップ完了したTABLETの総数。 |
| macro_block_count | int | マクロブロック数。 |
| finish_macro_block_count | in | バックアップ完了したマクロブロック数。 |
| 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/obcluster/overview
戻り値の例
{
"successful": true,
"timestamp": "2024-10-12T18:12:51.179120149+08:00",
"duration": 52,
"status": 200,
"traceId": "1868835c2071a85a",
"data": {
"statuses": [
{
"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"
},
{
"tenant_id": 1004,
"task_id": 1,
"job_id": 1,
"incarnation": 1,
"backup_set_id": 1,
"start_timestamp": "2024-10-12T18:08:08.760053+08:00",
"end_timestamp": "2024-10-12T18:10:46.209384+08:00",
"status": "COMPLETED",
"start_scn": 1728727701874235100,
"end_scn": 1728727846169762600,
"user_ls_start_scn": 1728727714351766000,
"encryption_mode": "NONE",
"input_bytes": 101560294,
"output_bytes": 23082192,
"output_rate_bytes": 146600.7626,
"extra_meta_bytes": 0,
"tablet_count": 596,
"finish_tablet_count": 596,
"macro_block_count": 48,
"finish_macro_block_count": 48,
"file_count": 0,
"meta_turn_id": 1,
"data_turn_id": 0,
"result": 0,
"comment": "",
"path": "oss://oss-328067-1012-obshell/backup/archive/test/1/1004/data?host=oss-cn-hangzhou.aliyuncs.com"
}
]
}
}
関連ドキュメント
コマンドラインからAPIインターフェースを呼び出す他に、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用してAPIメソッドをリクエストする方法については、クラスタレベルのバックアップタスクの表示を参照してください。
obshell-sdk-goを使用してAPIメソッドをリクエストする方法については、クラスタレベルのバックアップタスクの表示を参照してください。