ModifyDBClusterAccessWhitelist - - Alibaba Cloud ドキュメントセンター

今すぐお試しください

この 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 アドレスはコンマ (,) で区切ります。次のフォーマットがサポートされています： IP アドレスフォーマット。例：10.23.12.24。 CIDR フォーマット。例：10.23.12.24/24。24 は IP アドレスのプレフィックス長を示します。プレフィックス長の有効値は 1～32 です。説明このパラメーターは、WhiteListType が IP に設定されている場合にのみ使用できます。	10.23.12.24
DBClusterIPArrayName	string	任意	IP アドレスホワイトリストグループの名前。名前の長さは 2～120 文字である必要があります。小文字と数字で構成する必要があります。名前は文字で始まり、文字または数字で終わる必要があります。指定したホワイトリストグループ名が存在しない場合、新しいホワイトリストグループが作成されます。指定したホワイトリストグループ名が既に存在する場合、そのホワイトリストグループが変更されます。このパラメーターを指定しない場合、`default` グループが変更されます。説明クラスターには最大 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******"
}

エラーレスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	NumberExceed.securityGroupIds	The number of SecurityGroupIds exceeds 10.
400	InvalidSecurityIPList.Duplicate	Specified security IP list is not valid: Duplicate IP address in the list
400	InvalidSecurityIPList.Format	Specified security IP list format is not valid.
400	LockTimeout	The request processing has failed due to lock timeout.
403	SecurityIPList.Duplicate	Specified same security IP already exists.
403	OperationDenied.LockMode	The operation is not permitted when the instance is locked.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.

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

変更履歴

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