指定した ApsaraDB for PolarDB クラスターの IP アドレスホワイトリストを照会する操作です。

デバッグ

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

リクエストパラメーター

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

ApsaraDB for PolarDB クラスターの ID
AccessKeyId String いいえ key-test

Alibaba Cloud から提供された AccessKey ID
Action String いいえ DescribeDBClusterAccessWhitelist

実行する操作。 値を DescribeDBClusterAccessWhitelist に設定します。

レスポンスパラメーター

パラメーター データ型 例 説明
Items

クラスターの IP アドレスホワイトリストのリスト
DBClusterIPArray

IP アドレスホワイトリストの詳細
DBClusterIPArrayAttribute String hidden

IP アドレスホワイトリストの属性
DBClusterIPArrayName String default

IP アドレスホワイトリストの名前
SecurityIps String 11.xx.xx.xx,11.xx.xx.xx

IP アドレスホワイトリスト内の IP アドレス。 各ホワイトリストには、最大 1,000 個の IP アドレスを入れることができます。 複数の IP アドレスがある場合、コンマ (,) で区切ります。 以下の 2 通りの形式をサポートしています。

  • 10.23.12.24 などの標準 IP アドレス形式。
  • 10.23.12.24/24 などの CIDR (Classless Inter-Domain Routing) ブロック。24 は CIDR ブロックのプレフィックスが 24 ビットであることを示します。 24 は 1~32 の範囲の値に置き換えることができます。
RequestId String 8D0429EC-8E2C-4675-8102-28AC6FE92751

リクエストの ID

コーディング例

リクエスト例


http(s)://[Endpoint]/? Action=DescribeDBClusterAccessWhitelist
&DBClusterId=pc-xxxxxxxxxxx
&<共通リクエストパラメーター>

通常のレスポンス例

XML 形式 

<DescribeDBClusterAccessWhitelistResponse>  
      <Items>
            <DBClusterIPArray>
                  <DBClusterIPArrayAttribute></DBClusterIPArrayAttribute>
                  <DBClusterIPArrayName>default</DBClusterIPArrayName>
                  <SecurityIPList>127.0.0.1</SecurityIPList>
            </DBClusterIPArray>
            <DBClusterIPArray>
                  <DBClusterIPArrayAttribute>hidden</DBClusterIPArrayAttribute>
                  <DBClusterIPArrayName>maxscale</DBClusterIPArrayName>
                  <SecurityIPList>11.xx.xx.xx,11.xx.xx.xx</SecurityIPList>
            </DBClusterIPArray>
      </Items>
      <RequestId>8D0429EC-8E2C-4675-8102-28AC6FE92751</RequestId>
</DescribeDBClusterAccessWhitelistResponse>

JSON 形式 

{
	"Items":{
		"DBClusterIPArray":[
			{
				"DBClusterIPArrayAttribute":"",
				"DBClusterIPArrayName":"default",
				"SecurityIPList":"127.0.0.1"
			},
			{
				"DBClusterIPArrayAttribute":"hidden",
				"DBClusterIPArrayName":"maxscale",
				"SecurityIPList":"11.xx.xx.xx,11.xx.xx.201"
			}
		]
	},
	"RequestId":"8D0429EC-8E2C-4675-8102-28AC6FE92751"
}

エラーコード

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