published on Thursday, Oct 15, 2026 by Byteplus
published on Thursday, Oct 15, 2026 by Byteplus
WAF Bot statistical protection rule. Applies to Bot frequency limit (StatisticalType=1) and Bot repeat statistics (StatisticalType=2/3) scenarios. Restricts requests based on objects such as request IP, Session, Header, etc.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as bytepluscc from "@byteplus/pulumi-bytepluscc";
const example = new bytepluscc.waf.BotAnalyseProtectRule("example", {
actionType: 1,
enable: 1,
field: "CLIENTIP",
host: "www.testwaf.com",
name: "ccapi-bot-analyse-required",
path: "/ccapi-required",
pathThreshold: 10,
rulePriority: 0,
singleThreshold: 3,
statisticalDuration: 30,
statisticalType: "1",
});
import pulumi
import pulumi_bytepluscc as bytepluscc
example = bytepluscc.waf.BotAnalyseProtectRule("example",
action_type=1,
enable=1,
field="CLIENTIP",
host="www.testwaf.com",
name="ccapi-bot-analyse-required",
path="/ccapi-required",
path_threshold=10,
rule_priority=0,
single_threshold=3,
statistical_duration=30,
statistical_type="1")
package main
import (
"github.com/byteplus-sdk/pulumi-bytepluscc/sdk/go/bytepluscc/waf"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := waf.NewBotAnalyseProtectRule(ctx, "example", &waf.BotAnalyseProtectRuleArgs{
ActionType: pulumi.Int(1),
Enable: pulumi.Int(1),
Field: pulumi.String("CLIENTIP"),
Host: pulumi.String("www.testwaf.com"),
Name: pulumi.String("ccapi-bot-analyse-required"),
Path: pulumi.String("/ccapi-required"),
PathThreshold: pulumi.Int(10),
RulePriority: pulumi.Int(0),
SingleThreshold: pulumi.Int(3),
StatisticalDuration: pulumi.Int(30),
StatisticalType: pulumi.String("1"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Bytepluscc = Byteplus.Pulumi.Bytepluscc;
return await Deployment.RunAsync(() =>
{
var example = new Bytepluscc.Waf.BotAnalyseProtectRule("example", new()
{
ActionType = 1,
Enable = 1,
Field = "CLIENTIP",
Host = "www.testwaf.com",
Name = "ccapi-bot-analyse-required",
Path = "/ccapi-required",
PathThreshold = 10,
RulePriority = 0,
SingleThreshold = 3,
StatisticalDuration = 30,
StatisticalType = "1",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.byteplus.bytepluscc.waf.BotAnalyseProtectRule;
import com.byteplus.bytepluscc.waf.BotAnalyseProtectRuleArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new BotAnalyseProtectRule("example", BotAnalyseProtectRuleArgs.builder()
.actionType(1)
.enable(1)
.field("CLIENTIP")
.host("www.testwaf.com")
.name("ccapi-bot-analyse-required")
.path("/ccapi-required")
.pathThreshold(10)
.rulePriority(0)
.singleThreshold(3)
.statisticalDuration(30)
.statisticalType("1")
.build());
}
}
resources:
example:
type: bytepluscc:waf:BotAnalyseProtectRule
properties:
actionType: 1
enable: 1
field: CLIENTIP
host: www.testwaf.com
name: ccapi-bot-analyse-required
path: /ccapi-required
pathThreshold: 10
rulePriority: 0
singleThreshold: 3
statisticalDuration: 30
statisticalType: '1'
pulumi {
required_providers {
bytepluscc = {
source = "pulumi/bytepluscc"
}
}
}
resource "bytepluscc_waf_botanalyseprotectrule" "example" {
action_type = 1
enable = 1
field = "CLIENTIP"
host = "www.testwaf.com"
name = "ccapi-bot-analyse-required"
path = "/ccapi-required"
path_threshold = 10
rule_priority = 0
single_threshold = 3
statistical_duration = 30
statistical_type = "1"
}
Create BotAnalyseProtectRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new BotAnalyseProtectRule(name: string, args: BotAnalyseProtectRuleArgs, opts?: CustomResourceOptions);@overload
def BotAnalyseProtectRule(resource_name: str,
args: BotAnalyseProtectRuleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def BotAnalyseProtectRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
name: Optional[str] = None,
path: Optional[str] = None,
statistical_type: Optional[str] = None,
statistical_duration: Optional[int] = None,
enable: Optional[int] = None,
rule_priority: Optional[int] = None,
field: Optional[str] = None,
host: Optional[str] = None,
action_type: Optional[int] = None,
exemption_time: Optional[int] = None,
accurate_group: Optional[BotAnalyseProtectRuleAccurateGroupArgs] = None,
project_name: Optional[str] = None,
path_threshold: Optional[int] = None,
single_proportion: Optional[float] = None,
single_threshold: Optional[int] = None,
effect_time: Optional[int] = None,
cron_confs: Optional[Sequence[BotAnalyseProtectRuleCronConfArgs]] = None)func NewBotAnalyseProtectRule(ctx *Context, name string, args BotAnalyseProtectRuleArgs, opts ...ResourceOption) (*BotAnalyseProtectRule, error)public BotAnalyseProtectRule(string name, BotAnalyseProtectRuleArgs args, CustomResourceOptions? opts = null)
public BotAnalyseProtectRule(String name, BotAnalyseProtectRuleArgs args)
public BotAnalyseProtectRule(String name, BotAnalyseProtectRuleArgs args, CustomResourceOptions options)
type: bytepluscc:waf:BotAnalyseProtectRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "bytepluscc_waf_bot_analyse_protect_rule" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args BotAnalyseProtectRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args BotAnalyseProtectRuleArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args BotAnalyseProtectRuleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BotAnalyseProtectRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BotAnalyseProtectRuleArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var botAnalyseProtectRuleResource = new Bytepluscc.Waf.BotAnalyseProtectRule("botAnalyseProtectRuleResource", new()
{
Name = "string",
Path = "string",
StatisticalType = "string",
StatisticalDuration = 0,
Enable = 0,
RulePriority = 0,
Field = "string",
Host = "string",
ActionType = 0,
ExemptionTime = 0,
AccurateGroup = new Bytepluscc.Waf.Inputs.BotAnalyseProtectRuleAccurateGroupArgs
{
AccurateGroupPriority = 0,
AccurateRules = new[]
{
new Bytepluscc.Waf.Inputs.BotAnalyseProtectRuleAccurateGroupAccurateRuleArgs
{
HttpObj = "string",
ObjType = 0,
Opretar = 0,
Property = 0,
ValueString = "string",
},
},
Id = 0,
Logic = 0,
},
ProjectName = "string",
PathThreshold = 0,
SingleProportion = 0.0,
SingleThreshold = 0,
EffectTime = 0,
CronConfs = new[]
{
new Bytepluscc.Waf.Inputs.BotAnalyseProtectRuleCronConfArgs
{
Crontab = "string",
PathThreshold = 0,
SingleThreshold = 0,
},
},
});
example, err := waf.NewBotAnalyseProtectRule(ctx, "botAnalyseProtectRuleResource", &waf.BotAnalyseProtectRuleArgs{
Name: pulumi.String("string"),
Path: pulumi.String("string"),
StatisticalType: pulumi.String("string"),
StatisticalDuration: pulumi.Int(0),
Enable: pulumi.Int(0),
RulePriority: pulumi.Int(0),
Field: pulumi.String("string"),
Host: pulumi.String("string"),
ActionType: pulumi.Int(0),
ExemptionTime: pulumi.Int(0),
AccurateGroup: &waf.BotAnalyseProtectRuleAccurateGroupArgs{
AccurateGroupPriority: pulumi.Int(0),
AccurateRules: waf.BotAnalyseProtectRuleAccurateGroupAccurateRuleArray{
&waf.BotAnalyseProtectRuleAccurateGroupAccurateRuleArgs{
HttpObj: pulumi.String("string"),
ObjType: pulumi.Int(0),
Opretar: pulumi.Int(0),
Property: pulumi.Int(0),
ValueString: pulumi.String("string"),
},
},
Id: pulumi.Int(0),
Logic: pulumi.Int(0),
},
ProjectName: pulumi.String("string"),
PathThreshold: pulumi.Int(0),
SingleProportion: pulumi.Float64(0),
SingleThreshold: pulumi.Int(0),
EffectTime: pulumi.Int(0),
CronConfs: waf.BotAnalyseProtectRuleCronConfArray{
&waf.BotAnalyseProtectRuleCronConfArgs{
Crontab: pulumi.String("string"),
PathThreshold: pulumi.Int(0),
SingleThreshold: pulumi.Int(0),
},
},
})
resource "bytepluscc_waf_bot_analyse_protect_rule" "botAnalyseProtectRuleResource" {
lifecycle {
create_before_destroy = true
}
name = "string"
path = "string"
statistical_type = "string"
statistical_duration = 0
enable = 0
rule_priority = 0
field = "string"
host = "string"
action_type = 0
exemption_time = 0
accurate_group = {
accurate_group_priority = 0
accurate_rules = [{
http_obj = "string"
obj_type = 0
opretar = 0
property = 0
value_string = "string"
}]
id = 0
logic = 0
}
project_name = "string"
path_threshold = 0
single_proportion = 0
single_threshold = 0
effect_time = 0
cron_confs {
crontab = "string"
path_threshold = 0
single_threshold = 0
}
}
var botAnalyseProtectRuleResource = new BotAnalyseProtectRule("botAnalyseProtectRuleResource", BotAnalyseProtectRuleArgs.builder()
.name("string")
.path("string")
.statisticalType("string")
.statisticalDuration(0)
.enable(0)
.rulePriority(0)
.field("string")
.host("string")
.actionType(0)
.exemptionTime(0)
.accurateGroup(BotAnalyseProtectRuleAccurateGroupArgs.builder()
.accurateGroupPriority(0)
.accurateRules(BotAnalyseProtectRuleAccurateGroupAccurateRuleArgs.builder()
.httpObj("string")
.objType(0)
.opretar(0)
.property(0)
.valueString("string")
.build())
.id(0)
.logic(0)
.build())
.projectName("string")
.pathThreshold(0)
.singleProportion(0.0)
.singleThreshold(0)
.effectTime(0)
.cronConfs(BotAnalyseProtectRuleCronConfArgs.builder()
.crontab("string")
.pathThreshold(0)
.singleThreshold(0)
.build())
.build());
bot_analyse_protect_rule_resource = bytepluscc.waf.BotAnalyseProtectRule("botAnalyseProtectRuleResource",
name="string",
path="string",
statistical_type="string",
statistical_duration=0,
enable=0,
rule_priority=0,
field="string",
host="string",
action_type=0,
exemption_time=0,
accurate_group={
"accurate_group_priority": 0,
"accurate_rules": [{
"http_obj": "string",
"obj_type": 0,
"opretar": 0,
"property": 0,
"value_string": "string",
}],
"id": 0,
"logic": 0,
},
project_name="string",
path_threshold=0,
single_proportion=float(0),
single_threshold=0,
effect_time=0,
cron_confs=[{
"crontab": "string",
"path_threshold": 0,
"single_threshold": 0,
}])
const botAnalyseProtectRuleResource = new bytepluscc.waf.BotAnalyseProtectRule("botAnalyseProtectRuleResource", {
name: "string",
path: "string",
statisticalType: "string",
statisticalDuration: 0,
enable: 0,
rulePriority: 0,
field: "string",
host: "string",
actionType: 0,
exemptionTime: 0,
accurateGroup: {
accurateGroupPriority: 0,
accurateRules: [{
httpObj: "string",
objType: 0,
opretar: 0,
property: 0,
valueString: "string",
}],
id: 0,
logic: 0,
},
projectName: "string",
pathThreshold: 0,
singleProportion: 0,
singleThreshold: 0,
effectTime: 0,
cronConfs: [{
crontab: "string",
pathThreshold: 0,
singleThreshold: 0,
}],
});
type: bytepluscc:waf:BotAnalyseProtectRule
properties:
accurateGroup:
accurateGroupPriority: 0
accurateRules:
- httpObj: string
objType: 0
opretar: 0
property: 0
valueString: string
id: 0
logic: 0
actionType: 0
cronConfs:
- crontab: string
pathThreshold: 0
singleThreshold: 0
effectTime: 0
enable: 0
exemptionTime: 0
field: string
host: string
name: string
path: string
pathThreshold: 0
projectName: string
rulePriority: 0
singleProportion: 0
singleThreshold: 0
statisticalDuration: 0
statisticalType: string
BotAnalyseProtectRule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The BotAnalyseProtectRule resource accepts the following input properties:
- Action
Type int - Action to execute. 0: Observe; 1: Rate limit (supported only in frequency limit scenario, i.e., StatisticalType=1); 2: Block; 6: JS challenge; 7: CAPTCHA; 10: Proof of work; 11: Drop.
- Enable int
- Rule switch. 0: Off; 1: On.
- Field string
- Statistical object. Supports single or multiple fields, separated by commas. Maximum of 10 fields. Basic format is DataType:Value, for example HEADER:X-Forwarded-For, CLIENTIP, COOKIE:token, ARGS:device_id, JA3HASH.
- Host string
- Domain name. The website domain to be protected. Make sure the domain has been added to the current WAF instance before calling.
- Name string
- Rule name. Must start with Chinese/letter/number. Allows Chinese/letters/numbers/period (.)/underscore (_)/hyphen (-). Length 1~128 characters.
- Path string
- Request path to which the rule applies. You can specify an exact page path, match the entire site, or all paths under a directory (using wildcard *). The wildcard * can only appear at the end of the path.
- Rule
Priority int - Rule priority under the same path and advanced condition. Range 0~9, with 0 being the highest priority.
- Statistical
Duration int - Statistical time window, in seconds. Frequency limit scenario (StatisticalType=1): 5~1800; repeat statistics scenario (StatisticalType=2/3): 1~60.
- Statistical
Type string - Statistical method. "1": access frequency; "2": repeat count; "3": repeat ratio.
- Accurate
Group Byteplus.Bot Analyse Protect Rule Accurate Group - Advanced condition group. Do not include this field if not enabled or if the list is empty.
- Cron
Confs List<Byteplus.Bot Analyse Protect Rule Cron Conf> - Periodic cycle configuration list. Supported only for frequency limit rules with StatisticalType=1. Threshold switching is specified by crontab. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Effect
Time int - Action effective duration in seconds, range 30~86400. Required when creating or updating rules except for ActionType=1 (rate limiting).
- Exemption
Time int - Exemption time for human verification, JS challenge, or proof of work, in seconds. Range 30~3600. Applies only when ActionType is 6/7/10.
- Path
Threshold int - Overall threshold for the current path. Effective only when StatisticalType=1. Range 1~300000.
- Project
Name string - Project name, which is the project associated with the current resource. Only projects with permissions under the current identity can be associated.
- Single
Proportion double - Ratio threshold for a single statistical object. Enabled only when StatisticalType=3 (repeat ratio). Value range: [0, 1).
- Single
Threshold int - Threshold for the number of times per statistical object. Used only when StatisticalType=1. Range 1~300000.
- Action
Type int - Action to execute. 0: Observe; 1: Rate limit (supported only in frequency limit scenario, i.e., StatisticalType=1); 2: Block; 6: JS challenge; 7: CAPTCHA; 10: Proof of work; 11: Drop.
- Enable int
- Rule switch. 0: Off; 1: On.
- Field string
- Statistical object. Supports single or multiple fields, separated by commas. Maximum of 10 fields. Basic format is DataType:Value, for example HEADER:X-Forwarded-For, CLIENTIP, COOKIE:token, ARGS:device_id, JA3HASH.
- Host string
- Domain name. The website domain to be protected. Make sure the domain has been added to the current WAF instance before calling.
- Name string
- Rule name. Must start with Chinese/letter/number. Allows Chinese/letters/numbers/period (.)/underscore (_)/hyphen (-). Length 1~128 characters.
- Path string
- Request path to which the rule applies. You can specify an exact page path, match the entire site, or all paths under a directory (using wildcard *). The wildcard * can only appear at the end of the path.
- Rule
Priority int - Rule priority under the same path and advanced condition. Range 0~9, with 0 being the highest priority.
- Statistical
Duration int - Statistical time window, in seconds. Frequency limit scenario (StatisticalType=1): 5~1800; repeat statistics scenario (StatisticalType=2/3): 1~60.
- Statistical
Type string - Statistical method. "1": access frequency; "2": repeat count; "3": repeat ratio.
- Accurate
Group BotAnalyse Protect Rule Accurate Group Args - Advanced condition group. Do not include this field if not enabled or if the list is empty.
- Cron
Confs []BotAnalyse Protect Rule Cron Conf Args - Periodic cycle configuration list. Supported only for frequency limit rules with StatisticalType=1. Threshold switching is specified by crontab. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Effect
Time int - Action effective duration in seconds, range 30~86400. Required when creating or updating rules except for ActionType=1 (rate limiting).
- Exemption
Time int - Exemption time for human verification, JS challenge, or proof of work, in seconds. Range 30~3600. Applies only when ActionType is 6/7/10.
- Path
Threshold int - Overall threshold for the current path. Effective only when StatisticalType=1. Range 1~300000.
- Project
Name string - Project name, which is the project associated with the current resource. Only projects with permissions under the current identity can be associated.
- Single
Proportion float64 - Ratio threshold for a single statistical object. Enabled only when StatisticalType=3 (repeat ratio). Value range: [0, 1).
- Single
Threshold int - Threshold for the number of times per statistical object. Used only when StatisticalType=1. Range 1~300000.
- action_
type number - Action to execute. 0: Observe; 1: Rate limit (supported only in frequency limit scenario, i.e., StatisticalType=1); 2: Block; 6: JS challenge; 7: CAPTCHA; 10: Proof of work; 11: Drop.
- enable number
- Rule switch. 0: Off; 1: On.
- field string
- Statistical object. Supports single or multiple fields, separated by commas. Maximum of 10 fields. Basic format is DataType:Value, for example HEADER:X-Forwarded-For, CLIENTIP, COOKIE:token, ARGS:device_id, JA3HASH.
- host string
- Domain name. The website domain to be protected. Make sure the domain has been added to the current WAF instance before calling.
- name string
- Rule name. Must start with Chinese/letter/number. Allows Chinese/letters/numbers/period (.)/underscore (_)/hyphen (-). Length 1~128 characters.
- path string
- Request path to which the rule applies. You can specify an exact page path, match the entire site, or all paths under a directory (using wildcard *). The wildcard * can only appear at the end of the path.
- rule_
priority number - Rule priority under the same path and advanced condition. Range 0~9, with 0 being the highest priority.
- statistical_
duration number - Statistical time window, in seconds. Frequency limit scenario (StatisticalType=1): 5~1800; repeat statistics scenario (StatisticalType=2/3): 1~60.
- statistical_
type string - Statistical method. "1": access frequency; "2": repeat count; "3": repeat ratio.
- accurate_
group object - Advanced condition group. Do not include this field if not enabled or if the list is empty.
- cron_
confs list(object) - Periodic cycle configuration list. Supported only for frequency limit rules with StatisticalType=1. Threshold switching is specified by crontab. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- effect_
time number - Action effective duration in seconds, range 30~86400. Required when creating or updating rules except for ActionType=1 (rate limiting).
- exemption_
time number - Exemption time for human verification, JS challenge, or proof of work, in seconds. Range 30~3600. Applies only when ActionType is 6/7/10.
- path_
threshold number - Overall threshold for the current path. Effective only when StatisticalType=1. Range 1~300000.
- project_
name string - Project name, which is the project associated with the current resource. Only projects with permissions under the current identity can be associated.
- single_
proportion number - Ratio threshold for a single statistical object. Enabled only when StatisticalType=3 (repeat ratio). Value range: [0, 1).
- single_
threshold number - Threshold for the number of times per statistical object. Used only when StatisticalType=1. Range 1~300000.
- action
Type Integer - Action to execute. 0: Observe; 1: Rate limit (supported only in frequency limit scenario, i.e., StatisticalType=1); 2: Block; 6: JS challenge; 7: CAPTCHA; 10: Proof of work; 11: Drop.
- enable Integer
- Rule switch. 0: Off; 1: On.
- field String
- Statistical object. Supports single or multiple fields, separated by commas. Maximum of 10 fields. Basic format is DataType:Value, for example HEADER:X-Forwarded-For, CLIENTIP, COOKIE:token, ARGS:device_id, JA3HASH.
- host String
- Domain name. The website domain to be protected. Make sure the domain has been added to the current WAF instance before calling.
- name String
- Rule name. Must start with Chinese/letter/number. Allows Chinese/letters/numbers/period (.)/underscore (_)/hyphen (-). Length 1~128 characters.
- path String
- Request path to which the rule applies. You can specify an exact page path, match the entire site, or all paths under a directory (using wildcard *). The wildcard * can only appear at the end of the path.
- rule
Priority Integer - Rule priority under the same path and advanced condition. Range 0~9, with 0 being the highest priority.
- statistical
Duration Integer - Statistical time window, in seconds. Frequency limit scenario (StatisticalType=1): 5~1800; repeat statistics scenario (StatisticalType=2/3): 1~60.
- statistical
Type String - Statistical method. "1": access frequency; "2": repeat count; "3": repeat ratio.
- accurate
Group BotAnalyse Protect Rule Accurate Group - Advanced condition group. Do not include this field if not enabled or if the list is empty.
- cron
Confs List<BotAnalyse Protect Rule Cron Conf> - Periodic cycle configuration list. Supported only for frequency limit rules with StatisticalType=1. Threshold switching is specified by crontab. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- effect
Time Integer - Action effective duration in seconds, range 30~86400. Required when creating or updating rules except for ActionType=1 (rate limiting).
- exemption
Time Integer - Exemption time for human verification, JS challenge, or proof of work, in seconds. Range 30~3600. Applies only when ActionType is 6/7/10.
- path
Threshold Integer - Overall threshold for the current path. Effective only when StatisticalType=1. Range 1~300000.
- project
Name String - Project name, which is the project associated with the current resource. Only projects with permissions under the current identity can be associated.
- single
Proportion Double - Ratio threshold for a single statistical object. Enabled only when StatisticalType=3 (repeat ratio). Value range: [0, 1).
- single
Threshold Integer - Threshold for the number of times per statistical object. Used only when StatisticalType=1. Range 1~300000.
- action
Type number - Action to execute. 0: Observe; 1: Rate limit (supported only in frequency limit scenario, i.e., StatisticalType=1); 2: Block; 6: JS challenge; 7: CAPTCHA; 10: Proof of work; 11: Drop.
- enable number
- Rule switch. 0: Off; 1: On.
- field string
- Statistical object. Supports single or multiple fields, separated by commas. Maximum of 10 fields. Basic format is DataType:Value, for example HEADER:X-Forwarded-For, CLIENTIP, COOKIE:token, ARGS:device_id, JA3HASH.
- host string
- Domain name. The website domain to be protected. Make sure the domain has been added to the current WAF instance before calling.
- name string
- Rule name. Must start with Chinese/letter/number. Allows Chinese/letters/numbers/period (.)/underscore (_)/hyphen (-). Length 1~128 characters.
- path string
- Request path to which the rule applies. You can specify an exact page path, match the entire site, or all paths under a directory (using wildcard *). The wildcard * can only appear at the end of the path.
- rule
Priority number - Rule priority under the same path and advanced condition. Range 0~9, with 0 being the highest priority.
- statistical
Duration number - Statistical time window, in seconds. Frequency limit scenario (StatisticalType=1): 5~1800; repeat statistics scenario (StatisticalType=2/3): 1~60.
- statistical
Type string - Statistical method. "1": access frequency; "2": repeat count; "3": repeat ratio.
- accurate
Group BotAnalyse Protect Rule Accurate Group - Advanced condition group. Do not include this field if not enabled or if the list is empty.
- cron
Confs BotAnalyse Protect Rule Cron Conf[] - Periodic cycle configuration list. Supported only for frequency limit rules with StatisticalType=1. Threshold switching is specified by crontab. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- effect
Time number - Action effective duration in seconds, range 30~86400. Required when creating or updating rules except for ActionType=1 (rate limiting).
- exemption
Time number - Exemption time for human verification, JS challenge, or proof of work, in seconds. Range 30~3600. Applies only when ActionType is 6/7/10.
- path
Threshold number - Overall threshold for the current path. Effective only when StatisticalType=1. Range 1~300000.
- project
Name string - Project name, which is the project associated with the current resource. Only projects with permissions under the current identity can be associated.
- single
Proportion number - Ratio threshold for a single statistical object. Enabled only when StatisticalType=3 (repeat ratio). Value range: [0, 1).
- single
Threshold number - Threshold for the number of times per statistical object. Used only when StatisticalType=1. Range 1~300000.
- action_
type int - Action to execute. 0: Observe; 1: Rate limit (supported only in frequency limit scenario, i.e., StatisticalType=1); 2: Block; 6: JS challenge; 7: CAPTCHA; 10: Proof of work; 11: Drop.
- enable int
- Rule switch. 0: Off; 1: On.
- field str
- Statistical object. Supports single or multiple fields, separated by commas. Maximum of 10 fields. Basic format is DataType:Value, for example HEADER:X-Forwarded-For, CLIENTIP, COOKIE:token, ARGS:device_id, JA3HASH.
- host str
- Domain name. The website domain to be protected. Make sure the domain has been added to the current WAF instance before calling.
- name str
- Rule name. Must start with Chinese/letter/number. Allows Chinese/letters/numbers/period (.)/underscore (_)/hyphen (-). Length 1~128 characters.
- path str
- Request path to which the rule applies. You can specify an exact page path, match the entire site, or all paths under a directory (using wildcard *). The wildcard * can only appear at the end of the path.
- rule_
priority int - Rule priority under the same path and advanced condition. Range 0~9, with 0 being the highest priority.
- statistical_
duration int - Statistical time window, in seconds. Frequency limit scenario (StatisticalType=1): 5~1800; repeat statistics scenario (StatisticalType=2/3): 1~60.
- statistical_
type str - Statistical method. "1": access frequency; "2": repeat count; "3": repeat ratio.
- accurate_
group BotAnalyse Protect Rule Accurate Group Args - Advanced condition group. Do not include this field if not enabled or if the list is empty.
- cron_
confs Sequence[BotAnalyse Protect Rule Cron Conf Args] - Periodic cycle configuration list. Supported only for frequency limit rules with StatisticalType=1. Threshold switching is specified by crontab. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- effect_
time int - Action effective duration in seconds, range 30~86400. Required when creating or updating rules except for ActionType=1 (rate limiting).
- exemption_
time int - Exemption time for human verification, JS challenge, or proof of work, in seconds. Range 30~3600. Applies only when ActionType is 6/7/10.
- path_
threshold int - Overall threshold for the current path. Effective only when StatisticalType=1. Range 1~300000.
- project_
name str - Project name, which is the project associated with the current resource. Only projects with permissions under the current identity can be associated.
- single_
proportion float - Ratio threshold for a single statistical object. Enabled only when StatisticalType=3 (repeat ratio). Value range: [0, 1).
- single_
threshold int - Threshold for the number of times per statistical object. Used only when StatisticalType=1. Range 1~300000.
- action
Type Number - Action to execute. 0: Observe; 1: Rate limit (supported only in frequency limit scenario, i.e., StatisticalType=1); 2: Block; 6: JS challenge; 7: CAPTCHA; 10: Proof of work; 11: Drop.
- enable Number
- Rule switch. 0: Off; 1: On.
- field String
- Statistical object. Supports single or multiple fields, separated by commas. Maximum of 10 fields. Basic format is DataType:Value, for example HEADER:X-Forwarded-For, CLIENTIP, COOKIE:token, ARGS:device_id, JA3HASH.
- host String
- Domain name. The website domain to be protected. Make sure the domain has been added to the current WAF instance before calling.
- name String
- Rule name. Must start with Chinese/letter/number. Allows Chinese/letters/numbers/period (.)/underscore (_)/hyphen (-). Length 1~128 characters.
- path String
- Request path to which the rule applies. You can specify an exact page path, match the entire site, or all paths under a directory (using wildcard *). The wildcard * can only appear at the end of the path.
- rule
Priority Number - Rule priority under the same path and advanced condition. Range 0~9, with 0 being the highest priority.
- statistical
Duration Number - Statistical time window, in seconds. Frequency limit scenario (StatisticalType=1): 5~1800; repeat statistics scenario (StatisticalType=2/3): 1~60.
- statistical
Type String - Statistical method. "1": access frequency; "2": repeat count; "3": repeat ratio.
- accurate
Group Property Map - Advanced condition group. Do not include this field if not enabled or if the list is empty.
- cron
Confs List<Property Map> - Periodic cycle configuration list. Supported only for frequency limit rules with StatisticalType=1. Threshold switching is specified by crontab. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- effect
Time Number - Action effective duration in seconds, range 30~86400. Required when creating or updating rules except for ActionType=1 (rate limiting).
- exemption
Time Number - Exemption time for human verification, JS challenge, or proof of work, in seconds. Range 30~3600. Applies only when ActionType is 6/7/10.
- path
Threshold Number - Overall threshold for the current path. Effective only when StatisticalType=1. Range 1~300000.
- project
Name String - Project name, which is the project associated with the current resource. Only projects with permissions under the current identity can be associated.
- single
Proportion Number - Ratio threshold for a single statistical object. Enabled only when StatisticalType=3 (repeat ratio). Value range: [0, 1).
- single
Threshold Number - Threshold for the number of times per statistical object. Used only when StatisticalType=1. Range 1~300000.
Outputs
All input properties are implicitly available as output properties. Additionally, the BotAnalyseProtectRule resource produces the following output properties:
- Action
After intVerification - Follow-up actions after challenge verification succeeds. Applies only when ActionType is 6 (JS challenge), 7 (human verification), or 10 (proof of work). 1: Block; 2: Monitor.
- Id string
- The provider-assigned unique ID for this managed resource.
- Pass
Ratio double - JS challenge or CAPTCHA pass rate. Returned only when ActionType is 6/7/10.
- Rule
Id string - Bot statistical protection rule ID.
- Rule
Tag string - Rule display ID. Frequency limit rule prefix is R (e.g., R000000018673); repeated statistics rule prefix is S (e.g., S000000018674).
- Update
Time string - Last update time of the rule.
- Action
After intVerification - Follow-up actions after challenge verification succeeds. Applies only when ActionType is 6 (JS challenge), 7 (human verification), or 10 (proof of work). 1: Block; 2: Monitor.
- Id string
- The provider-assigned unique ID for this managed resource.
- Pass
Ratio float64 - JS challenge or CAPTCHA pass rate. Returned only when ActionType is 6/7/10.
- Rule
Id string - Bot statistical protection rule ID.
- Rule
Tag string - Rule display ID. Frequency limit rule prefix is R (e.g., R000000018673); repeated statistics rule prefix is S (e.g., S000000018674).
- Update
Time string - Last update time of the rule.
- action_
after_ numberverification - Follow-up actions after challenge verification succeeds. Applies only when ActionType is 6 (JS challenge), 7 (human verification), or 10 (proof of work). 1: Block; 2: Monitor.
- id string
- The provider-assigned unique ID for this managed resource.
- pass_
ratio number - JS challenge or CAPTCHA pass rate. Returned only when ActionType is 6/7/10.
- rule_
id string - Bot statistical protection rule ID.
- rule_
tag string - Rule display ID. Frequency limit rule prefix is R (e.g., R000000018673); repeated statistics rule prefix is S (e.g., S000000018674).
- update_
time string - Last update time of the rule.
- action
After IntegerVerification - Follow-up actions after challenge verification succeeds. Applies only when ActionType is 6 (JS challenge), 7 (human verification), or 10 (proof of work). 1: Block; 2: Monitor.
- id String
- The provider-assigned unique ID for this managed resource.
- pass
Ratio Double - JS challenge or CAPTCHA pass rate. Returned only when ActionType is 6/7/10.
- rule
Id String - Bot statistical protection rule ID.
- rule
Tag String - Rule display ID. Frequency limit rule prefix is R (e.g., R000000018673); repeated statistics rule prefix is S (e.g., S000000018674).
- update
Time String - Last update time of the rule.
- action
After numberVerification - Follow-up actions after challenge verification succeeds. Applies only when ActionType is 6 (JS challenge), 7 (human verification), or 10 (proof of work). 1: Block; 2: Monitor.
- id string
- The provider-assigned unique ID for this managed resource.
- pass
Ratio number - JS challenge or CAPTCHA pass rate. Returned only when ActionType is 6/7/10.
- rule
Id string - Bot statistical protection rule ID.
- rule
Tag string - Rule display ID. Frequency limit rule prefix is R (e.g., R000000018673); repeated statistics rule prefix is S (e.g., S000000018674).
- update
Time string - Last update time of the rule.
- action_
after_ intverification - Follow-up actions after challenge verification succeeds. Applies only when ActionType is 6 (JS challenge), 7 (human verification), or 10 (proof of work). 1: Block; 2: Monitor.
- id str
- The provider-assigned unique ID for this managed resource.
- pass_
ratio float - JS challenge or CAPTCHA pass rate. Returned only when ActionType is 6/7/10.
- rule_
id str - Bot statistical protection rule ID.
- rule_
tag str - Rule display ID. Frequency limit rule prefix is R (e.g., R000000018673); repeated statistics rule prefix is S (e.g., S000000018674).
- update_
time str - Last update time of the rule.
- action
After NumberVerification - Follow-up actions after challenge verification succeeds. Applies only when ActionType is 6 (JS challenge), 7 (human verification), or 10 (proof of work). 1: Block; 2: Monitor.
- id String
- The provider-assigned unique ID for this managed resource.
- pass
Ratio Number - JS challenge or CAPTCHA pass rate. Returned only when ActionType is 6/7/10.
- rule
Id String - Bot statistical protection rule ID.
- rule
Tag String - Rule display ID. Frequency limit rule prefix is R (e.g., R000000018673); repeated statistics rule prefix is S (e.g., S000000018674).
- update
Time String - Last update time of the rule.
Look up Existing BotAnalyseProtectRule Resource
Get an existing BotAnalyseProtectRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: BotAnalyseProtectRuleState, opts?: CustomResourceOptions): BotAnalyseProtectRule@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
accurate_group: Optional[BotAnalyseProtectRuleAccurateGroupArgs] = None,
action_after_verification: Optional[int] = None,
action_type: Optional[int] = None,
cron_confs: Optional[Sequence[BotAnalyseProtectRuleCronConfArgs]] = None,
effect_time: Optional[int] = None,
enable: Optional[int] = None,
exemption_time: Optional[int] = None,
field: Optional[str] = None,
host: Optional[str] = None,
name: Optional[str] = None,
pass_ratio: Optional[float] = None,
path: Optional[str] = None,
path_threshold: Optional[int] = None,
project_name: Optional[str] = None,
rule_id: Optional[str] = None,
rule_priority: Optional[int] = None,
rule_tag: Optional[str] = None,
single_proportion: Optional[float] = None,
single_threshold: Optional[int] = None,
statistical_duration: Optional[int] = None,
statistical_type: Optional[str] = None,
update_time: Optional[str] = None) -> BotAnalyseProtectRulefunc GetBotAnalyseProtectRule(ctx *Context, name string, id IDInput, state *BotAnalyseProtectRuleState, opts ...ResourceOption) (*BotAnalyseProtectRule, error)public static BotAnalyseProtectRule Get(string name, Input<string> id, BotAnalyseProtectRuleState? state, CustomResourceOptions? opts = null)public static BotAnalyseProtectRule get(String name, Output<String> id, BotAnalyseProtectRuleState state, CustomResourceOptions options)resources: _: type: bytepluscc:waf:BotAnalyseProtectRule get: id: ${id}import {
to = bytepluscc_waf_bot_analyse_protect_rule.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Accurate
Group Byteplus.Bot Analyse Protect Rule Accurate Group - Advanced condition group. Do not include this field if not enabled or if the list is empty.
- Action
After intVerification - Follow-up actions after challenge verification succeeds. Applies only when ActionType is 6 (JS challenge), 7 (human verification), or 10 (proof of work). 1: Block; 2: Monitor.
- Action
Type int - Action to execute. 0: Observe; 1: Rate limit (supported only in frequency limit scenario, i.e., StatisticalType=1); 2: Block; 6: JS challenge; 7: CAPTCHA; 10: Proof of work; 11: Drop.
- Cron
Confs List<Byteplus.Bot Analyse Protect Rule Cron Conf> - Periodic cycle configuration list. Supported only for frequency limit rules with StatisticalType=1. Threshold switching is specified by crontab. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Effect
Time int - Action effective duration in seconds, range 30~86400. Required when creating or updating rules except for ActionType=1 (rate limiting).
- Enable int
- Rule switch. 0: Off; 1: On.
- Exemption
Time int - Exemption time for human verification, JS challenge, or proof of work, in seconds. Range 30~3600. Applies only when ActionType is 6/7/10.
- Field string
- Statistical object. Supports single or multiple fields, separated by commas. Maximum of 10 fields. Basic format is DataType:Value, for example HEADER:X-Forwarded-For, CLIENTIP, COOKIE:token, ARGS:device_id, JA3HASH.
- Host string
- Domain name. The website domain to be protected. Make sure the domain has been added to the current WAF instance before calling.
- Name string
- Rule name. Must start with Chinese/letter/number. Allows Chinese/letters/numbers/period (.)/underscore (_)/hyphen (-). Length 1~128 characters.
- Pass
Ratio double - JS challenge or CAPTCHA pass rate. Returned only when ActionType is 6/7/10.
- Path string
- Request path to which the rule applies. You can specify an exact page path, match the entire site, or all paths under a directory (using wildcard *). The wildcard * can only appear at the end of the path.
- Path
Threshold int - Overall threshold for the current path. Effective only when StatisticalType=1. Range 1~300000.
- Project
Name string - Project name, which is the project associated with the current resource. Only projects with permissions under the current identity can be associated.
- Rule
Id string - Bot statistical protection rule ID.
- Rule
Priority int - Rule priority under the same path and advanced condition. Range 0~9, with 0 being the highest priority.
- Rule
Tag string - Rule display ID. Frequency limit rule prefix is R (e.g., R000000018673); repeated statistics rule prefix is S (e.g., S000000018674).
- Single
Proportion double - Ratio threshold for a single statistical object. Enabled only when StatisticalType=3 (repeat ratio). Value range: [0, 1).
- Single
Threshold int - Threshold for the number of times per statistical object. Used only when StatisticalType=1. Range 1~300000.
- Statistical
Duration int - Statistical time window, in seconds. Frequency limit scenario (StatisticalType=1): 5~1800; repeat statistics scenario (StatisticalType=2/3): 1~60.
- Statistical
Type string - Statistical method. "1": access frequency; "2": repeat count; "3": repeat ratio.
- Update
Time string - Last update time of the rule.
- Accurate
Group BotAnalyse Protect Rule Accurate Group Args - Advanced condition group. Do not include this field if not enabled or if the list is empty.
- Action
After intVerification - Follow-up actions after challenge verification succeeds. Applies only when ActionType is 6 (JS challenge), 7 (human verification), or 10 (proof of work). 1: Block; 2: Monitor.
- Action
Type int - Action to execute. 0: Observe; 1: Rate limit (supported only in frequency limit scenario, i.e., StatisticalType=1); 2: Block; 6: JS challenge; 7: CAPTCHA; 10: Proof of work; 11: Drop.
- Cron
Confs []BotAnalyse Protect Rule Cron Conf Args - Periodic cycle configuration list. Supported only for frequency limit rules with StatisticalType=1. Threshold switching is specified by crontab. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Effect
Time int - Action effective duration in seconds, range 30~86400. Required when creating or updating rules except for ActionType=1 (rate limiting).
- Enable int
- Rule switch. 0: Off; 1: On.
- Exemption
Time int - Exemption time for human verification, JS challenge, or proof of work, in seconds. Range 30~3600. Applies only when ActionType is 6/7/10.
- Field string
- Statistical object. Supports single or multiple fields, separated by commas. Maximum of 10 fields. Basic format is DataType:Value, for example HEADER:X-Forwarded-For, CLIENTIP, COOKIE:token, ARGS:device_id, JA3HASH.
- Host string
- Domain name. The website domain to be protected. Make sure the domain has been added to the current WAF instance before calling.
- Name string
- Rule name. Must start with Chinese/letter/number. Allows Chinese/letters/numbers/period (.)/underscore (_)/hyphen (-). Length 1~128 characters.
- Pass
Ratio float64 - JS challenge or CAPTCHA pass rate. Returned only when ActionType is 6/7/10.
- Path string
- Request path to which the rule applies. You can specify an exact page path, match the entire site, or all paths under a directory (using wildcard *). The wildcard * can only appear at the end of the path.
- Path
Threshold int - Overall threshold for the current path. Effective only when StatisticalType=1. Range 1~300000.
- Project
Name string - Project name, which is the project associated with the current resource. Only projects with permissions under the current identity can be associated.
- Rule
Id string - Bot statistical protection rule ID.
- Rule
Priority int - Rule priority under the same path and advanced condition. Range 0~9, with 0 being the highest priority.
- Rule
Tag string - Rule display ID. Frequency limit rule prefix is R (e.g., R000000018673); repeated statistics rule prefix is S (e.g., S000000018674).
- Single
Proportion float64 - Ratio threshold for a single statistical object. Enabled only when StatisticalType=3 (repeat ratio). Value range: [0, 1).
- Single
Threshold int - Threshold for the number of times per statistical object. Used only when StatisticalType=1. Range 1~300000.
- Statistical
Duration int - Statistical time window, in seconds. Frequency limit scenario (StatisticalType=1): 5~1800; repeat statistics scenario (StatisticalType=2/3): 1~60.
- Statistical
Type string - Statistical method. "1": access frequency; "2": repeat count; "3": repeat ratio.
- Update
Time string - Last update time of the rule.
- accurate_
group object - Advanced condition group. Do not include this field if not enabled or if the list is empty.
- action_
after_ numberverification - Follow-up actions after challenge verification succeeds. Applies only when ActionType is 6 (JS challenge), 7 (human verification), or 10 (proof of work). 1: Block; 2: Monitor.
- action_
type number - Action to execute. 0: Observe; 1: Rate limit (supported only in frequency limit scenario, i.e., StatisticalType=1); 2: Block; 6: JS challenge; 7: CAPTCHA; 10: Proof of work; 11: Drop.
- cron_
confs list(object) - Periodic cycle configuration list. Supported only for frequency limit rules with StatisticalType=1. Threshold switching is specified by crontab. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- effect_
time number - Action effective duration in seconds, range 30~86400. Required when creating or updating rules except for ActionType=1 (rate limiting).
- enable number
- Rule switch. 0: Off; 1: On.
- exemption_
time number - Exemption time for human verification, JS challenge, or proof of work, in seconds. Range 30~3600. Applies only when ActionType is 6/7/10.
- field string
- Statistical object. Supports single or multiple fields, separated by commas. Maximum of 10 fields. Basic format is DataType:Value, for example HEADER:X-Forwarded-For, CLIENTIP, COOKIE:token, ARGS:device_id, JA3HASH.
- host string
- Domain name. The website domain to be protected. Make sure the domain has been added to the current WAF instance before calling.
- name string
- Rule name. Must start with Chinese/letter/number. Allows Chinese/letters/numbers/period (.)/underscore (_)/hyphen (-). Length 1~128 characters.
- pass_
ratio number - JS challenge or CAPTCHA pass rate. Returned only when ActionType is 6/7/10.
- path string
- Request path to which the rule applies. You can specify an exact page path, match the entire site, or all paths under a directory (using wildcard *). The wildcard * can only appear at the end of the path.
- path_
threshold number - Overall threshold for the current path. Effective only when StatisticalType=1. Range 1~300000.
- project_
name string - Project name, which is the project associated with the current resource. Only projects with permissions under the current identity can be associated.
- rule_
id string - Bot statistical protection rule ID.
- rule_
priority number - Rule priority under the same path and advanced condition. Range 0~9, with 0 being the highest priority.
- rule_
tag string - Rule display ID. Frequency limit rule prefix is R (e.g., R000000018673); repeated statistics rule prefix is S (e.g., S000000018674).
- single_
proportion number - Ratio threshold for a single statistical object. Enabled only when StatisticalType=3 (repeat ratio). Value range: [0, 1).
- single_
threshold number - Threshold for the number of times per statistical object. Used only when StatisticalType=1. Range 1~300000.
- statistical_
duration number - Statistical time window, in seconds. Frequency limit scenario (StatisticalType=1): 5~1800; repeat statistics scenario (StatisticalType=2/3): 1~60.
- statistical_
type string - Statistical method. "1": access frequency; "2": repeat count; "3": repeat ratio.
- update_
time string - Last update time of the rule.
- accurate
Group BotAnalyse Protect Rule Accurate Group - Advanced condition group. Do not include this field if not enabled or if the list is empty.
- action
After IntegerVerification - Follow-up actions after challenge verification succeeds. Applies only when ActionType is 6 (JS challenge), 7 (human verification), or 10 (proof of work). 1: Block; 2: Monitor.
- action
Type Integer - Action to execute. 0: Observe; 1: Rate limit (supported only in frequency limit scenario, i.e., StatisticalType=1); 2: Block; 6: JS challenge; 7: CAPTCHA; 10: Proof of work; 11: Drop.
- cron
Confs List<BotAnalyse Protect Rule Cron Conf> - Periodic cycle configuration list. Supported only for frequency limit rules with StatisticalType=1. Threshold switching is specified by crontab. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- effect
Time Integer - Action effective duration in seconds, range 30~86400. Required when creating or updating rules except for ActionType=1 (rate limiting).
- enable Integer
- Rule switch. 0: Off; 1: On.
- exemption
Time Integer - Exemption time for human verification, JS challenge, or proof of work, in seconds. Range 30~3600. Applies only when ActionType is 6/7/10.
- field String
- Statistical object. Supports single or multiple fields, separated by commas. Maximum of 10 fields. Basic format is DataType:Value, for example HEADER:X-Forwarded-For, CLIENTIP, COOKIE:token, ARGS:device_id, JA3HASH.
- host String
- Domain name. The website domain to be protected. Make sure the domain has been added to the current WAF instance before calling.
- name String
- Rule name. Must start with Chinese/letter/number. Allows Chinese/letters/numbers/period (.)/underscore (_)/hyphen (-). Length 1~128 characters.
- pass
Ratio Double - JS challenge or CAPTCHA pass rate. Returned only when ActionType is 6/7/10.
- path String
- Request path to which the rule applies. You can specify an exact page path, match the entire site, or all paths under a directory (using wildcard *). The wildcard * can only appear at the end of the path.
- path
Threshold Integer - Overall threshold for the current path. Effective only when StatisticalType=1. Range 1~300000.
- project
Name String - Project name, which is the project associated with the current resource. Only projects with permissions under the current identity can be associated.
- rule
Id String - Bot statistical protection rule ID.
- rule
Priority Integer - Rule priority under the same path and advanced condition. Range 0~9, with 0 being the highest priority.
- rule
Tag String - Rule display ID. Frequency limit rule prefix is R (e.g., R000000018673); repeated statistics rule prefix is S (e.g., S000000018674).
- single
Proportion Double - Ratio threshold for a single statistical object. Enabled only when StatisticalType=3 (repeat ratio). Value range: [0, 1).
- single
Threshold Integer - Threshold for the number of times per statistical object. Used only when StatisticalType=1. Range 1~300000.
- statistical
Duration Integer - Statistical time window, in seconds. Frequency limit scenario (StatisticalType=1): 5~1800; repeat statistics scenario (StatisticalType=2/3): 1~60.
- statistical
Type String - Statistical method. "1": access frequency; "2": repeat count; "3": repeat ratio.
- update
Time String - Last update time of the rule.
- accurate
Group BotAnalyse Protect Rule Accurate Group - Advanced condition group. Do not include this field if not enabled or if the list is empty.
- action
After numberVerification - Follow-up actions after challenge verification succeeds. Applies only when ActionType is 6 (JS challenge), 7 (human verification), or 10 (proof of work). 1: Block; 2: Monitor.
- action
Type number - Action to execute. 0: Observe; 1: Rate limit (supported only in frequency limit scenario, i.e., StatisticalType=1); 2: Block; 6: JS challenge; 7: CAPTCHA; 10: Proof of work; 11: Drop.
- cron
Confs BotAnalyse Protect Rule Cron Conf[] - Periodic cycle configuration list. Supported only for frequency limit rules with StatisticalType=1. Threshold switching is specified by crontab. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- effect
Time number - Action effective duration in seconds, range 30~86400. Required when creating or updating rules except for ActionType=1 (rate limiting).
- enable number
- Rule switch. 0: Off; 1: On.
- exemption
Time number - Exemption time for human verification, JS challenge, or proof of work, in seconds. Range 30~3600. Applies only when ActionType is 6/7/10.
- field string
- Statistical object. Supports single or multiple fields, separated by commas. Maximum of 10 fields. Basic format is DataType:Value, for example HEADER:X-Forwarded-For, CLIENTIP, COOKIE:token, ARGS:device_id, JA3HASH.
- host string
- Domain name. The website domain to be protected. Make sure the domain has been added to the current WAF instance before calling.
- name string
- Rule name. Must start with Chinese/letter/number. Allows Chinese/letters/numbers/period (.)/underscore (_)/hyphen (-). Length 1~128 characters.
- pass
Ratio number - JS challenge or CAPTCHA pass rate. Returned only when ActionType is 6/7/10.
- path string
- Request path to which the rule applies. You can specify an exact page path, match the entire site, or all paths under a directory (using wildcard *). The wildcard * can only appear at the end of the path.
- path
Threshold number - Overall threshold for the current path. Effective only when StatisticalType=1. Range 1~300000.
- project
Name string - Project name, which is the project associated with the current resource. Only projects with permissions under the current identity can be associated.
- rule
Id string - Bot statistical protection rule ID.
- rule
Priority number - Rule priority under the same path and advanced condition. Range 0~9, with 0 being the highest priority.
- rule
Tag string - Rule display ID. Frequency limit rule prefix is R (e.g., R000000018673); repeated statistics rule prefix is S (e.g., S000000018674).
- single
Proportion number - Ratio threshold for a single statistical object. Enabled only when StatisticalType=3 (repeat ratio). Value range: [0, 1).
- single
Threshold number - Threshold for the number of times per statistical object. Used only when StatisticalType=1. Range 1~300000.
- statistical
Duration number - Statistical time window, in seconds. Frequency limit scenario (StatisticalType=1): 5~1800; repeat statistics scenario (StatisticalType=2/3): 1~60.
- statistical
Type string - Statistical method. "1": access frequency; "2": repeat count; "3": repeat ratio.
- update
Time string - Last update time of the rule.
- accurate_
group BotAnalyse Protect Rule Accurate Group Args - Advanced condition group. Do not include this field if not enabled or if the list is empty.
- action_
after_ intverification - Follow-up actions after challenge verification succeeds. Applies only when ActionType is 6 (JS challenge), 7 (human verification), or 10 (proof of work). 1: Block; 2: Monitor.
- action_
type int - Action to execute. 0: Observe; 1: Rate limit (supported only in frequency limit scenario, i.e., StatisticalType=1); 2: Block; 6: JS challenge; 7: CAPTCHA; 10: Proof of work; 11: Drop.
- cron_
confs Sequence[BotAnalyse Protect Rule Cron Conf Args] - Periodic cycle configuration list. Supported only for frequency limit rules with StatisticalType=1. Threshold switching is specified by crontab. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- effect_
time int - Action effective duration in seconds, range 30~86400. Required when creating or updating rules except for ActionType=1 (rate limiting).
- enable int
- Rule switch. 0: Off; 1: On.
- exemption_
time int - Exemption time for human verification, JS challenge, or proof of work, in seconds. Range 30~3600. Applies only when ActionType is 6/7/10.
- field str
- Statistical object. Supports single or multiple fields, separated by commas. Maximum of 10 fields. Basic format is DataType:Value, for example HEADER:X-Forwarded-For, CLIENTIP, COOKIE:token, ARGS:device_id, JA3HASH.
- host str
- Domain name. The website domain to be protected. Make sure the domain has been added to the current WAF instance before calling.
- name str
- Rule name. Must start with Chinese/letter/number. Allows Chinese/letters/numbers/period (.)/underscore (_)/hyphen (-). Length 1~128 characters.
- pass_
ratio float - JS challenge or CAPTCHA pass rate. Returned only when ActionType is 6/7/10.
- path str
- Request path to which the rule applies. You can specify an exact page path, match the entire site, or all paths under a directory (using wildcard *). The wildcard * can only appear at the end of the path.
- path_
threshold int - Overall threshold for the current path. Effective only when StatisticalType=1. Range 1~300000.
- project_
name str - Project name, which is the project associated with the current resource. Only projects with permissions under the current identity can be associated.
- rule_
id str - Bot statistical protection rule ID.
- rule_
priority int - Rule priority under the same path and advanced condition. Range 0~9, with 0 being the highest priority.
- rule_
tag str - Rule display ID. Frequency limit rule prefix is R (e.g., R000000018673); repeated statistics rule prefix is S (e.g., S000000018674).
- single_
proportion float - Ratio threshold for a single statistical object. Enabled only when StatisticalType=3 (repeat ratio). Value range: [0, 1).
- single_
threshold int - Threshold for the number of times per statistical object. Used only when StatisticalType=1. Range 1~300000.
- statistical_
duration int - Statistical time window, in seconds. Frequency limit scenario (StatisticalType=1): 5~1800; repeat statistics scenario (StatisticalType=2/3): 1~60.
- statistical_
type str - Statistical method. "1": access frequency; "2": repeat count; "3": repeat ratio.
- update_
time str - Last update time of the rule.
- accurate
Group Property Map - Advanced condition group. Do not include this field if not enabled or if the list is empty.
- action
After NumberVerification - Follow-up actions after challenge verification succeeds. Applies only when ActionType is 6 (JS challenge), 7 (human verification), or 10 (proof of work). 1: Block; 2: Monitor.
- action
Type Number - Action to execute. 0: Observe; 1: Rate limit (supported only in frequency limit scenario, i.e., StatisticalType=1); 2: Block; 6: JS challenge; 7: CAPTCHA; 10: Proof of work; 11: Drop.
- cron
Confs List<Property Map> - Periodic cycle configuration list. Supported only for frequency limit rules with StatisticalType=1. Threshold switching is specified by crontab. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- effect
Time Number - Action effective duration in seconds, range 30~86400. Required when creating or updating rules except for ActionType=1 (rate limiting).
- enable Number
- Rule switch. 0: Off; 1: On.
- exemption
Time Number - Exemption time for human verification, JS challenge, or proof of work, in seconds. Range 30~3600. Applies only when ActionType is 6/7/10.
- field String
- Statistical object. Supports single or multiple fields, separated by commas. Maximum of 10 fields. Basic format is DataType:Value, for example HEADER:X-Forwarded-For, CLIENTIP, COOKIE:token, ARGS:device_id, JA3HASH.
- host String
- Domain name. The website domain to be protected. Make sure the domain has been added to the current WAF instance before calling.
- name String
- Rule name. Must start with Chinese/letter/number. Allows Chinese/letters/numbers/period (.)/underscore (_)/hyphen (-). Length 1~128 characters.
- pass
Ratio Number - JS challenge or CAPTCHA pass rate. Returned only when ActionType is 6/7/10.
- path String
- Request path to which the rule applies. You can specify an exact page path, match the entire site, or all paths under a directory (using wildcard *). The wildcard * can only appear at the end of the path.
- path
Threshold Number - Overall threshold for the current path. Effective only when StatisticalType=1. Range 1~300000.
- project
Name String - Project name, which is the project associated with the current resource. Only projects with permissions under the current identity can be associated.
- rule
Id String - Bot statistical protection rule ID.
- rule
Priority Number - Rule priority under the same path and advanced condition. Range 0~9, with 0 being the highest priority.
- rule
Tag String - Rule display ID. Frequency limit rule prefix is R (e.g., R000000018673); repeated statistics rule prefix is S (e.g., S000000018674).
- single
Proportion Number - Ratio threshold for a single statistical object. Enabled only when StatisticalType=3 (repeat ratio). Value range: [0, 1).
- single
Threshold Number - Threshold for the number of times per statistical object. Used only when StatisticalType=1. Range 1~300000.
- statistical
Duration Number - Statistical time window, in seconds. Frequency limit scenario (StatisticalType=1): 5~1800; repeat statistics scenario (StatisticalType=2/3): 1~60.
- statistical
Type String - Statistical method. "1": access frequency; "2": repeat count; "3": repeat ratio.
- update
Time String - Last update time of the rule.
Supporting Types
BotAnalyseProtectRuleAccurateGroup, BotAnalyseProtectRuleAccurateGroupArgs
- Accurate
Group intPriority - Priority of advanced condition group. Not required for create/update; used only for list display.
- Accurate
Rules List<Byteplus.Bot Analyse Protect Rule Accurate Group Accurate Rule> - Sub-rule list in advanced conditions. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Id int
- Advanced condition group ID. Not required for create/update operations; used only for list display.
- Logic int
- Logical relationship. 1: AND; 2: OR.
- Accurate
Group intPriority - Priority of advanced condition group. Not required for create/update; used only for list display.
- Accurate
Rules []BotAnalyse Protect Rule Accurate Group Accurate Rule - Sub-rule list in advanced conditions. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Id int
- Advanced condition group ID. Not required for create/update operations; used only for list display.
- Logic int
- Logical relationship. 1: AND; 2: OR.
- accurate_
group_ numberpriority - Priority of advanced condition group. Not required for create/update; used only for list display.
- accurate_
rules list(object) - Sub-rule list in advanced conditions. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- id number
- Advanced condition group ID. Not required for create/update operations; used only for list display.
- logic number
- Logical relationship. 1: AND; 2: OR.
- accurate
Group IntegerPriority - Priority of advanced condition group. Not required for create/update; used only for list display.
- accurate
Rules List<BotAnalyse Protect Rule Accurate Group Accurate Rule> - Sub-rule list in advanced conditions. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- id Integer
- Advanced condition group ID. Not required for create/update operations; used only for list display.
- logic Integer
- Logical relationship. 1: AND; 2: OR.
- accurate
Group numberPriority - Priority of advanced condition group. Not required for create/update; used only for list display.
- accurate
Rules BotAnalyse Protect Rule Accurate Group Accurate Rule[] - Sub-rule list in advanced conditions. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- id number
- Advanced condition group ID. Not required for create/update operations; used only for list display.
- logic number
- Logical relationship. 1: AND; 2: OR.
- accurate_
group_ intpriority - Priority of advanced condition group. Not required for create/update; used only for list display.
- accurate_
rules Sequence[BotAnalyse Protect Rule Accurate Group Accurate Rule] - Sub-rule list in advanced conditions. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- id int
- Advanced condition group ID. Not required for create/update operations; used only for list display.
- logic int
- Logical relationship. 1: AND; 2: OR.
- accurate
Group NumberPriority - Priority of advanced condition group. Not required for create/update; used only for list display.
- accurate
Rules List<Property Map> - Sub-rule list in advanced conditions. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- id Number
- Advanced condition group ID. Not required for create/update operations; used only for list display.
- logic Number
- Logical relationship. 1: AND; 2: OR.
BotAnalyseProtectRuleAccurateGroupAccurateRule, BotAnalyseProtectRuleAccurateGroupAccurateRuleArgs
- Http
Obj string - Match object. Fixed objects automatically generate HttpObj by ObjType. Custom objects require specifying the Key in HttpObj, e.g., request.header.clientip, request.uri, request.queryargs.abc, request.header.custom-header, request.cookie.custom-cookie, etc.
- Obj
Type int - Enumeration of match object types. 0: request protocol; 1: request URI; 2: request method; 3: request path; 4: request parameters; 5: request header; 6: User-Agent; 7: Referer; 8: Cookie; 9: request body length; 10: request body format; 11: X-Forwarded-For; 12: client IP; 13: custom Args; 14: custom Header; 15: custom Cookie; 23: JA3 Hash; 25: Session-ID; 26: client fingerprint.
- Opretar int
- Enumeration of match operators. 0~5: size comparison; 6~11: substring match; 12~15: set match; 16: regex; 17~21: IP identification (only for request.header.clientip or custom objects); 23/24: include/exclude address group; 25/26: include/exclude geographic location; 27: include IP intelligence; 28/29: AS number belongs/does not belong.
- Property int
- Match attribute type enumeration. 0: Value; 1: StrLen; 2: Size; 3: Keys; 4: Version; 5: IP (used only for Operator=17~21); 6: Country.
- Value
String string - Match value. IP identification operations with Operator=17~21 do not involve match content and can be an empty string. For Operator=23~29, fill in according to the corresponding format (IP address group ID/region code/IP intelligence tag/ASN). For other operators, enter the actual match value.
- Http
Obj string - Match object. Fixed objects automatically generate HttpObj by ObjType. Custom objects require specifying the Key in HttpObj, e.g., request.header.clientip, request.uri, request.queryargs.abc, request.header.custom-header, request.cookie.custom-cookie, etc.
- Obj
Type int - Enumeration of match object types. 0: request protocol; 1: request URI; 2: request method; 3: request path; 4: request parameters; 5: request header; 6: User-Agent; 7: Referer; 8: Cookie; 9: request body length; 10: request body format; 11: X-Forwarded-For; 12: client IP; 13: custom Args; 14: custom Header; 15: custom Cookie; 23: JA3 Hash; 25: Session-ID; 26: client fingerprint.
- Opretar int
- Enumeration of match operators. 0~5: size comparison; 6~11: substring match; 12~15: set match; 16: regex; 17~21: IP identification (only for request.header.clientip or custom objects); 23/24: include/exclude address group; 25/26: include/exclude geographic location; 27: include IP intelligence; 28/29: AS number belongs/does not belong.
- Property int
- Match attribute type enumeration. 0: Value; 1: StrLen; 2: Size; 3: Keys; 4: Version; 5: IP (used only for Operator=17~21); 6: Country.
- Value
String string - Match value. IP identification operations with Operator=17~21 do not involve match content and can be an empty string. For Operator=23~29, fill in according to the corresponding format (IP address group ID/region code/IP intelligence tag/ASN). For other operators, enter the actual match value.
- http_
obj string - Match object. Fixed objects automatically generate HttpObj by ObjType. Custom objects require specifying the Key in HttpObj, e.g., request.header.clientip, request.uri, request.queryargs.abc, request.header.custom-header, request.cookie.custom-cookie, etc.
- obj_
type number - Enumeration of match object types. 0: request protocol; 1: request URI; 2: request method; 3: request path; 4: request parameters; 5: request header; 6: User-Agent; 7: Referer; 8: Cookie; 9: request body length; 10: request body format; 11: X-Forwarded-For; 12: client IP; 13: custom Args; 14: custom Header; 15: custom Cookie; 23: JA3 Hash; 25: Session-ID; 26: client fingerprint.
- opretar number
- Enumeration of match operators. 0~5: size comparison; 6~11: substring match; 12~15: set match; 16: regex; 17~21: IP identification (only for request.header.clientip or custom objects); 23/24: include/exclude address group; 25/26: include/exclude geographic location; 27: include IP intelligence; 28/29: AS number belongs/does not belong.
- property number
- Match attribute type enumeration. 0: Value; 1: StrLen; 2: Size; 3: Keys; 4: Version; 5: IP (used only for Operator=17~21); 6: Country.
- value_
string string - Match value. IP identification operations with Operator=17~21 do not involve match content and can be an empty string. For Operator=23~29, fill in according to the corresponding format (IP address group ID/region code/IP intelligence tag/ASN). For other operators, enter the actual match value.
- http
Obj String - Match object. Fixed objects automatically generate HttpObj by ObjType. Custom objects require specifying the Key in HttpObj, e.g., request.header.clientip, request.uri, request.queryargs.abc, request.header.custom-header, request.cookie.custom-cookie, etc.
- obj
Type Integer - Enumeration of match object types. 0: request protocol; 1: request URI; 2: request method; 3: request path; 4: request parameters; 5: request header; 6: User-Agent; 7: Referer; 8: Cookie; 9: request body length; 10: request body format; 11: X-Forwarded-For; 12: client IP; 13: custom Args; 14: custom Header; 15: custom Cookie; 23: JA3 Hash; 25: Session-ID; 26: client fingerprint.
- opretar Integer
- Enumeration of match operators. 0~5: size comparison; 6~11: substring match; 12~15: set match; 16: regex; 17~21: IP identification (only for request.header.clientip or custom objects); 23/24: include/exclude address group; 25/26: include/exclude geographic location; 27: include IP intelligence; 28/29: AS number belongs/does not belong.
- property Integer
- Match attribute type enumeration. 0: Value; 1: StrLen; 2: Size; 3: Keys; 4: Version; 5: IP (used only for Operator=17~21); 6: Country.
- value
String String - Match value. IP identification operations with Operator=17~21 do not involve match content and can be an empty string. For Operator=23~29, fill in according to the corresponding format (IP address group ID/region code/IP intelligence tag/ASN). For other operators, enter the actual match value.
- http
Obj string - Match object. Fixed objects automatically generate HttpObj by ObjType. Custom objects require specifying the Key in HttpObj, e.g., request.header.clientip, request.uri, request.queryargs.abc, request.header.custom-header, request.cookie.custom-cookie, etc.
- obj
Type number - Enumeration of match object types. 0: request protocol; 1: request URI; 2: request method; 3: request path; 4: request parameters; 5: request header; 6: User-Agent; 7: Referer; 8: Cookie; 9: request body length; 10: request body format; 11: X-Forwarded-For; 12: client IP; 13: custom Args; 14: custom Header; 15: custom Cookie; 23: JA3 Hash; 25: Session-ID; 26: client fingerprint.
- opretar number
- Enumeration of match operators. 0~5: size comparison; 6~11: substring match; 12~15: set match; 16: regex; 17~21: IP identification (only for request.header.clientip or custom objects); 23/24: include/exclude address group; 25/26: include/exclude geographic location; 27: include IP intelligence; 28/29: AS number belongs/does not belong.
- property number
- Match attribute type enumeration. 0: Value; 1: StrLen; 2: Size; 3: Keys; 4: Version; 5: IP (used only for Operator=17~21); 6: Country.
- value
String string - Match value. IP identification operations with Operator=17~21 do not involve match content and can be an empty string. For Operator=23~29, fill in according to the corresponding format (IP address group ID/region code/IP intelligence tag/ASN). For other operators, enter the actual match value.
- http_
obj str - Match object. Fixed objects automatically generate HttpObj by ObjType. Custom objects require specifying the Key in HttpObj, e.g., request.header.clientip, request.uri, request.queryargs.abc, request.header.custom-header, request.cookie.custom-cookie, etc.
- obj_
type int - Enumeration of match object types. 0: request protocol; 1: request URI; 2: request method; 3: request path; 4: request parameters; 5: request header; 6: User-Agent; 7: Referer; 8: Cookie; 9: request body length; 10: request body format; 11: X-Forwarded-For; 12: client IP; 13: custom Args; 14: custom Header; 15: custom Cookie; 23: JA3 Hash; 25: Session-ID; 26: client fingerprint.
- opretar int
- Enumeration of match operators. 0~5: size comparison; 6~11: substring match; 12~15: set match; 16: regex; 17~21: IP identification (only for request.header.clientip or custom objects); 23/24: include/exclude address group; 25/26: include/exclude geographic location; 27: include IP intelligence; 28/29: AS number belongs/does not belong.
- property int
- Match attribute type enumeration. 0: Value; 1: StrLen; 2: Size; 3: Keys; 4: Version; 5: IP (used only for Operator=17~21); 6: Country.
- value_
string str - Match value. IP identification operations with Operator=17~21 do not involve match content and can be an empty string. For Operator=23~29, fill in according to the corresponding format (IP address group ID/region code/IP intelligence tag/ASN). For other operators, enter the actual match value.
- http
Obj String - Match object. Fixed objects automatically generate HttpObj by ObjType. Custom objects require specifying the Key in HttpObj, e.g., request.header.clientip, request.uri, request.queryargs.abc, request.header.custom-header, request.cookie.custom-cookie, etc.
- obj
Type Number - Enumeration of match object types. 0: request protocol; 1: request URI; 2: request method; 3: request path; 4: request parameters; 5: request header; 6: User-Agent; 7: Referer; 8: Cookie; 9: request body length; 10: request body format; 11: X-Forwarded-For; 12: client IP; 13: custom Args; 14: custom Header; 15: custom Cookie; 23: JA3 Hash; 25: Session-ID; 26: client fingerprint.
- opretar Number
- Enumeration of match operators. 0~5: size comparison; 6~11: substring match; 12~15: set match; 16: regex; 17~21: IP identification (only for request.header.clientip or custom objects); 23/24: include/exclude address group; 25/26: include/exclude geographic location; 27: include IP intelligence; 28/29: AS number belongs/does not belong.
- property Number
- Match attribute type enumeration. 0: Value; 1: StrLen; 2: Size; 3: Keys; 4: Version; 5: IP (used only for Operator=17~21); 6: Country.
- value
String String - Match value. IP identification operations with Operator=17~21 do not involve match content and can be an empty string. For Operator=23~29, fill in according to the corresponding format (IP address group ID/region code/IP intelligence tag/ASN). For other operators, enter the actual match value.
BotAnalyseProtectRuleCronConf, BotAnalyseProtectRuleCronConfArgs
- Crontab string
- crontab expression. Recommended format: * \n\n-\n\n * * \n\n, for example * 18-20 * * 1,2,3,4,5.
- Path
Threshold int - Total path threshold during the specified period. Value range: 1~300000.
- Single
Threshold int - Threshold for a single object during the specified period. Value range: 1~300000.
- Crontab string
- crontab expression. Recommended format: * \n\n-\n\n * * \n\n, for example * 18-20 * * 1,2,3,4,5.
- Path
Threshold int - Total path threshold during the specified period. Value range: 1~300000.
- Single
Threshold int - Threshold for a single object during the specified period. Value range: 1~300000.
- crontab string
- crontab expression. Recommended format: * \n\n-\n\n * * \n\n, for example * 18-20 * * 1,2,3,4,5.
- path_
threshold number - Total path threshold during the specified period. Value range: 1~300000.
- single_
threshold number - Threshold for a single object during the specified period. Value range: 1~300000.
- crontab String
- crontab expression. Recommended format: * \n\n-\n\n * * \n\n, for example * 18-20 * * 1,2,3,4,5.
- path
Threshold Integer - Total path threshold during the specified period. Value range: 1~300000.
- single
Threshold Integer - Threshold for a single object during the specified period. Value range: 1~300000.
- crontab string
- crontab expression. Recommended format: * \n\n-\n\n * * \n\n, for example * 18-20 * * 1,2,3,4,5.
- path
Threshold number - Total path threshold during the specified period. Value range: 1~300000.
- single
Threshold number - Threshold for a single object during the specified period. Value range: 1~300000.
- crontab str
- crontab expression. Recommended format: * \n\n-\n\n * * \n\n, for example * 18-20 * * 1,2,3,4,5.
- path_
threshold int - Total path threshold during the specified period. Value range: 1~300000.
- single_
threshold int - Threshold for a single object during the specified period. Value range: 1~300000.
- crontab String
- crontab expression. Recommended format: * \n\n-\n\n * * \n\n, for example * 18-20 * * 1,2,3,4,5.
- path
Threshold Number - Total path threshold during the specified period. Value range: 1~300000.
- single
Threshold Number - Threshold for a single object during the specified period. Value range: 1~300000.
Import
$ pulumi import bytepluscc:waf/botAnalyseProtectRule:BotAnalyseProtectRule example "host|rule_id|statistical_type"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- bytepluscc byteplus-sdk/pulumi-bytepluscc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
byteplusccTerraform Provider.
published on Thursday, Oct 15, 2026 by Byteplus