この操作を呼び出して、ApsaraDB for PolarDB クラスターの IP ホワイトリストとセキュリティグループを作成または変更できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 OpenAPI Explorer を使用すると、API を簡単に設定できます。 OpenAPI Explorer は、各種 SDK 用のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須項目 例 説明
DBClusterId String はい pc-xxxxxxxxx

ApsaraDB for PolarDB クラスターの ID。
Action String いいえ ModifyDBClusterAccessWhitelist

実行する操作。 この値を ModifyDBClusterAccessWhitelist に設定します。

AccessKeyId String いいえ key-test

Alibaba Cloud から提供された AccessKey ID。
WhiteListType String いいえ IP

ホワイトリストのタイプ。 設定可能な値は以下のとおりです。

  • IP：IP アドレスホワイトリスト
  • SecurityGroup：セキュリティグループ

デフォルト値：IP
DBClusterIPArrayName String いいえ default

IP アドレスホワイトリストの名前。 長さは 2～120 文字で、小文字と数字を含む必要があります。 先頭はアルファベット、末尾はアルファベットか数字にする必要があります。

  • 指定したホワイトリストが存在しない場合は、指定した名前のホワイトリストが作成されます。
  • 指定されたホワイトリストが存在する場合、このホワイトリストは変更されます。
  • このパラメーターを指定しない場合、デフォルトのホワイトリストが変更されます。
注
  • ApsaraDB for PolarDB クラスターには、最大 50 個のホワイトリストを作成できます。
  • このパラメーターは、WhiteListType パラメーターが IP に設定されている場合のみ有効です。
DBClusterIPArrayAttribute String いいえ hidden

IP アドレスホワイトリストの属性。 hidden が指定されているホワイトリストは、コンソールに表示されません。

注
  • コンソールに表示されているホワイトリストは非表示にできません。
  • このパラメーターは、WhiteListType パラメーターが IP に設定されている場合のみ有効です。
SecurityIps String いいえ 127.0.0.1

IP アドレスホワイトリストの IP アドレスまたは CIDR ブロック。 最大 1,000 個の IP アドレスまたは CIDR ブロックをホワイトリストに追加できます。 複数の IP アドレスはカンマ (,) で区切ります。 以下の 2 つの形式をサポートしています。

  • 10.23.12.24 などの標準 IP アドレス形式。
  • 10.23.12.24/24 などの CIDR ブロック。24 は CIDR ブロックのプレフィックスが 24 ビットであることを示します。 24 を 1～32 の範囲の値に置き換えることができます。
注 このパラメーターは、WhiteListType パラメーターが IP に設定されている場合のみ有効です。
SecurityGroupIds String いいえ sg-xxxxxxxxx

セキュリティグループの ID。 複数のグループを入力する場合は、カンマ (,) で区切ります。

注
  • クラスターには最大 3 つのセキュリティグループを追加できます。
  • このパラメーターは、WhiteListType パラメーターが SecurityGroup に設定されている場合のみ有効です。

レスポンスパラメーター

パラメーター データ型 例 説明
RequestId String D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC

リクエストの ID。

例

リクエストの例


https://polardb.aliyuncs.com/?Action=ModifyDBClusterAccessWhitelist
&DBClusterId=pc-xxxxxxxxx
&SecurityIps=127.0.0.1
&<[共通レスポンスパラメーター]>

通常のレスポンス例

XML 形式 

<ModifyDBClusterAccessWhitelistResponse>  
      <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>
</ModifyDBClusterAccessWhitelistResponse>

JSON 形式 

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

エラーコード

エラーコードについては、「API エラーセンター」をご参照ください。