调用DescribeDBClusterAccessWhitelist接口查看允许访问数据库集群的IP白名单和安全组。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBClusterAccessWhitelist

系统规定参数,取值:DescribeDBClusterAccessWhitelist

DBClusterId String pc-***************

集群ID。

返回数据

名称 类型 示例值 描述
DBClusterSecurityGroups Array of DBClusterSecurityGroup

集群关联的ECS安全组列表。

DBClusterSecurityGroup
SecurityGroupId String sg-bp**************

ECS安全组ID。

SecurityGroupName String vpc-********************

ECS安全组名称。

Items Array of DBClusterIPArray

集群的IP白名单分组列表。

DBClusterIPArray
DBClusterIPArrayAttribute String hidden

IP白名单分组属性。

DBClusterIPArrayName String default

IP白名单分组名称。

SecurityIps String 11.***.***.***,11.***.***.***

IP白名单分组下的IP列表,最多1000个,多个IP间用英文逗号(,)隔开,支持如下两种格式:

  • IP地址形式,例如:10.xx.xx.24。
  • CIDR形式,例如:10.xx.xx.24/24(无类域间路由,24表示了地址中前缀的长度,范围为1~32)。
RequestId String 559E91A2-CDA3-4E9F-808B-29D738******

请求ID。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeDBClusterAccessWhitelist
&DBClusterId=pc-***************
&<公共请求参数>

正常返回示例

XML 格式

<DescribeDBClusterAccessWhitelistResponse>
  <RequestId>559E91A2-CDA3-4E9F-808B-29D738******</RequestId>
  <Items>
        <DBClusterIPArray>
              <SecurityIps>127.0.0.1</SecurityIps>
              <DBClusterIPArrayName>default</DBClusterIPArrayName>
              <DBClusterIPArrayAttribute></DBClusterIPArrayAttribute>
        </DBClusterIPArray>
        <DBClusterIPArray>
              <SecurityIps>11.***.***.***</SecurityIps>
              <DBClusterIPArrayName>test</DBClusterIPArrayName>
              <DBClusterIPArrayAttribute>hidden</DBClusterIPArrayAttribute>
        </DBClusterIPArray>
  </Items>
  <DBClusterSecurityGroups>
        <DBClusterSecurityGroup>
              <SecurityGroupName>vpc-********************</SecurityGroupName>
              <SecurityGroupId>sg-******************</SecurityGroupId>
        </DBClusterSecurityGroup>
  </DBClusterSecurityGroups>
</DescribeDBClusterAccessWhitelistResponse>

JSON 格式

{
	"RequestId": "559E91A2-CDA3-4E9F-808B-29D738******",
	"Items": {
		"DBClusterIPArray": [
			{
				"SecurityIps": "127.0.0.1",
				"DBClusterIPArrayName": "default",
				"DBClusterIPArrayAttribute": ""
			},
			{
				"SecurityIps": "11.***.***.***,11.***.***.***",
				"DBClusterIPArrayName": "test",
				"DBClusterIPArrayAttribute": "hidden"
			}
		]
	},
	"DBClusterSecurityGroups": {
		"DBClusterSecurityGroup": [
			{
				"SecurityGroupName": "vpc-********************",
				"SecurityGroupId": "sg-******************"
			}
		]
	}
}

错误码

访问错误中心查看更多错误码。