文档

CreateNatFirewallControlPolicy - 添加NAT防火墙访问控制策略

更新时间:

添加NAT防火墙访问控制策略。

接口说明

使用本接口创建一条对经过 NAT 防火墙流量放行、拒绝或观察的策略。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-cloudfirewall:CreateNatFirewallControlPolicyWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Langstring

接收消息的语言类型。

取值:

  • zh:(默认)中文
  • en:英文
zh
AclActionstring

安全访问控制策略中访问流量通过云防火墙的方式(动作)。

取值:

  • accept:放行
  • drop:拒绝
  • log:观察
log
ApplicationNameListarray

访问控制策略支持的应用类型列表。

string

访问控制策略支持的应用类型。

ANY
Descriptionstring

访问控制策略的描述信息。

放行流量
DestPortstring

访问控制策略中流量访问的目的端口。取值:

  • 当协议类型为 ICMP 时,DestPort 取值为空。
说明 协议类型为 ICMP 时,不支持对目的端口进行访问控制。
  • 当协议类型为 TCP、UDP 或 ANY 时,并且目的端口类型(DestPortType)为 group 时,DestPort 取值为空。
说明 访问控制策略目的端口类型选择 group(目的端口地址簿)时,您无需设置具体的目的端口号。需要该访问控制策略管控的所有端口会包含在目的端口地址簿中。
  • 当协议类型为 TCP、UDP 或 ANY 时,并且目的端口类型(DestPortType)为 port 时,DestPort 取值为目的端口号。
80
Destinationstring

访问控制策略中的目的地址段。

取值:

  • 当 DestinationType 为 net 时,Destination 为目的 CIDR。

    例如:1.2.XX.XX/24

  • 当 DestinationType 为 group 时,Destination 为目的地址簿名称。

    例如:db_group

  • 当 DestinationType 为 domain 时,Destination 为目的域名。

    例如:*.aliyuncs.com

  • 当 DestinationType 为 location 时,Destination 为目的区域。

    例如: ["BJ11", "ZB"]

XX.XX.XX.XX/24
DestinationTypestring

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

取值:

  • net:目的网段(CIDR 地址)
  • group:目的地址簿
  • domain:目的域名
net
NatGatewayIdstring

NAT 网关的实例 ID。

ngx-xxxxxxx
Protostring

访问控制策略中流量访问的安全协议类型。

取值:

  • ANY(表示查询所有协议类型)
  • TCP
  • UDP
  • ICMP
ANY
Sourcestring

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

取值:

  • SourceTypenet时,Source 为源 CIDR 地址。

    例如:10.2.4.0/24

  • SourceTypegroup时,Source 为源地址簿名称。

    例如:db_group

192.168.0.25/32
SourceTypestring

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

取值:

  • net:源网段(CIDR 地址)
  • group:源地址簿
net
NewOrderstring

访问控制策略生效的优先级。优先级数字从 1 开始顺序递增,优先级数字越小,优先级越高。

1
DestPortTypestring

安全访问控制策略中访问流量的目的端口类型。

  • port:端口
  • group:端口地址簿
port
DestPortGroupstring

访问控制策略中访问流量的目的端口地址簿名称。

说明 DestPortType 设置为 group 时,您需要设置目的端口地址簿名称。
my_port_group
Releasestring

访问控制策略的启用状态。策略创建后默认启用该策略。取值:

  • true:启用访问控制策略
  • false:不启用访问控制策略
true
DomainResolveTypeinteger

访问控制策略的域名解析方式。取值:

  • 0:基于 FQDN
  • 1:基于 DNS 动态解析
  • 2:基于 FQDN 与 DNS 动态解析
0
IpVersionstring

支持的 IP 地址版本。取值:

  • 4(默认):代表 IPv4 地址
4
Directionstring

访问控制策略的流量方向。取值:

  • out:内对外流量访问控制
out
RepeatTypestring

访问控制策略的策略有效期的重复类型。取值:

  • Permanent(默认):总是
  • None:指定单次时间
  • Daily:每天
  • Weekly:每周
  • Monthly:每月
Permanent
RepeatDaysarray

访问控制策略的策略有效期的重复日期集合。

  • 当 RepeatType 为PermanentNoneDaily时,RepeatDays 为空集合。 例如:[]
  • 当 RepeatType 为 Weekly 时,RepeatDays 不能为空。 例如:[0, 6]
