ModifyDBClusterAccessWhitelist API による PolarDB クラスターアクセス保護 - PolarDB - Alibaba Cloud - PolarDB

クラスターのホワイトリスト（IP ホワイトリストおよびセキュリティグループを含む）を作成または変更します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:ModifyDBClusterAccessWhitelist

update

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスターの ID。	pc-*************
SecurityIps	string	任意	IP ホワイトリストグループ内の IP アドレスまたは CIDR ブロック。すべての IP ホワイトリストグループに最大 1,000 個の IP アドレスまたは CIDR ブロックを追加できます。複数の IP アドレスはコンマ (,) で区切ります。以下の 2 つのフォーマットがサポートされています。 IP アドレス形式（例: 10.23.12.24）。 CIDR 形式（例: 10.23.12.24/24）。24 は CIDR ブロックのプレフィックス長を示します。プレフィックス長の範囲は 1～32 です。説明このパラメーターは、WhiteListType が IP に設定されている場合にのみ有効です。	10.23.12.24
DBClusterIPArrayName	string	任意	IP ホワイトリストグループの名前。名前の長さは 2～120 文字で、小文字と数字を含めることができます。名前は英字で始まり、英字または数字で終わる必要があります。指定されたホワイトリストグループ名が存在しない場合、新しいホワイトリストグループが作成されます。指定されたホワイトリストグループ名が既に存在する場合、そのホワイトリストグループが変更されます。このパラメーターを指定しない場合、デフォルトグループが変更されます。説明クラスターあたり最大 50 個の IP ホワイトリストグループがサポートされています。このパラメーターは、WhiteListType が IP に設定されている場合にのみ有効です。	default
DBClusterIPArrayAttribute	string	任意	IP ホワイトリストグループの属性。このパラメーターを hidden に設定すると、そのグループはコンソールに表示されません。説明既にコンソールに表示されている IP ホワイトリストグループは非表示にできません。このパラメーターは、WhiteListType が IP に設定されている場合にのみ有効です。	hidden
WhiteListType	string	任意	ホワイトリストのタイプ。有効な値: IP: IP ホワイトリストグループ。 SecurityGroup: セキュリティグループ。デフォルト値: IP。	IP
SecurityGroupIds	string	任意	セキュリティグループの ID。複数のセキュリティグループ ID はコンマ (,) で区切ります。説明クラスターあたり最大 3 個のセキュリティグループがサポートされています。このパラメーターは、WhiteListType が SecurityGroup に設定されている場合にのみ有効です。	sg-*********
ModifyMode	string	任意	IP ホワイトリストを変更するメソッド。有効な値: Cover: 元の IP ホワイトリストを上書きします（デフォルト値）。 Append: ホワイトリストに IP アドレスを追加します。 Delete: ホワイトリストから IP アドレスを削除します。説明このパラメーターは、WhiteListType が IP に設定されている場合にのみ有効です。	Cover

レスポンスフィールド

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

例

成功レスポンス

JSONJSON

{
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	NumberExceed.securityGroupIds	The number of SecurityGroupIds exceeds 10.	操作が失敗しました。セキュリティグループの数が上限の 10 を超えています。構成を変更して再試行してください。
400	InvalidSecurityIPList.Duplicate	Specified security IP list is not valid: Duplicate IP address in the list	指定されたセキュリティ IP リストは無効です。リストに重複する IP アドレスが含まれています。
400	InvalidSecurityIPList.Format	Specified security IP list format is not valid.	ホワイトリストで指定された IP アドレスのフォーマットが無効です。
400	LockTimeout	The request processing has failed due to lock timeout.	ロックタイムアウトのため、リクエストの処理に失敗しました。
403	SecurityIPList.Duplicate	Specified same security IP already exists.	指定されたセキュリティ IP アドレスは既に存在します。
403	OperationDenied.LockMode	The operation is not permitted when the instance is locked.	ソース ApsaraDB RDS インスタンスの現在のステータスではこの操作を実行できません。
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	操作に失敗しました。指定されたクラスターインスタンス ID が存在しません。
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	指定された DBClusterId は現在のレコードに存在しません。

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

変更履歴

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