本記事では、APIを使用して単一テナントのバックアップステータスを変更する方法について説明します。
呼び出しの概要
インターフェース制約
パスワードが設定されている場合は、認証が必要です。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
PATCH /api/v1/tenant/:name/backup
リクエストパラメータ
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| status | string | いいえ | "canceled" | バックアップステータス。デフォルトは canceled です。現在、canceled のみ設定可能です。 |
戻り値
パラメータ |
型 |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうか。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプ。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）。 |
| status | int | HTTPステータスコード仕様に準拠したエンコード。 |
| traceId | string | リクエストのTrace ID。 |
| error | ApiError | リクエストで発生したError。以下の情報を含みます：
|
例
リクエスト例
PATCH 10.10.10.1:2886/api/v1/tenant/t1/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メソッドの呼び出しについては、単一テナントのバックアップステータスの変更を参照してください。