本記事では、APIを使用してクラスタレベルのバックアップ状態を変更する方法について説明します。
呼び出しの概要
接続制約
パスワードが設定されている場合は、認証が必要です。詳細についてはAPIハイブリッド暗号化を参照してください。
リクエストパス
PATCH /api/v1/obcluster/backup
リクエストパラメータ
| パラメータ | タイプ | 必須 | サンプル値 | 説明 |
|---|---|---|---|---|
| status | string | いいえ | "canceled" | バックアップ状態。デフォルトはcanceledです。現在、canceledに設定することのみサポートされています。 |
実行結果
| パラメータ | タイプ | 説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）です。 |
| status | int | HTTP Status規格に準拠するエンコードです。 |
| traceId | string | リクエストのトレースIDです。 |
| error | ApiError | リクエストによって生成されたエラーで、以下の情報が含まれます：
|
例
リクエスト例
PATCH 10.10.10.1:2886/api/v1/obcluster/backup
{
"status": "canceled",
}
実行結果例
{
"successful": true,
"timestamp": "2024-01-09T17:11:43.385889278+08:00",
"duration": 1,
"status": 200,
"traceId": "877fe32b83634153",
}
関連ドキュメント
コマンドラインからAPIを呼び出す以外に、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドのリクエスト方法の紹介については、クラスタレベルのバックアップ状態の変更を参照してください。
obshell-sdk-goを使用したAPIメソッドのリクエスト方法の紹介については、クラスタレベルのバックアップ状態の変更を参照してください。