You need to enable JavaScript to run this app.
导航
UpdWebDefCcRule-更新 CC 防护规则
最近更新时间:2024.07.19 19:17:48首次发布时间:2024.07.19 19:17:48

更新 CC 防护规则,支持修改创建 CC 规则时传入的所有参数,包括规则名称、请求路径等。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com/?Action=UpdWebDefCcRule&Version=2023-03-08

调试

请求参数

Query

参数类型是否必选示例值描述
ActionStringUpdWebDefCcRule接口名称。当前 API 的名称为 UpdWebDefCcRule
VersionString2023-03-08接口版本。当前 API 的版本为 2023-03-08

Body

参数类型是否必选示例值描述
AccurateGroupObject of WafV3Accurate--高级条件配置,未开启高级条件时无需配置此字段。

CCType

Integer

7

规则执行动作。

  • 0:仅告警,放行满足条件的请求,但会将对应请求行为计入攻击日志。
  • 1:限速,拦截超出阈值的请求,被拦截的请求将不会转发回源站。
  • 2:拦截,拦截满足条件的请求,被拦截的请求将不会转发回源站。
  • 7:人机验证,对满足条件的请求执行人机验证,验证通过则放行,否则拦截。
CountTimeInteger60统计时长,单位:秒。
DdosIdInteger70规则 ID,可调用DescWebDefCcRule接口获取。

EffectTime

Integer

60

生效时长,单位:秒。

说明

执行动作为"仅告警"时无需填写。

Enable

Integer

1

是否启用规则。

  • 0:关闭
  • 1:启用
FieldStringHEADER:User-Agent统计对象,格式为类型:对应值
HostStringwww.test.com防护域名。
NameStringtest规则名称。
PathThresholdInteger100请求路径访问的总次数阈值。

PrefixSwitch

Integer

0

是否开启前缀匹配。

  • 0:关闭
  • 1:开启
RulePriorityInteger0规则执行优先级,数字越大优先级越低。
SingleThresholdInteger10每个统计对象访问的次数阈值。
UrlString/cctest请求路径。

WafV3Accurate

参数类型是否必选示例值描述
IdInteger56697规则组ID

Logic

Integer

1

规则组中高级条件运算关系。

  • 1:与
  • 2:或
AccurateRulesArray of WafAccurateRuleItem--规则组的请求特征信息
AccurateGroupPriorityInteger1073741824规则创建完成后,自动生成的规则组优先级

WafAccurateRuleItem

参数类型是否必选示例值描述

HttpObj

String

request.method

自定义对象,与ObjType存在映射关系。

  • 请求协议:request.schema
  • 请求 uri:request.uri
  • 请求方法:request.method
  • 请求路径:request.path
  • 请求参数:request.queryargs
  • 请求头:request.header
  • 请求 User-Agent:request.header.ua
  • 请求 refer:request.header.refer
  • 请求 Cookies:request.header.cookies
  • 请求体长度:request.header.content-length
  • 请求体格式:request.header.content-type
  • X-forwarded-for:request.header.x-forwarded-for
  • 客户端 IP:request.header.clientip
  • 自定义 Args:request.queryargs.自定义参数名称。例如request.queryargs.abc
  • 自定义 header:request.header.自定义Header 名称。例如request.header.abc
  • 自定义 cookie:request.cookie.自定义 cookie 名称。例如request.cookie.abc

ObjType

Integer

2

匹配字段。

  • 0:请求协议
  • 1:请求 uri
  • 2:请求方法
  • 3:请求路径
  • 4:请求参数
  • 5:请求头
  • 6:请求 User-Agent
  • 7:请求 refer
  • 8:请求 Cookies
  • 9:请求体长度
  • 10:请求体格式
  • 11:X-forwarded-for
  • 12:客户端 IP
  • 13:自定义 Args
  • 14:自定义 header
  • 15:自定义 cookie

Opretar

Integer

2

逻辑运算符。

  • 0:大于
  • 1:大于等于
  • 2:等于
  • 3:小于
  • 4:小于等于
  • 5:不等于
  • 6:包含子串
  • 7:不包含子串
  • 8:包含前缀
  • 9:不包含前缀
  • 10:包含后缀
  • 11:不包含后缀
  • 12:包含所有匹配集合
  • 13:不包含所有匹配集合
  • 14:属于匹配集合
  • 15:不属于匹配集合
  • 16:正则
  • 17:判断为 IP
  • 18:判断为 IPv4
  • 19:判断为 IPv6
  • 20:判断为私网 IP
  • 21:判断为公网 IP
PropertyInteger0固定取值为 0,取 HttpObj 的值用于匹配对应详情。

ValueString

String

GET

匹配内容。

说明

逻辑关系判断为 IP、 IPv4、 IPv6、私网 IP 或公网 IP 时不需要填写。

返回参数

无。

请求示例

POST https://open.volcengineapi.com/?Action=UpdWebDefCcRule&Version=2023-03-08
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240610T082509Z
X-content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240610/cn-beijing/AdvDefence/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
    "AccurateGroup": {
        "Id": 56697,
        "Logic": 1,
        "AccurateRules": [
            {
                "HttpObj": "request.method",
                "ObjType": 2,
                "Opretar": 2,
                "Property": 0,
                "ValueString": "GET"
            }
        ],
        "AccurateGroupPriority": 1073741824
    },
    "CCType": 7,
    "CountTime": 60,
    "DdosId": 70,
    "EffectTime": 60,
    "Enable": 1,
    "Field": "HEADER:User-Agent",
    "Host": "www.test.com",
    "Name": "test",
    "PathThreshold": 100,
    "PrefixSwitch": 0,
    "RulePriority": 0,
    "SingleThreshold": 10,
    "Url": "/cctest"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdWebDefCcRule",
        "Version": "2023-03-08",
        "Service": "AdvDefence",
        "Region": "cn-beijing"
    }
}