You need to enable JavaScript to run this app.
导航
云防火墙
  • 文档首页
    • /
  • 云防火墙

AddControlPolicy - 创建互联网边界流量控制网关访问控制策略

最近更新时间：2024.03.28 17:09:33

首次发布时间：2024.03.28 17:09:33

我的收藏

创建互联网边界流量控制网关访问控制策略

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

AddControlPolicy

要执行的操作，取值：AddControlPolicy

Version
String
是

2021-09-06

API的版本，取值：2021-09-06

Direction
String
是

in

访问控制策略的流量方向：

  • in：外对内流量访问控制
  • out：内对外流量访问控制
Prio
Integer
否

1

访问控制策略优先级：

  • 0: 最低优先级
  • 1: 最高优先级
  • 其他: 其他优先级
    默认是最低优先级
Source
String
是

192.168.0.1/32

访问控制策略中的源地址：

  • 当SourceType为 net 时，Source为源CIDR地址。例如：192.168.1.1/32
  • 当SourceType为 group 时，Source为源地址簿的uuid列表，最多支持50个地址簿,多个地址簿用英文逗号分隔。例如：f04ac7ce-628b-4cb7-be61-310222b7****, f04ac7ce-628b-4cb7-be61-310222b7****
  • 当SourceType为location时，Source为源区域，多个地域通过英文逗号分隔。例如：BJ11, ZB
SourceType
String
是

net

访问控制策略中的源地址类型：

  • net：源网段(cidrv4)
  • group：源地址簿
  • location：源区域
Destination
String
是

192.168.0.2/32

访问控制策略中的目的地址：

  • 当DestinationType为net时，Destination为目的CIDR地址。例如：192.168.0.2/32
  • 当DestinationType为group时，Destination为目的址簿的uuid列表，多个地址簿用英文逗号分隔。例如：f04ac7ce-628b-4cb7-be61-310222b7****, f04ac7ce-628b-4cb7-be61-310222b7****
  • 当DestinationType为location时，Destination为目的区域，多个地域用英文逗号分隔。例如：BJ11, ZB
  • 当DestinationType为Domain时，Destination为目的域名。例如：www.baidu.com
DestinationType
String
是

net

访问控制策略中的目的地址类型：

  • net：目的网段(CIDR)
  • group：目的地址簿
  • location：目的区域
  • domain：目的域名
DestPort
String
否

22/22

访问控制策略中的目的端口。格式为单个端口22，端口范围100/200：

  • 当协议类型为ICMP/ALL时，取值为空
  • 当DestPortType为group时，取值为端口地址簿的uuid列表，多个地址簿通过英文逗号分隔
  • 当DestPortType为port时，取值为端口范围
DestPortType
String
否

port

访问控制策略的目的端口类型：

  • port：端口
  • group：端口地址簿
Proto
String
是

TCP

访问控制策略中的协议类型。当DestinationType为domain时，Proto只能是TCP：

  • ICMP
  • TCP
  • UDP
  • ANY：(任何协议)
Action
String
是

accept

访问控制策略的动作：

  • accept：放行
  • deny：阻断
  • monitor：观察
Status
Boolean
否

false

访问控制策略的开关状态。默认为false，不开启

  • true：开启
  • false：关闭
Description
String
否

测试

访问控制策略的描述信息

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
RuleId
String

f04ac7ce-628b-4cb7-be61-310222b7****

添加成功后返回访问控制策略的唯一标识

请求示例

POST /AddControlPolicy HTTP/1.1

{
  "Prio": 0,
  "Direction": "in",
  "SourceType": "net",
  "Source": "192.168.1.1/32",
  "DestinationType": "net",
  "Destination": "192.168.2.1/32",
  "DestPortType": "port",
  "DestPort": "22",
  "Proto": "TCP",
  "Action": "accept",
  "Description": "test"
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "202310091645264C*****",
        "Service": "",
        "Region": "",
        "Action": "AddControlPolicy",
        "Version": "2021-09-06"
    },
    "Result": {
        "RuleId": "12ce4594-c328-*****"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
QueryDbFailed
Query configuration failed

查询数据库失败

400
UpdateDbFailed
Update configuration failed

更新配置错误

400
BadRequest
The http request is bad due to some reason: %s.

由于某些原因，http请求不正确

400
MissingParameter
The required parameter %s is missing.

缺少所需的参数

400
InvalidParameter.Source
The Source parameter is invalid.

Source参数无效

400
InvalidParameter.Destination
The Destination parameter is invalid.

Destination参数无效

400
InvalidParameter.SourceType
The SourceType parameter is invalid.

SourceType参数无效

400
InvalidParameter.DestinationType
The DestinationType parameter is invalid.

DestinationType参数无效

400
NotFound.AddressBook
The specified AddressBook does not exist.

指定地址簿不存在

400
InvalidParameter.Proto
The Proto parameter is invalid.

Proto参数无效

400
InvalidParameter.DestinationGroupType
The DestinationGroupType parameter is invalid.

DestinationGroupType参数无效

400
InvalidParameter.Direction
The Direction parameter is invalid.

Direction参数无效

400
InvalidParameter.DestPortType
The DestPortType parameter is invalid.

DestPortType参数无效

400
InvalidParameter.DestPort
The DestPort parameter is invalid.

DestPort参数无效

400
NotMatch.AddressBookType
The specified Address Book type not match.

指定地址簿类型不匹配

400
Exceed.AclExtendCount
【当前访问控制策略条数已达当前版本规格上限，为保证可以添加更多策略，请对当前版本进行升级，去购买】去购买跳转至升级页面

【当前访问控制策略条数已达当前版本规格上限，为保证可以添加更多策略，请对当前版本进行升级，去购买】去购买跳转至升级页面

500
InternalError
Internal service error. %s

内部服务错误