说明 RepeatType 设置为 Weekly 时,RepeatDays 不允许重复。
  • 当 RepeatType 为Monthly时,RepeatDays 不能为空。 例如:[1, 31]
说明 RepeatType 设置为 Monthly 时,RepeatDays 不允许重复。
long

访问控制策略的策略有效期的重复日期。

说明 RepeatType 设置为 Weekly 时,取值范围:0~6,每周开始于周日。 RepeatType 设置为 Monthly 时,取值范围:1~31。
1
RepeatStartTimestring

访问控制策略的策略有效期的重复开始时间。例如:08:00,必须为整点或半点时间,且小于重复结束时间至少半小时。

说明 当 RepeatType 为 Permanent、None 时,RepeatStartTime 为空。当 RepeatType 为 Daily、Weekly、Monthly 时,RepeatStartTime 必须有值,您需要设置重复开始时间。
08:00
RepeatEndTimestring

访问控制策略的策略有效期的重复结束时间。例如:23:30,必须为整点或半点时间,且大于重复开始时间至少半小时。

说明 当 RepeatType 为 Permanent、None 时,RepeatEndTime 为空。当 RepeatType 为 Daily、Weekly、Monthly 时,RepeatEndTime 必须有值,您需要设置重复结束时间。
23:30
StartTimelong

访问控制策略的策略有效期的开始时间。使用秒级时间戳格式表示。必须为整点或半点时间,且小于结束时间至少半小时。

说明 当 RepeatType 为 Permanent 时,StartTime 为空。当 RepeatType 为 None、Daily、Weekly、Monthly 时,StartTime 必须有值,您需要设置开始时间。
1694761200
EndTimelong

访问控制策略的策略有效期的结束时间。使用秒级时间戳格式表示。必须为整点或半点时间,且大于开始时间至少半小时。

说明 当 RepeatType 为 Permanent 时,EndTime 为空。当 RepeatType 为 None、Daily、Weekly、Monthly 时,EndTime 必须有值,您需要设置结束时间。
1694764800

返回参数

名称类型描述示例值
object
AclUuidstring

安全访问控制策略的唯一标识 ID。

说明 修改安全访问控制策略,需要提供该策略的唯一标识 ID,该 ID 可调用 DescribeNatFirewallControlPolicy 接口获取。
6504d2fb-ab36-49c3-92a6-*****
RequestIdstring

返回结果的请求 ID。

0DC783F1-B3A7-578D-8A63-*****

示例

正常返回示例

JSON格式

{
  "AclUuid": "6504d2fb-ab36-49c3-92a6-*****",
  "RequestId": "0DC783F1-B3A7-578D-8A63-*****"
}

错误码

HTTP status code错误码错误信息描述
400ErrorParametersUidThe aliUid parameter is invalid.aliUid 不合法
400ErrorUUIDNewThe UUID is invalid.内部错误:UUID错误
400ErrorParametersSourceThe source is invalid.无效的来源
400ErrorParametersDestinationThe Destination parameter is invalid.Destination参数非法
400ErrorParametersProtoThe protocol is invalid.无效的协议
400ErrorParametersDestPortThe dst_port is invalid.无效的目的端口
400ErrorParametersActionThe action is invalid.无效的动作
400ErrorParametersAppIdThe AppId parameter is incorrect.AppId不正确
400ErrorDBSelectAn error occurred while querying database.内部错误:数据库查询错误
400ErrorParametersA parameter error occurred.参数错误
400ErrorAddressCountExceedThe maximum number of addresses is exceeded.地址簿内地址数量超出上限
400ErrorParametersNewOrderThe newOrder is invalid.无效的newOrder
400ErrorDBInsertAn error occurred while performing an insert operation in the database.内部错误:数据库插入错误
400ErrorDBDeleteAn error occurred while deleting the database.内部错误:数据库删除错误
400ErrorRecordLogAn error occurred while updating the operation log.写日志失败

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

变更历史

变更时间变更内容概要操作
2024-03-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-10-12OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:RepeatType
    新增入参:RepeatDays
    新增入参:RepeatStartTime
    新增入参:RepeatEndTime
    新增入参:StartTime
    新增入参:EndTime
  • 本页导读 (1)
文档反馈