本記事では、APIを使用して指定したテナントのアクセスホワイトリストを変更する方法について説明します。
呼び出しの説明
パスワードが設定されている場合は、認証が必要です。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
PUT /api/v1/tenant/:name/whitelist
リクエストパラメータ
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| whitelist | string | はい | % | テナントのアクセスホワイトリスト。 |
レスポンス結果
パラメータ |
型 |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間(ミリ秒)です。 |
| status | int | HTTPステータスコードに準拠したエンコードです。 |
| 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メソッドの呼び出しについては、テナントのアクセスホワイトリストの変更を参照してください。