添加访问控制策略。
接口说明
您可以使用本接口创建一条对经过云防火墙流量放行、拒绝或观察的策略。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
yundun-cloudfirewall:AddControlPolicy |
create |
*ControlPolicy
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
SourceIp
deprecated
|
string |
否 |
访问者源 IP 地址。 |
192.0.XX.XX |
Lang |
string |
否 |
请求和接收消息的语言类型。取值:
|
zh |
AclAction |
string |
是 |
访问控制策略中设置的流量通过云防火墙的方式。取值:
|
accept |
ApplicationName
deprecated
|
string |
否 |
访问控制策略支持的应用类型。取值:
说明
支持的应用类型取值与协议类型(Proto)取值存在依赖关系。Proto 为 TCP 协议时,ApplicationName 支持选择以上所有应用类型中的任意一种;Proto 为 UDP、ICMP 或 ANY 协议类型时,ApplicationName 仅支持选择 ANY。ApplicationNameList 和 ApplicationName 二选一,必须传其中一个,不能同时为空。 |
ANY |
Description |
string |
是 |
访问控制策略的描述信息。 |
放行流量 |
DestPort |
string |
否 |
访问控制策略中流量访问的目的端口。取值:
说明
协议类型为 ICMP 时,不支持对目的端口进行访问控制。
说明
访问控制策略目的端口类型选择 group(目的端口地址簿)时,您无需设置具体的目的端口号。需要该访问控制策略管控的所有端口会包含在目的端口地址簿中。
|
80 |
Destination |
string |
是 |
访问控制策略中的目的地址段。 取值:
说明
当 Destination 为目的区域时,更多信息,请参见 地区编号。 |
192.0.XX.XX/24 |
DestinationType |
string |
是 |
访问控制策略中的目的地址类型。取值:
|
net |
Direction |
string |
是 |
访问控制策略的流量方向。取值:
|
in |
Proto |
string |
是 |
访问控制策略中流量访问的协议类型。取值:
说明
流量方向为出向时,访问的目的地址为域名类型的威胁情报地址簿或云服务地址簿时,只允许配置 TCP 协议,应用可选 HTTP/HTTPS/SMTP/SMTPS/SSL 五种。 |
ANY |
Source |
string |
是 |
访问控制策略中的源地址。取值:
说明
当 Source 为源区域时,更多信息,请参见 地区编号。 |
192.0.XX.XX/24 |
SourceType |
string |
是 |
访问控制策略中的源地址类型。取值:
|
net |
NewOrder |
string |
是 |
访问控制策略生效的优先级。优先级数字从 1 开始顺序递增,优先级数字越小,优先级越高。 |
1 |
DestPortType |
string |
否 |
访问控制策略中流量访问的目的端口类型。 取值:
|
port |
DestPortGroup |
string |
否 |
访问控制策略中访问流量的目的端口地址簿名称。 说明
DestPortType 设置为 group 时,您需要设置目的端口地址簿名称。 |
my_port_group |
Release |
string |
否 |
访问控制策略的启用状态。策略创建后默认启用该策略。取值:
|
true |
IpVersion |
string |
否 |
支持的 IP 地址版本。 取值:
|
6 |
ApplicationNameList |
array |
否 |
访问控制策略支持的应用类型列表。 |
|
string |
否 |
访问控制策略支持的应用类型。取值:
说明
支持的应用类型取值与协议类型(Proto)取值存在依赖关系。Proto 为 TCP 协议时,ApplicationNameList 支持选择以上所有应用类型,使用 |
["ANY"] |
|
RepeatType |
string |
否 |
访问控制策略的策略有效期的重复类型。取值:
|
Permanent |
RepeatDays |
array |
否 |
访问控制策略的策略有效期的重复日期集合。
说明
RepeatType 设置为 Weekly 时,RepeatDays 不允许重复。
说明
RepeatType 设置为 Monthly 时,RepeatDays 不允许重复。 |
|
integer |
否 |
访问控制策略的策略有效期的重复日期。 说明
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 |
integer |
否 |
访问控制策略的策略有效期的开始时间。使用秒级时间戳格式表示。必须为整点或半点时间,且小于结束时间至少半小时。 说明
当 RepeatType 为 Permanent 时,StartTime 为空。当 RepeatType 为 None、Daily、Weekly、Monthly 时,StartTime 必须有值,您需要设置开始时间。 |
1694761200 |
EndTime |
integer |
否 |
访问控制策略的策略有效期的结束时间。使用秒级时间戳格式表示。必须为整点或半点时间,且大于开始时间至少半小时。 说明
当 RepeatType 为 Permanent 时,EndTime 为空。当 RepeatType 为 None、Daily、Weekly、Monthly 时,EndTime 必须有值,您需要设置结束时间。 |
1694764800 |
DomainResolveType |
string |
否 |
访问控制策略的域名解析方式。取值:
|
FQDN |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
AclUuid |
string |
互联网边界防火墙访问控制策略的唯一标识 ID。 |
00281255-d220-4db1-8f4f-c4df221ad84c |
RequestId |
string |
返回结果的请求 ID。 |
CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D |
示例
正常返回示例
JSON
格式
{
"AclUuid": "00281255-d220-4db1-8f4f-c4df221ad84c",
"RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D"
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | ErrorAddressCountExceed | The maximum number of addresses is exceeded. | 地址簿内地址数量超出上限 |
400 | ErrorParametersSource | The source is invalid. | 无效的来源 |
400 | ErrorDomainResolve | An error occurred while resolving the domain. | 域名解析错误 |
400 | ErrorParametersDirection | The direction is invalid. | 无效的方向 |
400 | ErrorDBSelect | An error occurred while querying database. | 内部错误:数据库查询错误 |
400 | ErrorParameterIpVersion | The IP version is invalid. | IP版本参数错误 |
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 | ErrorParametersUid | The aliUid parameter is invalid. | aliUid 不合法 |
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 | ErrorParametersGroupPort | The group port is invalid. | 地址簿端口错误 |
400 | ErrorParametersFtpNotSupport | domain destination not support ftp. | 策略目的为域名时不支持FTP应用 |
400 | ErrorAclExtendedCountExceed | ACL or extended ACL rules are not matched. | ACL或扩展ACL规格超出限制 |
400 | ErrorParametersDestinationCount | Exceeding the number of countries in a single ACL. | 超出一条ACL选取区域个数, 建议拆分成多条ACL |
400 | ErrorSrcMand | Source is mandatory for this action. | 此操作需要提供指定的 source。 |
400 | ErrorEmptyDomainResolveType | Empty DomainResolveType only support HTTP/HTTPS/SSL/SMTP/SMTPS apps. | 不支持空的域名解析模式。 |
400 | ErrorAddressGroupNotExist | The address group does not exist. | 地址簿不存在 |
400 | ErrorParametersApplicationNameList | Specified parameter ApplicationNameList is not valid. | 访问控制策略支持的应用类型列表不合法。 |
400 | ErrorParametersApplicationName | Specified parameter ApplicationName is not valid. | 访问控制策略支持的应用类型不合法。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。