调用DescribeDBClusterAccessWhiteList接口查看集群的IP白名单。

调试

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

请求参数

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

系统规定参数,取值:

DescribeDBClusterAccessWhiteList。

DBClusterId String rm-uf6wjk5xxxxxxxxxx

实例ID。

返回数据

名称 类型 示例值 描述
Items Array of IPArray

IP白名单分组列表。

IPArray
DBClusterIPArrayAttribute String hidden

白名单分组属性,默认为空。

说明 控制台不显示带有“hidden”属性的分组,带有该标签的分组通常是用于访问DTS、DRDS服务的。
DBClusterIPArrayName String test

IP白名单分组名称。

  • IP白名单分组名称以小写字母开头、以数字或小写字母结尾,可包含小写字母、数字及’_’,长度为2~32。
  • 单个实例最多支持50个白名单分组。
SecurityIPList String 127.0.0.1

IP白名单分组下的IP列表,最多1000个,以英文逗号(,)隔开。

RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDBClusterAccessWhiteList
&DBClusterId=rm-uf6wjk5xxxxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<Items>
    <IPArray>
        <DBClusterIPArrayName>test</DBClusterIPArrayName>
        <SecurityIPList>127.0.0.1</SecurityIPList>
        <DBClusterIPArrayAttribute>hidden</DBClusterIPArrayAttribute>
    </IPArray>
</Items>

JSON 格式

{
    "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
    "Items": {
        "IPArray": {
            "DBClusterIPArrayName": "test",
            "SecurityIPList": "127.0.0.1",
            "DBClusterIPArrayAttribute": "hidden"
        }
    }
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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