ModifyDBClusterAccessWhiteList API を呼び出して IP ホワイトリストを変更する - ClickHouse

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

clickhouse:ModifyDBClusterAccessWhiteList

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。	cc-bp1qx68m06981****
SecurityIps	string	必須	IP アドレスホワイトリスト。次のフォーマットがサポートされています： IP アドレス：例：192.168.0.1。この IP アドレスから ApsaraDB for ClickHouse クラスターへのアクセスを許可します。 CIDR ブロック：例：192.168.0.0/24。192.168.0.1 から 192.168.0.255 までの IP アドレスから ApsaraDB for ClickHouse クラスターへのアクセスを許可します。説明 0.0.0.0 は入力しないでください。このパラメーターを 127.0.0.1 に設定すると、すべての IP アドレスからのアクセスがブロックされます。	192.168.xx.xx
DBClusterIPArrayName	string	任意	変更するホワイトリストグループの名前。説明このパラメーターを指定しない場合、デフォルトグループのホワイトリストが変更されます。	default
DBClusterIPArrayAttribute	string	任意	ホワイトリストグループの属性。デフォルト値は empty です。	NULL
ModifyMode	string	任意	変更メソッド。有効値： Cover：ホワイトリストを上書きします。 Append：IP アドレスをホワイトリストに追加します。 Delete：ホワイトリストから IP アドレスを削除します。説明このパラメーターを指定しない場合、デフォルトで Cover メソッドが使用されます。	Cover

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC

例

成功レスポンス

JSONJSON

{
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。