CreateBotAnalyseProtectRule - 创建 bot 统计防护规则--Web应用防火墙-火山引擎

文档中心

立即注册

导航

CreateBotAnalyseProtectRule - 创建 bot 统计防护规则

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

在指定域名下创建一条 bot 统计防护规则，用于防护恶意 bot。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必填	示例值	描述
StatisticalType	Integer	是	1	统计内容方式 1：访问频率 2：重复次数 3：重复占比
StatisticalDuration	Integer	是	10	统计时长。
SingleThreshold	Integer	是	100	相同统计对象的 IP 最大个数，StatisticalType=2 （即统计内容方式为重复次数时）启用。
SingleProportion	String	否	0.25	相同统计对象的 IP 占比，StatisticalType=3 （即统计内容方式为重复占比时）启用。
RulePriority	Integer	是	0	规则执行优先级。
PathThreshold	Integer	否	1000	路径访问次数阈值，StatisticalType=1 （即统计内容方式为访问频率时）启用。
Path	String	是	/path/*	请求路径，支持通配符``，``仅可出现一次。
Name	String	是	name	规则名称。
Host	String	是	test.com	需要设置防护规则的网站域名。
Field	String	是	HEADER:User-Agent	统计对象，多个对象用逗号分隔。格式为`类型:对应值`。自定义 Header。格式为`HEADER:具体参数`，例如`HEADER:Authorization` 自定义 Cookie。格式为`COOKIE:具体参数`，例如`COOKIE:PHPSESSId`。自定义参数。格式为`ARGS:具体参数`，例如`ARGS:device_Id`。源 IP。直接配置为`CLIENTIP`。
ExemptionTime	Integer	否	60	豁免时间，当执行动作为人机挑战/JS/工作量证明时生效。
Enable	Integer	是	1	是否启用规则。 0：不启用 1：启用
EffectTime	Integer	是	50	限制时长，单位：秒。取值范围 1～86,400。
ActionType	Integer	是	6	执行动作。 0：告警 1：限速 2：拦截 7：人机验证 8：JS 挑战 9：工作量证明 10：动态令牌 11：丢弃
ActionAfterVerification	Integer	否	1	验证/挑战后执行动作。 1：拦截 2：观察
AccurateGroup	Array of AccurateStruct	否	--	高级条件详情。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Id	Integer	12345	规则 ID 的后五位。

请求示例

POST /?Action=CreateBotAnalyseProtectRule&Version=2023-12-25 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240603T093620Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240603/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
        }
      ]
    }
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240603164046149240182021A3****",
    "Version": "2023-12-25",
    "Service": "waf",
    "Region": "cn-beijing"
  },
  "Result": {
    "Id": 12345
  }
}

错误码

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