本記事では、APIを使用して指定されたテナントをロックする方法について説明します。テナントがロックされると、そのテナント上で新しい接続を作成することはできなくなりますが、既存の接続は維持されます。
呼び出しの説明
パスワードが設定されている場合は、認証が必要です。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
POST /api/v1/tenant/:name/lock
実行結果
| パラメータ | タイプ | 説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間(ミリ秒)です。 |
| status | int | HTTP Status規格に準拠するエンコードです。 |
| traceId | string | リクエストのトレースIDです。 |
| error | ApiError | リクエストによって生成されたエラーで、以下の情報が含まれます:
|
例
リクエスト例
POST 10.10.10.1:2886/api/v1/tenant/t1/lock
実行結果例
{
"successful": true,
"timestamp": "2024-10-14T10:29:49.199126252+08:00",
"duration": 59,
"status": 200,
"traceId": "0f40c14342ff2e32"
}
関連ドキュメント
コマンドラインからAPIを呼び出す以外に、SDKメソッドを使用してAPIを呼び出すこともできます。