AddFirewallRules - 添加防火墙规则

添加sql防火墙配置

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:AddFirewallRules

create

*DBCluster

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

请求参数

名称

类型

必填

描述

示例值

DBClusterId

string

集群 ID。

pc-*****************

RuleName

string

防火墙规则名称。一次仅支持输入一个规则名称。

说明
  • 您可以通过接口 DescribeFirewallRules 查看目标集群下的所有防火墙规则详情,包括规则名称。

  • 若输入的规则名称不存在于当前集群中,系统会自动根据该名称和RuleConfig值创建一个新的防火墙规则。

testrule

RuleConfig

string

需要添加的防火墙规则的配置参数及其值的 JSON 串,参数的值都是字符串类型,例如:{"id":"test","enabled":"true","mode":"Collecting","users":{"applies_to":[]},"endpoint":"[{"EndpointName":"pe-************","EndpointType":"Cluster","DBEndpointDescription":"集群地址"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************K"}]","type":"WhiteList"}。其中:

  • "id":必填,表示防火墙规则名称。

  • "endpoint":必填。对应实例 Endpoint 地址信息。

{"id":"test","enabled":"true","mode":"Collecting","users":{"applies_to":[]},"endpoint":"[{"EndpointName":"pe-************","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************K"}]","type":"WhiteList"}

ResourceGroupId

string

资源组 id。

rg-************

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

2921D843-433A-5FB3-A03B-4EC093B219F8

Message

string

返回信息。

Successful

Success

boolean

请求结果。取值:

  • true:请求成功。

  • false:请求失败。

True

示例

正常返回示例

JSON格式

{
  "RequestId": "2921D843-433A-5FB3-A03B-4EC093B219F8",
  "Message": "Successful",
  "Success": true
}

错误码

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

变更历史

更多信息,参考变更详情