全部产品
Search

搜索本产品

    云防火墙：AddControlPolicy - 添加访问控制策略

    文档中心

    云防火墙：AddControlPolicy - 添加访问控制策略

    更新时间：Nov 20, 2024

    添加访问控制策略。

    接口说明

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

    QPS 限制

    本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    SourceIpdeprecatedstring否

    访问者源 IP 地址。

    		192.0.XX.XX
    Langstring否

    请求和接收消息的语言类型。取值：

    • zh（默认）：中文
    • en：英文
    		zh
    AclActionstring是

    访问控制策略中设置的流量通过云防火墙的方式。取值：

    • accept：放行
    • drop：拒绝
    • log：观察
    		accept
    ApplicationNamestring否

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

    • FTP
    • HTTP
    • HTTPS
    • Memcache
    • MongoDB
    • MQTT
    • MySQL
    • RDP
    • Redis
    • SMTP
    • SMTPS
    • SSH
    • SSL_No_Cert
    • SSL
    • VNC
    • ANY（表示所有类型的应用）
    说明 支持的应用类型取值与协议类型（Proto）取值存在依赖关系。Proto 为 TCP 协议时，ApplicationName 支持选择以上所有应用类型中的任意一种；Proto 为 UDP、ICMP 或 ANY 协议类型时，ApplicationName 仅支持选择 ANY。ApplicationNameList 和 ApplicationName 二选一，必须传其中一个，不能同时为空。
    		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"]

    说明 当 Destination 为目的区域时，更多信息，请参见 地区编号。
    		192.0.XX.XX/24
    DestinationTypestring是

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

    • net：目的网段（CIDR 地址）
    • group：目的地址簿
    • domain：目的域名
    • location：目的区域
    		net
    Directionstring是

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

    • in：外对内流量访问控制
    • out：内对外流量访问控制
    		in
    Protostring是

    访问控制策略中流量访问的协议类型。取值：

    • ANY（任何协议）
    • TCP
    • UDP
    • ICMP
    说明 流量方向为出向时，访问的目的地址为域名类型的威胁情报地址簿或云服务地址簿时，只允许配置 TCP 协议，应用可选 HTTP/HTTPS/SMTP/SMTPS/SSL 五种。
    		ANY
    Sourcestring是

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

    • 当 SourceType 为 net 时，Source 为源 CIDR 地址。

      例如：1.1.XX.XX/24

    • 当 SourceType 为 group 时，Source 为源地址簿名称。

      例如：db_group

    • 当 SourceType 为 location 时，Source 为源区域。

      例如["BJ11", "ZB"]

    说明 当 Source 为源区域时，更多信息，请参见 地区编号。
    		192.0.XX.XX/24
    SourceTypestring是

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

    • net：源网段（CIDR）
    • group：源地址簿
    • location：源区域
    		net
    NewOrderstring是

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

    		1
    DestPortTypestring否

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

    取值：

    • port：端口
    • group：端口地址簿
    		port
    DestPortGroupstring否

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

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

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

    • true：启用访问控制策略

    • false：不启用访问控制策略

    		true
    IpVersionstring否

    支持的 IP 地址版本。

    取值：

    • 4：表示 IPv4 地址

    • 6：表示 IPv6 地址

    		6
    ApplicationNameListarray否

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

    string否

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

    • FTP
    • HTTP
    • HTTPS
    • Memcache
    • MongoDB
    • MQTT
    • MySQL
    • RDP
    • Redis
    • SMTP
    • SMTPS
    • SSH
    • SSL_No_Cert
    • SSL
    • VNC
    • ANY（表示所有类型的应用）
    说明 支持的应用类型取值与协议类型（Proto）取值存在依赖关系。Proto 为 TCP 协议时，ApplicationNameList 支持选择以上所有应用类型，使用["HTTP","HTTPS",……]格式表示；Proto 为 UDP、ICMP 或 ANY 协议类型时，ApplicationNameList 仅支持选择 ANY。ApplicationNameList 和 ApplicationName 二选一，必须传其中一个，不能同时为空。当 ApplicationNameList 和 ApplicationName 同时传值时，以 ApplicationNameList 为准。
    		["ANY"]
    RepeatTypestring否

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

    • Permanent（默认）：总是
    • None：指定单次时间
    • Daily：每天
    • Weekly：每周
    • Monthly：每月
    		Permanent
    RepeatDaysarray否

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

    • 当 RepeatType 为Permanent、None、Daily时，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
    DomainResolveTypestring否

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

    • FQDN：基于 FQDN
    • DNS：基于 DNS 动态解析
    • FQDN_AND_DNS：基于 FQDN 与 DNS 动态解析
    		FQDN

    返回参数

    名称类型描述示例值
    object
    AclUuidstring

    互联网边界防火墙访问控制策略的唯一标识 ID。

    		00281255-d220-4db1-8f4f-c4df221ad84c
    RequestIdstring

    返回结果的请求 ID。

    		CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D

    示例

    正常返回示例

    JSON格式

    {
  "AclUuid": "00281255-d220-4db1-8f4f-c4df221ad84c",
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D"
}

    错误码

    HTTP status code错误码错误信息描述
    400ErrorAddressCountExceedThe maximum number of addresses is exceeded.地址簿内地址数量超出上限
    400ErrorParametersSourceThe source is invalid.无效的来源
    400ErrorDomainResolveAn error occurred while resolving the domain.域名解析错误
    400ErrorParametersDirectionThe direction is invalid.无效的方向
    400ErrorDBSelectAn error occurred while querying database.内部错误：数据库查询错误
    400ErrorParameterIpVersionThe IP version is invalid.IP版本参数错误
    400ErrorParametersDestinationThe Destination parameter is invalid.Destination参数非法
    400ErrorParametersProtoThe protocol is invalid.无效的协议
    400ErrorParametersDestPortThe dst_port is invalid.无效的目的端口
    400ErrorParametersActionThe action is invalid.无效的动作
    400ErrorParametersUidThe aliUid parameter is invalid.aliUid 不合法
    400ErrorParametersAppIdThe AppId parameter is incorrect.AppId不正确
    400ErrorAclDomainAnyCountExceedThe 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支持更多配置
    400ErrorParametersGroupPortThe group port is invalid.地址簿端口错误
    400ErrorParametersFtpNotSupportdomain destination not support ftp.策略目的为域名时不支持FTP应用
    400ErrorAclExtendedCountExceedACL or extended ACL rules are not matched.ACL或扩展ACL规格超出限制
    400ErrorParametersDestinationCountExceeding the number of countries in a single ACL.超出一条ACL选取区域个数, 建议拆分成多条ACL
    400ErrorSrcMandSource is mandatory for this action.此操作需要提供指定的 source。

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

    变更历史

    变更时间变更内容概要操作
    2024-08-22OpenAPI 错误码发生变更查看变更详情
    2024-07-30OpenAPI 错误码发生变更查看变更详情
    2024-07-25OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
    2023-10-12OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情