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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
DBClusterId String 是 pc-xxxxxxxxxxx

数据库集群ID。
AccessKeyId String 否 key-test

阿里云颁发给用户的访问服务所用的密钥ID。
Action String 否 DescribeDBClusterAccessWhitelist

系统规定参数，取值：DescribeDBClusterAccessWhitelist。

返回数据

名称 类型 示例值 描述
DBClusterSecurityGroups Array

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

集群关联的ECS安全组列表。
SecurityGroupId String sg-bpxxxxxxxx

ECS安全组ID。
SecurityGroupName String mytest1

ECS安全组名称。
Items Array

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

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

IP白名单分组属性。
DBClusterIPArrayName String default

IP白名单分组名称。
SecurityIps String 11.xx.xx.xx,11.xx.xx.xx

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

  • IP地址形式，例如：10.23.12.24。
  • CIDR形式，例如：10.23.12.24/24（无类域间路由，24表示了地址中前缀的长度，范围为1~32）。
RequestId String 8D0429EC-8E2C-4675-8102-28AC6FE92751

请求ID。

示例

请求示例


http(s)://[Endpoint]/?Action=DescribeDBClusterAccessWhitelist
&DBClusterId=pc-xxxxxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式 

<Items>
    <DBClusterIPArray>
        <DBClusterIPArrayAttribute/>
        <DBClusterIPArrayName>default</DBClusterIPArrayName>
        <SecurityIps>127.0.0.1</SecurityIps>
    </DBClusterIPArray>
    <DBClusterIPArray>
        <DBClusterIPArrayAttribute>hidden</DBClusterIPArrayAttribute>
        <DBClusterIPArrayName>maxscale</DBClusterIPArrayName>
        <SecurityIps>11.xx.xx.xx,11.xx.xx.xx</SecurityIps>
    </DBClusterIPArray>
</Items>
<RequestId>0E863680-F8AC-4EE5-B090-31529D3CFD30</RequestId>
<DBClusterSecurityGroups>
    <DBClusterSecurityGroup>
        <SecurityGroupId>sg-bpxxxxxxxx</SecurityGroupId>
        <SecurityGroupName>mytest1</SecurityGroupName>
    </DBClusterSecurityGroup>
</DBClusterSecurityGroups>

JSON 格式 

{
	"Items":{
		"DBClusterIPArray":[
			{
				"DBClusterIPArrayAttribute":"",
				"DBClusterIPArrayName":"default",
				"SecurityIps":"127.0.0.1"
			},
			{
				"DBClusterIPArrayAttribute":"hidden",
				"DBClusterIPArrayName":"maxscale",
				"SecurityIps":"11.xx.xx.xx,11.xx.xx.xx"
			}
		]
	},
	"RequestId":"0E863680-F8AC-4EE5-B090-31529D3CFD30",
	"DBClusterSecurityGroups":{
		"DBClusterSecurityGroup":[
			{
				"SecurityGroupId":"sg-bpxxxxxxxx",
				"SecurityGroupName":"mytest1"
			}
		]
	}
}

错误码

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