本記事では、APIを使用して指定したテナントのアクセス許可リストを変更する方法について説明します。
呼び出しの説明
パスワードが設定されている場合は、認証が必要です。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
PUT /api/v1/tenant/:name/whitelist
リクエストパラメータ
パラメータ |
タイプ |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| whitelist | string | はい | % | テナントのアクセス許可リスト。 |
レスポンス結果
パラメータ |
タイプ |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうか。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプ。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）。 |
| status | int | HTTP Status仕様に準拠したエンコード。 |
| traceId | string | リクエストのTrace ID。 |
| error | ApiError | リクエストで発生したError。以下の情報を含みます：
|
例
リクエスト例
PUT 10.10.10.1:2886/api/v1/tenant/t1/whitelist
{
"whitelist": "%"
}
レスポンス例
{
"successful": true,
"timestamp": "2024-10-14T11:42:12.873282458+08:00",
"duration": 91,
"status": 200,
"traceId": "e425830225b2b611"
}
関連ドキュメント
コマンドラインからAPIを呼び出すほかに、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドの呼び出しについては、テナントアクセスホワイトリストの変更を参照してください。
obshell-sdk-goによるAPIメソッドのリクエスト方法については、テナントアクセスホワイトリストの変更を参照してください。