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

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeDBClusterAccessWhitelist

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

无

请求参数

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

返回参数

名称	类型	描述	示例值
	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。

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

变更历史

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