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