添加NAT防火墙访问控制策略。
接口说明
使用本接口创建一条对经过 NAT 防火墙流量放行、拒绝或观察的策略。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-cloudfirewall:CreateNatFirewallControlPolicy | create | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Lang | string | 否 | 接收消息的语言类型。 取值:
| zh |
AclAction | string | 是 | 安全访问控制策略中访问流量通过云防火墙的方式(动作)。 取值:
| log |
ApplicationNameList | array | 是 | 访问控制策略支持的应用类型列表。 | |
string | 是 | 访问控制策略支持的应用类型。 | ANY | |
Description | string | 是 | 访问控制策略的描述信息。 | 放行流量 |
DestPort | string | 否 | 访问控制策略中流量访问的目的端口。取值:
说明
协议类型为 ICMP 时,不支持对目的端口进行访问控制。
说明
访问控制策略目的端口类型选择 group(目的端口地址簿)时,您无需设置具体的目的端口号。需要该访问控制策略管控的所有端口会包含在目的端口地址簿中。
| 80 |
Destination | string | 是 | 访问控制策略中的目的地址段。 取值:
| XX.XX.XX.XX/24 |
DestinationType | string | 是 | 访问控制策略中的目的地址类型。 取值:
| net |
NatGatewayId | string | 是 | NAT 网关的实例 ID。 | ngx-xxxxxxx |
Proto | string | 是 | 访问控制策略中流量访问的安全协议类型。 取值:
说明
访问的目的地址为域名类型的威胁情报地址簿或云服务地址簿时,只允许配置 TCP 协议,应用可选 HTTP/HTTPS/SMTP/SMTPS/SSL 五种。
| ANY |
Source | string | 是 | 访问控制策略中的源地址。 取值:
| 192.168.0.25/32 |
SourceType | string | 是 | 访问控制策略中的源地址类型。 取值:
| net |
NewOrder | string | 是 | 访问控制策略生效的优先级。优先级数字从 1 开始顺序递增,优先级数字越小,优先级越高。 | 1 |
DestPortType | string | 否 | 安全访问控制策略中访问流量的目的端口类型。
| port |
DestPortGroup | string | 否 | 访问控制策略中访问流量的目的端口地址簿名称。 说明
DestPortType 设置为 group 时,您需要设置目的端口地址簿名称。
| my_port_group |
Release | string | 否 | 访问控制策略的启用状态。策略创建后默认启用该策略。取值:
| true |
DomainResolveType | integer | 否 | 访问控制策略的域名解析方式。取值:
| 0 |
IpVersion | string | 否 | 支持的 IP 地址版本。取值:
| 4 |
Direction | string | 是 | 访问控制策略的流量方向。取值:
| out |
RepeatType | string | 否 | 访问控制策略的策略有效期的重复类型。取值:
| Permanent |
RepeatDays | array | 否 | 访问控制策略的策略有效期的重复日期集合。
说明
RepeatType 设置为 Weekly 时,RepeatDays 不允许重复。
说明
RepeatType 设置为 Monthly 时,RepeatDays 不允许重复。
| |
long | 否 | 访问控制策略的策略有效期的重复日期。 说明
RepeatType 设置为 Weekly 时,取值范围:0~6,每周开始于周日。
RepeatType 设置为 Monthly 时,取值范围:1~31。
| 1 | |
RepeatStartTime | string | 否 | 访问控制策略的策略有效期的重复开始时间。例如:08:00,必须为整点或半点时间,且小于重复结束时间至少半小时。 说明
当 RepeatType 为 Permanent、None 时,RepeatStartTime 为空。当 RepeatType 为 Daily、Weekly、Monthly 时,RepeatStartTime 必须有值,您需要设置重复开始时间。
| 08:00 |
RepeatEndTime | string | 否 | 访问控制策略的策略有效期的重复结束时间。例如:23:30,必须为整点或半点时间,且大于重复开始时间至少半小时。 说明
当 RepeatType 为 Permanent、None 时,RepeatEndTime 为空。当 RepeatType 为 Daily、Weekly、Monthly 时,RepeatEndTime 必须有值,您需要设置重复结束时间。
| 23:30 |
StartTime | long | 否 | 访问控制策略的策略有效期的开始时间。使用秒级时间戳格式表示。必须为整点或半点时间,且小于结束时间至少半小时。 说明
当 RepeatType 为 Permanent 时,StartTime 为空。当 RepeatType 为 None、Daily、Weekly、Monthly 时,StartTime 必须有值,您需要设置开始时间。
| 1694761200 |
EndTime | long | 否 | 访问控制策略的策略有效期的结束时间。使用秒级时间戳格式表示。必须为整点或半点时间,且大于开始时间至少半小时。 说明
当 RepeatType 为 Permanent 时,EndTime 为空。当 RepeatType 为 None、Daily、Weekly、Monthly 时,EndTime 必须有值,您需要设置结束时间。
| 1694764800 |
返回参数
示例
正常返回示例
JSON
格式
{
"AclUuid": "6504d2fb-ab36-49c3-92a6-*****",
"RequestId": "0DC783F1-B3A7-578D-8A63-*****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ErrorParametersUid | The aliUid parameter is invalid. | aliUid 不合法 |
400 | ErrorUUIDNew | The UUID is invalid. | 内部错误:UUID错误 |
400 | ErrorParametersSource | The source is invalid. | 无效的来源 |
400 | ErrorParametersDestination | The Destination parameter is invalid. | Destination参数非法 |
400 | ErrorParametersProto | The protocol is invalid. | 无效的协议 |
400 | ErrorParametersDestPort | The dst_port is invalid. | 无效的目的端口 |
400 | ErrorParametersAction | The action is invalid. | 无效的动作 |
400 | ErrorParametersAppId | The AppId parameter is incorrect. | AppId不正确 |
400 | ErrorDBSelect | An error occurred while querying database. | 内部错误:数据库查询错误 |
400 | ErrorParameters | A parameter error occurred. | 参数错误 |
400 | ErrorAddressCountExceed | The maximum number of addresses is exceeded. | 地址簿内地址数量超出上限 |
400 | ErrorParametersNewOrder | The newOrder is invalid. | 无效的newOrder |
400 | ErrorDBInsert | An error occurred while performing an insert operation in the database. | 内部错误:数据库插入错误 |
400 | ErrorDBDelete | An error occurred while deleting the database. | 内部错误:数据库删除错误 |
400 | ErrorRecordLog | An error occurred while updating the operation log. | 写日志失败 |
400 | ErrorAclDomainAnyCountExceed | The number of resolved domain names cannot exceed 200. ACL configuration can be continued for HTTP, HTTPS, SMTP, SMTPS, and SSL applications. | 域名解析数量超过200,应用http|https|smtp|smtps|ssl支持更多配置 |
400 | ErrorParametersNatGatewayId | Invalid parameters NatGatewayId. | 请求参数NatGatewayId不合法或不存在。 |
400 | ErrorParameterIpVersion | The IP version is invalid. | IP版本参数错误 |
400 | ErrorParametersDirection | The direction is invalid. | 无效的方向 |
400 | ErrorDomainResolve | An error occurred while resolving the domain. | 域名解析错误 |
400 | ErrorParametersPageSizeOrNo | Either pageSize or pageNo is invalid. | 无效的pageSize或者pageNo |
400 | ErrorMarshalJSON | An error occurred while encoding JSON. | 内部错误:JSON编码错误 |
400 | ErrorParametersDestinationCount | Exceeding the number of countries in a single ACL. | 超出一条ACL选取区域个数, 建议拆分成多条ACL |
400 | ErrorStartTimeOrEndTime | The start time or end time is invalid. The time must be the hour or half hour, and the start time must be 30 minutes earlier than the end time. | 开始时间或结束时间无效。时间必须是小时或半小时,并且开始时间必须比结束时间早30分钟。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-05 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-08-22 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-03-13 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-10-12 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |