UpdateBotAnalyseProtectRule - 更新 bot 频率限制或统计防护规则--Web应用防火墙-火山引擎

文档中心

立即注册

导航

UpdateBotAnalyseProtectRule - 更新 bot 频率限制或统计防护规则

最近更新时间：2024.10.12 12:01:30首次发布时间：2024.10.12 12:01:30

更新 bot 频率限制和统计防护规则都可以参考此接口，通过规则 ID 和传入不同的统计方式参数修改对应的规则。

注意事项

更新规则前，请调用ListBotAnalyseProtectRulePriorityAvailable接口查询可用的规则优先级，避免冲突。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=UpdateBotAnalyseProtectRule&Version=2023-12-25

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateBotAnalyseProtectRule	要执行的操作，取值：UpdateBotAnalyseProtectRule。
Version	String	是	2023-12-25	API的版本，取值：2023-12-25。

Body

参数	类型	是否必填	示例值	描述
StatisticalDuration	Integer	是	10	统计时长。
StatisticalType	Integer	是	1	统计内容方式。 1：访问频率 2：重复次数 3：重复占比
Host	String	是	test.com	域名。
AccurateGroup	Array of Object	否	--	高级条件。
ActionAfterVerification	Integer	否	1	验证/挑战后执行动作 1：拦截 2：观察
ActionType	Integer	是	6	执行动作。 0：告警 1：限速 2：拦截 7：人机验证 8：JS 挑战 9：工作量证明 10：动态令牌 11：丢弃
EffectTime	Integer	是	50	执行时长。
Enable	Integer	是	1	是否启用规则。 0：不启用 1：启用
ExemptionTime	Integer	否	60	豁免时间，执行动作为人机验证、JS 挑战、工作量证明时需要填写。
Field	String	是	HEADER:User-Agent	统计条件。
Name	String	是	name	规则名称。
Path	String	是	/path	防护路径。
PathThreshold	Integer	否	1000	访问次数阈值，StatisticalType=1 （即统计类型为访问频率）时需要填写。
RulePriority	Integer	是	0	规则执行优先级。
SingleProportion	String	否	0.25	相同统计对象的最大占比，StatisticalType = 3（即统计类型为重复占比）时需要填写。
SingleThreshold	Integer	是	100	相同统计对象的最大值。
Id	Integer	是	16	需要更新的规则 ID，获取方式可参考ListBotAnalyseProtectRule-查询 Bot 统计防护规则。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=UpdateBotAnalyseProtectRule&Version=2023-12-25 HTTP/1.1
Host: volcengineapi-boe-stable.byted.org
Content-Type: application/json; charset=UTF-8
X-Date: 20240529T133443Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240529/cn-beijing/waf/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
    "StatisticalType": 1,
    "StatisticalDuration": 10,
    "SingleThreshold": 100,
    "SingleProportion": "0.25",
    "RulePriority": 0,
    "PathThreshold": 1000,
    "Path": "/path",
    "Name": "name",
    "Host": "test.com",
    "Field": "HEADER:User-Agent",
    "ExemptionTime": 60,
    "Enable": 1,
    "EffectTime": 50,
    "ActionType": 6,
    "ActionAfterVerification": 1,
    "AccurateGroup": [
        {
            "Logic": 1,
            "AccurateRules": [
                {
                    "ValueString": "Get",
                    "Opretar": 2,
                    "ObjType": 2,
                    "HttpObj": "request.schema",
                    "Property": 0
                }
            ]
        }
    ],
    "Id": 16
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202405292135160171271260529A739B",
        "Action": "UpdateBotAnalyseProtectRule",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {}
}

错误码

您可访问公共错误码，获取更多错误码信息。