Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Bytepluscc Provider
  4. API Docs
  5. waf
  6. getBotAnalyseProtectRule
Viewing docs for bytepluscc v0.0.55
published on Thursday, Oct 15, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.waf.getBotAnalyseProtectRule

bytepluscc logo bytepluscc
Viewing docs for bytepluscc v0.0.55
published on Thursday, Oct 15, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Data Source schema for Byteplus::WAF::BotAnalyseProtectRule

    Using getBotAnalyseProtectRule

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBotAnalyseProtectRule(args: GetBotAnalyseProtectRuleArgs, opts?: InvokeOptions): Promise<GetBotAnalyseProtectRuleResult>
function getBotAnalyseProtectRuleOutput(args: GetBotAnalyseProtectRuleOutputArgs, opts?: InvokeOutputOptions): Output<GetBotAnalyseProtectRuleResult>
    def get_bot_analyse_protect_rule(id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetBotAnalyseProtectRuleResult
def get_bot_analyse_protect_rule_output(id: pulumi.Input[Optional[str]] = None,
                                 opts: Optional[InvokeOutputOptions] = None) -> Output[GetBotAnalyseProtectRuleResult]
    func LookupBotAnalyseProtectRule(ctx *Context, args *LookupBotAnalyseProtectRuleArgs, opts ...InvokeOption) (*LookupBotAnalyseProtectRuleResult, error)
func LookupBotAnalyseProtectRuleOutput(ctx *Context, args *LookupBotAnalyseProtectRuleOutputArgs, opts ...InvokeOption) LookupBotAnalyseProtectRuleResultOutput

    > Note: This function is named LookupBotAnalyseProtectRule in the Go SDK.

    public static class GetBotAnalyseProtectRule 
{
    public static Task<GetBotAnalyseProtectRuleResult> InvokeAsync(GetBotAnalyseProtectRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetBotAnalyseProtectRuleResult> Invoke(GetBotAnalyseProtectRuleInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetBotAnalyseProtectRuleResult> Invoke(GetBotAnalyseProtectRuleInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetBotAnalyseProtectRuleResult> getBotAnalyseProtectRule(GetBotAnalyseProtectRuleArgs args, InvokeOptions options)
public static Output<GetBotAnalyseProtectRuleResult> getBotAnalyseProtectRule(GetBotAnalyseProtectRuleArgs args, InvokeOptions options)
public static Output<GetBotAnalyseProtectRuleResult> getBotAnalyseProtectRule(GetBotAnalyseProtectRuleArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: bytepluscc:waf/getBotAnalyseProtectRule:getBotAnalyseProtectRule
  arguments:
    # arguments dictionary
    data "bytepluscc_waf_get_bot_analyse_protect_rule" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getBotAnalyseProtectRule Result

    The following output properties are available:

    AccurateGroup Byteplus.GetBotAnalyseProtectRuleAccurateGroup
    Advanced condition group. Do not include this field if not enabled or if the list is empty.
    ActionAfterVerification int
    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.
    ActionType 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.
    CronConfs List<Byteplus.GetBotAnalyseProtectRuleCronConf>
    Periodic cycle configuration list. Supported only for frequency limit rules with StatisticalType=1. Threshold switching is specified by crontab.
    EffectTime 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.
    ExemptionTime 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.
    Id string
    Uniquely identifies the resource.
    Name string
    Rule name. Must start with Chinese/letter/number. Allows Chinese/letters/numbers/period (.)/underscore (_)/hyphen (-). Length 1~128 characters.
    PassRatio 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.
    PathThreshold int
    Overall threshold for the current path. Effective only when StatisticalType=1. Range 1~300000.
    ProjectName string
    Project name, which is the project associated with the current resource. Only projects with permissions under the current identity can be associated.
    RuleId string
    Bot statistical protection rule ID.
    RulePriority int
    Rule priority under the same path and advanced condition. Range 0~9, with 0 being the highest priority.
    RuleTag string
    Rule display ID. Frequency limit rule prefix is R (e.g., R000000018673); repeated statistics rule prefix is S (e.g., S000000018674).
    SingleProportion double
    Ratio threshold for a single statistical object. Enabled only when StatisticalType=3 (repeat ratio). Value range: [0, 1).
    SingleThreshold int
    Threshold for the number of times per statistical object. Used only when StatisticalType=1. Range 1~300000.
    StatisticalDuration int
    Statistical time window, in seconds. Frequency limit scenario (StatisticalType=1): 5~1800; repeat statistics scenario (StatisticalType=2/3): 1~60.
    StatisticalType string
    Statistical method. "1": access frequency; "2": repeat count; "3": repeat ratio.
    UpdateTime string
    Last update time of the rule.
    AccurateGroup GetBotAnalyseProtectRuleAccurateGroup
    Advanced condition group. Do not include this field if not enabled or if the list is empty.
    ActionAfterVerification int
    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.
    ActionType 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.
    CronConfs []GetBotAnalyseProtectRuleCronConf
    Periodic cycle configuration list. Supported only for frequency limit rules with StatisticalType=1. Threshold switching is specified by crontab.
    EffectTime 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.
    ExemptionTime 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.
    Id string
    Uniquely identifies the resource.
    Name string
    Rule name. Must start with Chinese/letter/number. Allows Chinese/letters/numbers/period (.)/underscore (_)/hyphen (-). Length 1~128 characters.
    PassRatio 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.
    PathThreshold int
    Overall threshold for the current path. Effective only when StatisticalType=1. Range 1~300000.
    ProjectName string
    Project name, which is the project associated with the current resource. Only projects with permissions under the current identity can be associated.
    RuleId string
    Bot statistical protection rule ID.
    RulePriority int
    Rule priority under the same path and advanced condition. Range 0~9, with 0 being the highest priority.
    RuleTag string
    Rule display ID. Frequency limit rule prefix is R (e.g., R000000018673); repeated statistics rule prefix is S (e.g., S000000018674).
    SingleProportion float64
    Ratio threshold for a single statistical object. Enabled only when StatisticalType=3 (repeat ratio). Value range: [0, 1).
    SingleThreshold int
    Threshold for the number of times per statistical object. Used only when StatisticalType=1. Range 1~300000.
    StatisticalDuration int
    Statistical time window, in seconds. Frequency limit scenario (StatisticalType=1): 5~1800; repeat statistics scenario (StatisticalType=2/3): 1~60.
    StatisticalType string
    Statistical method. "1": access frequency; "2": repeat count; "3": repeat ratio.
    UpdateTime 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_verification number
    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.
    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.
    id string
    Uniquely identifies the resource.
    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.
    accurateGroup GetBotAnalyseProtectRuleAccurateGroup
    Advanced condition group. Do not include this field if not enabled or if the list is empty.
    actionAfterVerification Integer
    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.
    actionType 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.
    cronConfs List<GetBotAnalyseProtectRuleCronConf>
    Periodic cycle configuration list. Supported only for frequency limit rules with StatisticalType=1. Threshold switching is specified by crontab.
    effectTime 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.
    exemptionTime 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.
    id String
    Uniquely identifies the resource.
    name String
    Rule name. Must start with Chinese/letter/number. Allows Chinese/letters/numbers/period (.)/underscore (_)/hyphen (-). Length 1~128 characters.
    passRatio 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.
    pathThreshold Integer
    Overall threshold for the current path. Effective only when StatisticalType=1. Range 1~300000.
    projectName String
    Project name, which is the project associated with the current resource. Only projects with permissions under the current identity can be associated.
    ruleId String
    Bot statistical protection rule ID.
    rulePriority Integer
    Rule priority under the same path and advanced condition. Range 0~9, with 0 being the highest priority.
    ruleTag String
    Rule display ID. Frequency limit rule prefix is R (e.g., R000000018673); repeated statistics rule prefix is S (e.g., S000000018674).
    singleProportion Double
    Ratio threshold for a single statistical object. Enabled only when StatisticalType=3 (repeat ratio). Value range: [0, 1).
    singleThreshold Integer
    Threshold for the number of times per statistical object. Used only when StatisticalType=1. Range 1~300000.
    statisticalDuration Integer
    Statistical time window, in seconds. Frequency limit scenario (StatisticalType=1): 5~1800; repeat statistics scenario (StatisticalType=2/3): 1~60.
    statisticalType String
    Statistical method. "1": access frequency; "2": repeat count; "3": repeat ratio.
    updateTime String
    Last update time of the rule.
    accurateGroup GetBotAnalyseProtectRuleAccurateGroup
    Advanced condition group. Do not include this field if not enabled or if the list is empty.
    actionAfterVerification number
    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.
    actionType 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.
    cronConfs GetBotAnalyseProtectRuleCronConf[]
    Periodic cycle configuration list. Supported only for frequency limit rules with StatisticalType=1. Threshold switching is specified by crontab.
    effectTime 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.
    exemptionTime 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.
    id string
    Uniquely identifies the resource.
    name string
    Rule name. Must start with Chinese/letter/number. Allows Chinese/letters/numbers/period (.)/underscore (_)/hyphen (-). Length 1~128 characters.
    passRatio 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.
    pathThreshold number
    Overall threshold for the current path. Effective only when StatisticalType=1. Range 1~300000.
    projectName string
    Project name, which is the project associated with the current resource. Only projects with permissions under the current identity can be associated.
    ruleId string
    Bot statistical protection rule ID.
    rulePriority number
    Rule priority under the same path and advanced condition. Range 0~9, with 0 being the highest priority.
    ruleTag string
    Rule display ID. Frequency limit rule prefix is R (e.g., R000000018673); repeated statistics rule prefix is S (e.g., S000000018674).
    singleProportion number
    Ratio threshold for a single statistical object. Enabled only when StatisticalType=3 (repeat ratio). Value range: [0, 1).
    singleThreshold number
    Threshold for the number of times per statistical object. Used only when StatisticalType=1. Range 1~300000.
    statisticalDuration number
    Statistical time window, in seconds. Frequency limit scenario (StatisticalType=1): 5~1800; repeat statistics scenario (StatisticalType=2/3): 1~60.
    statisticalType string
    Statistical method. "1": access frequency; "2": repeat count; "3": repeat ratio.
    updateTime string
    Last update time of the rule.
    accurate_group GetBotAnalyseProtectRuleAccurateGroup
    Advanced condition group. Do not include this field if not enabled or if the list is empty.
    action_after_verification int
    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[GetBotAnalyseProtectRuleCronConf]
    Periodic cycle configuration list. Supported only for frequency limit rules with StatisticalType=1. Threshold switching is specified by crontab.
    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.
    id str
    Uniquely identifies the resource.
    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.
    accurateGroup Property Map
    Advanced condition group. Do not include this field if not enabled or if the list is empty.
    actionAfterVerification Number
    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.
    actionType 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.
    cronConfs List<Property Map>
    Periodic cycle configuration list. Supported only for frequency limit rules with StatisticalType=1. Threshold switching is specified by crontab.
    effectTime 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.
    exemptionTime 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.
    id String
    Uniquely identifies the resource.
    name String
    Rule name. Must start with Chinese/letter/number. Allows Chinese/letters/numbers/period (.)/underscore (_)/hyphen (-). Length 1~128 characters.
    passRatio 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.
    pathThreshold Number
    Overall threshold for the current path. Effective only when StatisticalType=1. Range 1~300000.
    projectName String
    Project name, which is the project associated with the current resource. Only projects with permissions under the current identity can be associated.
    ruleId String
    Bot statistical protection rule ID.
    rulePriority Number
    Rule priority under the same path and advanced condition. Range 0~9, with 0 being the highest priority.
    ruleTag String
    Rule display ID. Frequency limit rule prefix is R (e.g., R000000018673); repeated statistics rule prefix is S (e.g., S000000018674).
    singleProportion Number
    Ratio threshold for a single statistical object. Enabled only when StatisticalType=3 (repeat ratio). Value range: [0, 1).
    singleThreshold Number
    Threshold for the number of times per statistical object. Used only when StatisticalType=1. Range 1~300000.
    statisticalDuration Number
    Statistical time window, in seconds. Frequency limit scenario (StatisticalType=1): 5~1800; repeat statistics scenario (StatisticalType=2/3): 1~60.
    statisticalType String
    Statistical method. "1": access frequency; "2": repeat count; "3": repeat ratio.
    updateTime String
    Last update time of the rule.

    Supporting Types

    GetBotAnalyseProtectRuleAccurateGroup

    AccurateGroupPriority int
    Priority of advanced condition group. Not required for create/update; used only for list display.
    AccurateRules List<Byteplus.GetBotAnalyseProtectRuleAccurateGroupAccurateRule>
    Sub-rule list in advanced conditions.
    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.
    AccurateGroupPriority int
    Priority of advanced condition group. Not required for create/update; used only for list display.
    AccurateRules []GetBotAnalyseProtectRuleAccurateGroupAccurateRule
    Sub-rule list in advanced conditions.
    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_priority number
    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.
    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.
    accurateGroupPriority Integer
    Priority of advanced condition group. Not required for create/update; used only for list display.
    accurateRules List<GetBotAnalyseProtectRuleAccurateGroupAccurateRule>
    Sub-rule list in advanced conditions.
    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.
    accurateGroupPriority number
    Priority of advanced condition group. Not required for create/update; used only for list display.
    accurateRules GetBotAnalyseProtectRuleAccurateGroupAccurateRule[]
    Sub-rule list in advanced conditions.
    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_priority int
    Priority of advanced condition group. Not required for create/update; used only for list display.
    accurate_rules Sequence[GetBotAnalyseProtectRuleAccurateGroupAccurateRule]
    Sub-rule list in advanced conditions.
    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.
    accurateGroupPriority Number
    Priority of advanced condition group. Not required for create/update; used only for list display.
    accurateRules List<Property Map>
    Sub-rule list in advanced conditions.
    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.

    GetBotAnalyseProtectRuleAccurateGroupAccurateRule

    HttpObj 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.
    ObjType 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.
    ValueString 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.
    HttpObj 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.
    ObjType 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.
    ValueString 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.
    httpObj 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.
    objType 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.
    valueString 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.
    httpObj 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.
    objType 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.
    valueString 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.
    httpObj 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.
    objType 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.
    valueString 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.

    GetBotAnalyseProtectRuleCronConf

    Crontab string
    crontab expression. Recommended format: * \n\n-\n\n * * \n\n, for example * 18-20 * * 1,2,3,4,5.
    PathThreshold int
    Total path threshold during the specified period. Value range: 1~300000.
    SingleThreshold 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.
    PathThreshold int
    Total path threshold during the specified period. Value range: 1~300000.
    SingleThreshold 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.
    pathThreshold Integer
    Total path threshold during the specified period. Value range: 1~300000.
    singleThreshold 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.
    pathThreshold number
    Total path threshold during the specified period. Value range: 1~300000.
    singleThreshold 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.
    pathThreshold Number
    Total path threshold during the specified period. Value range: 1~300000.
    singleThreshold Number
    Threshold for a single object during the specified period. Value range: 1~300000.

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo bytepluscc
    Viewing docs for bytepluscc v0.0.55
    published on Thursday, Oct 15, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial