使用DescribeDBClusterAccessWhitelist查询集群的IP白名单和安全组-云原生数据库 PolarDB-阿里云-云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。	pc-***************
PfsInstanceId	string	否		pfs-xxx

返回参数

名称	类型	描述	示例值
	object
DBClusterSecurityGroups	object
DBClusterSecurityGroup	array<object>	集群关联的 ECS 安全组列表。
	object
SecurityGroupId	string	ECS 安全组 ID。	sg-bp**************
SecurityGroupName	string	ECS 安全组名称。	vpc-********************
Items	object
DBClusterIPArray	array<object>	集群的 IP 白名单分组列表。
	object
DBClusterIPArrayAttribute	string	IP 白名单分组属性。	hidden
DBClusterIPArrayName	string	IP 白名单分组名称。	default
SecurityIps	string	IP 白名单分组下的 IP 列表，最多 1000 个，多个 IP 间用英文逗号（,）隔开，支持如下两种格式： IP 地址形式，例如：10.xx.xx.24。 CIDR 形式，例如：10.xx.xx.24/24（无类域间路由，24 表示了地址中前缀的长度，范围为 1~32）。	11.*..,11...*
RequestId	string	请求 ID。	559E91A2-CDA3-4E9F-808B-29D738******

示例

正常返回示例

JSON格式

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

异常返回示例

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"
}

错误码

HTTP status code	错误码	错误信息	描述
403	Forbidden.RAM	User not authorized to operate on the specified resource, or this API does not support RAM.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	当前的记录中不存在提供的DBClusterId。
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	当前的记录中不存在提供的DBClusterId。

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

变更历史

更多信息，参考变更详情。