首页 DDoS防护 DDoS高防 开发参考 API参考 API目录 网站业务防护策略 ConfigWebCCRuleV2 - 创建或编辑网站业务频率控制防护(CC防护)的自定义规则

ConfigWebCCRuleV2 - 创建或编辑网站业务频率控制防护(CC防护)的自定义规则

更新时间: 2024-10-23 19:08:53

创建或编辑网站业务频率控制防护(CC防护)的自定义规则。

调试

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

授权信息

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

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

请求参数

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

网站业务的域名。

说明 域名必须已配置网站业务转发规则。您可以调用 DescribeDomains 查询所有域名。
www.example.com
RuleListstring

频率控制规则的配置,使用 JSON 格式的字符串表述,具体结构如下。

  • action:String 类型,必选,匹配动作。取值:

    • block:封禁
    • challenge:挑战
    • watch:观察
  • name:String 类型,必选,规则名称。

  • condition:Map 类型,必选,匹配条件。具体结构如下。

    说明 如果设置了多个匹配条件,则多个条件间是且的关系。
    • field:String 类型,必选,匹配字段。

    • match_method:String 类型,必选,匹配方法。

      说明 关于 fieldmatch_method的取值,请参见请求参数表下的补充描述。
    • header_name:String 类型,可选,自定义 HTTP 头部字段名称。

      说明 仅在 fieldheader 时有效。
    • content:String 类型,必选,匹配内容。

  • ratelimit:String 类型,可选,频率控制字段,可以按照 IP 或者自定义 Header 进行频率统计。具体结构如下。

    • interval:Integer 类型,必选,统计时长(秒)。
    • ttl:Integer 类型,必选,处置时长(秒)。
    • threshold:Integer 类型,必选,阈值(次)。
    • subkey:String 类型,可选,字段名称(仅当统计源为 header 时设置)。
    • target:String 类型,必选,统计源,支持 ip 和 header。
  • status_code:String 类型,可选,频率控制字段,可以根据状态码出现数量或频率进行统计。具体结构如下。

    • enabled:Boolean 类型,必选,是否开启状态码统计。
    • code:Integer 类型,必选,状态码,值范围 100~599
    • use_ratio:Boolean 类型,必选,为 true 时使用比率。
    • ratio_threshold:Integer 类型,可选,状态码出现比率,使用比率时,仅在对应状态码达到 ratio_threshold 时触发处置动作,值范围 1~100
    • count_threshold:Integer 类型,可选,状态码出现数量,不使用比率时,仅在对应状态码达到 count_threshold 时触发处置动作,值范围 2~50000
  • statistics:String 类型,可选,去重统计,可缺省(缺省为不去重统计)。具体结构如下。

    • mode:String 类型,必选,是否开启状态码统计。取值:
      • count:不去重统计
      • distinct:去重统计
    • field:String 类型,必选,统计源,去重统计,仅支持 ip、header 和 uri。
    • header_name:String 类型,可选,字段名称,仅当统计源为 header 时设置。
[{"action":"block","name":"trdsss","statistics":{"mode":"count","field":"header","header_name":"hahah"},"ratelimit":{"interval":60,"ttl":300,"threshold":70,"target":"ip"},"status_code":{"enabled":true,"code":404,"use_ratio":true,"ratio_threshold":80,"count_threshold":2},"condition":[{"field":"ip","match_method":"belong","content":"1.1.1.1"}]}]
Expireslong

规则有效期。单位:秒。

说明 规则的匹配动作为封禁时(action 为 block)生效,在规则有效期内阻断访问请求。不传入该参数表示永久生效。
600

field 和 match_method 的取值及对应关系

匹配字段(field)描述适用的逻辑符(match_method)
ip访问请求的来源 IP。belong :属于
nbelong :不属于
uri访问请求的 URI 地址。contain :包含
ncontain :不包含
equal :等于
nequal :不等于
lless :长度小于
lequal :长度等于
lgreat :长度大于
prefix :前缀匹配
referer访问请求的来源网址,即该访问请求是从哪个页面跳转产生的。contain :包含
ncontain :不包含
equal :等于
nequal :不等于
lless :长度小于
lequal :长度等于
lgreat :长度大于
nexist :不存在
user-agent发起访问请求的客户端的浏览器标识、渲染引擎标识和版本信息等浏览器相关信息。contain :包含
ncontain :不包含
equal :等于
nequal :不等于
lless :长度小于
lequal :长度等于
lgreat :长度大于
params访问请求的 URL 地址中的参数部分,通常指 URL 中”?”后面的部分。例如,demo.aliyundoc.com/index.html?action=login中的action=login就是参数部分。contain :包含
ncontain :不包含
equal :等于
nequal :不等于
lless :长度小于
lequal :长度等于
lgreat :长度大于
cookie访问请求中的 Cookie 信息。contain :包含
ncontain :不包含
equal :等于
nequal :不等于
lless :长度小于
lequal :长度等于
lgreat :长度大于
nexist :不存在
content-type访问请求指定的响应 HTTP 内容类型,即 MIME 类型信息。contain :包含
ncontain :不包含
equal :等于
nequal :不等于
lless :长度小于
lequal :长度等于
lgreat :长度大于
x-forwarded-for访问请求的客户端真实 IP。X-Forwarded-For(XFF)用来识别通过 HTTP 代理或负载均衡方式转发的访问请求的客户端最原始的 IP 地址的 HTTP 请求头字段,只有通过 HTTP 代理或者负载均衡服务器转发的访问请求才会包含该项。contain :包含
ncontain :不包含
equal :等于
nequal :不等于
lless :长度小于
lequal :长度等于
lgreat :长度大于
nexist :不存在
content-length访问请求的所包含的字节数。vless :值小于
vequal :值等于
vgreat :值大于
post-body访问请求的内容信息。contain :包含
ncontain :不包含
equal :等于
nequal :不等于
http-method访问请求的方法,如 GET、POST 等。equal :等于
nequal :不等于
header访问请求的头部信息,用于自定义 HTTP 头部字段。contain :包含
ncontain :不包含
equal :等于
nequal :不等于
lless :长度小于
lequal :长度等于
lgreat :长度大于
nexist :不存在

返回参数

名称类型描述示例值
object
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc

示例

正常返回示例

JSON格式

{
  "RequestId": "0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc"
}

错误码

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

上一篇: DescribeWebCCRulesV2 - 查询网站业务频率控制防护(CC防护)的自定义规则 下一篇: ModifyWebCCGlobalSwitch - 设置网站业务CC安全防护模块的开关状态
阿里云首页 DDoS防护 相关技术圈