getCcRule

bytepluscc v0.0.46, Aug 6 26

Viewing docs for bytepluscc v0.0.46
published on Thursday, Aug 6, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.46
published on Thursday, Aug 6, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Using getCcRule

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 getCcRule(args: GetCcRuleArgs, opts?: InvokeOptions): Promise<GetCcRuleResult>
function getCcRuleOutput(args: GetCcRuleOutputArgs, opts?: InvokeOptions): Output<GetCcRuleResult>

def get_cc_rule(id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetCcRuleResult
def get_cc_rule_output(id: pulumi.Input[Optional[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetCcRuleResult]

func LookupCcRule(ctx *Context, args *LookupCcRuleArgs, opts ...InvokeOption) (*LookupCcRuleResult, error)
func LookupCcRuleOutput(ctx *Context, args *LookupCcRuleOutputArgs, opts ...InvokeOption) LookupCcRuleResultOutput

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

public static class GetCcRule 
{
    public static Task<GetCcRuleResult> InvokeAsync(GetCcRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetCcRuleResult> Invoke(GetCcRuleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCcRuleResult> getCcRule(GetCcRuleArgs args, InvokeOptions options)
public static Output<GetCcRuleResult> getCcRule(GetCcRuleArgs args, InvokeOptions options)

fn::invoke:
  function: bytepluscc:waf/getCcRule:getCcRule
  arguments:
    # arguments dictionary

data "bytepluscc_waf_get_cc_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.

getCcRule Result

The following output properties are available:

AccurateGroup Byteplus.GetCcRuleAccurateGroup: Advanced condition group. The current path Url and AccurateGroup are in an AND relationship; the rule takes effect only when both are matched. Do not pass this field if not enabled or the list is empty.
CcType int: Action. 0: Observe; 1: Rate limit; 2: Block; 6: JS challenge; 7: CAPTCHA.
CountTime int: Statistical time window, unit: seconds. Range: 5–1800.
CronConfs List<Byteplus.GetCcRuleCronConf>: Scheduled activation configuration list. Required only when CronEnable=1.
CronEnable int: Scheduled activation switch. 0: Off (default); 1: On. If enabled, CronConfs must also be configured
CustomResponsePageId string: Custom response page ID. An empty string means not configured.
EffectTime int: Action duration. Unit: seconds. Range: 1–86400
Enable int: Rule switch. 0: Off; 1: On
ExemptionTime int: Exemption time for CAPTCHA or JS challenge. Unit: seconds. Range: 1–3600
Field string: Statistical object. Supports single or multiple fields, separated by commas. Up to 10 fields allowed. Basic format is DataType:Value, for example HEADER:Authorization, COOKIE:PHPSESSID, ARGS:device_id, CLIENTIP, JA3HASH, SESSION-ID, FP.
Host string: Domain name. The website domain to protect. Make sure the domain has been added to the current WAF instance before calling
Id string: Uniquely identifies the resource.
InsertTime string: Rule initial entry time.
Name string: Rule name. Must start with a Chinese character, letter, or number. Allows Chinese characters, letters, numbers, English period (.), underscore (_), and hyphen (-). Length: 1–128 characters.
PathThreshold int: Overall threshold for the current path. Range: 1–300000, unit: times
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: CC rule ID.
RulePriority int: Rule priority. Range: 0–9, where 0 is the highest priority
RuleTag string: Rule display ID. The RuleTag prefix for CC rules is always E, for example E000000003624
SingleThreshold int: Threshold for a single statistical object. Range: 1–300000, unit: times.
UpdateTime string: Last rule update time.
Url string: URL match path. Supports wildcards * and ?, where * matches zero or more characters and ? matches a single character. When AccurateGroup exists, Url and AccurateGroup are in an AND relationship.
WsCdnByteThreshold int: Websocket traffic threshold. Unit specified by WSCdnUnit. Required only when WSCdnEnable=1
WsCdnEnable int: Websocket traffic statistics switch. 0: Off (default); 1: On. If enabled, WSCdnByteThreshold/WSCdnFrameThreshold/WSCdnUnit must also be configured
WsCdnFrameThreshold int: Websocket connection frame threshold. Required only when WSCdnEnable=1.
WsCdnUnit string: Websocket traffic threshold unit. KB: kilobytes; MB: megabytes. Required only when WSCdnEnable=1

AccurateGroup GetCcRuleAccurateGroup: Advanced condition group. The current path Url and AccurateGroup are in an AND relationship; the rule takes effect only when both are matched. Do not pass this field if not enabled or the list is empty.
CcType int: Action. 0: Observe; 1: Rate limit; 2: Block; 6: JS challenge; 7: CAPTCHA.
CountTime int: Statistical time window, unit: seconds. Range: 5–1800.
CronConfs []GetCcRuleCronConf: Scheduled activation configuration list. Required only when CronEnable=1.
CronEnable int: Scheduled activation switch. 0: Off (default); 1: On. If enabled, CronConfs must also be configured
CustomResponsePageId string: Custom response page ID. An empty string means not configured.
EffectTime int: Action duration. Unit: seconds. Range: 1–86400
Enable int: Rule switch. 0: Off; 1: On
ExemptionTime int: Exemption time for CAPTCHA or JS challenge. Unit: seconds. Range: 1–3600
Field string: Statistical object. Supports single or multiple fields, separated by commas. Up to 10 fields allowed. Basic format is DataType:Value, for example HEADER:Authorization, COOKIE:PHPSESSID, ARGS:device_id, CLIENTIP, JA3HASH, SESSION-ID, FP.
Host string: Domain name. The website domain to protect. Make sure the domain has been added to the current WAF instance before calling
Id string: Uniquely identifies the resource.
InsertTime string: Rule initial entry time.
Name string: Rule name. Must start with a Chinese character, letter, or number. Allows Chinese characters, letters, numbers, English period (.), underscore (_), and hyphen (-). Length: 1–128 characters.
PathThreshold int: Overall threshold for the current path. Range: 1–300000, unit: times
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: CC rule ID.
RulePriority int: Rule priority. Range: 0–9, where 0 is the highest priority
RuleTag string: Rule display ID. The RuleTag prefix for CC rules is always E, for example E000000003624
SingleThreshold int: Threshold for a single statistical object. Range: 1–300000, unit: times.
UpdateTime string: Last rule update time.
Url string: URL match path. Supports wildcards * and ?, where * matches zero or more characters and ? matches a single character. When AccurateGroup exists, Url and AccurateGroup are in an AND relationship.
WsCdnByteThreshold int: Websocket traffic threshold. Unit specified by WSCdnUnit. Required only when WSCdnEnable=1
WsCdnEnable int: Websocket traffic statistics switch. 0: Off (default); 1: On. If enabled, WSCdnByteThreshold/WSCdnFrameThreshold/WSCdnUnit must also be configured
WsCdnFrameThreshold int: Websocket connection frame threshold. Required only when WSCdnEnable=1.
WsCdnUnit string: Websocket traffic threshold unit. KB: kilobytes; MB: megabytes. Required only when WSCdnEnable=1

accurate_group object: Advanced condition group. The current path Url and AccurateGroup are in an AND relationship; the rule takes effect only when both are matched. Do not pass this field if not enabled or the list is empty.
cc_type number: Action. 0: Observe; 1: Rate limit; 2: Block; 6: JS challenge; 7: CAPTCHA.
count_time number: Statistical time window, unit: seconds. Range: 5–1800.
cron_confs list(object): Scheduled activation configuration list. Required only when CronEnable=1.
cron_enable number: Scheduled activation switch. 0: Off (default); 1: On. If enabled, CronConfs must also be configured
custom_response_page_id string: Custom response page ID. An empty string means not configured.
effect_time number: Action duration. Unit: seconds. Range: 1–86400
enable number: Rule switch. 0: Off; 1: On
exemption_time number: Exemption time for CAPTCHA or JS challenge. Unit: seconds. Range: 1–3600
field string: Statistical object. Supports single or multiple fields, separated by commas. Up to 10 fields allowed. Basic format is DataType:Value, for example HEADER:Authorization, COOKIE:PHPSESSID, ARGS:device_id, CLIENTIP, JA3HASH, SESSION-ID, FP.
host string: Domain name. The website domain to protect. Make sure the domain has been added to the current WAF instance before calling
id string: Uniquely identifies the resource.
insert_time string: Rule initial entry time.
name string: Rule name. Must start with a Chinese character, letter, or number. Allows Chinese characters, letters, numbers, English period (.), underscore (_), and hyphen (-). Length: 1–128 characters.
path_threshold number: Overall threshold for the current path. Range: 1–300000, unit: times
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: CC rule ID.
rule_priority number: Rule priority. Range: 0–9, where 0 is the highest priority
rule_tag string: Rule display ID. The RuleTag prefix for CC rules is always E, for example E000000003624
single_threshold number: Threshold for a single statistical object. Range: 1–300000, unit: times.
update_time string: Last rule update time.
url string: URL match path. Supports wildcards * and ?, where * matches zero or more characters and ? matches a single character. When AccurateGroup exists, Url and AccurateGroup are in an AND relationship.
ws_cdn_byte_threshold number: Websocket traffic threshold. Unit specified by WSCdnUnit. Required only when WSCdnEnable=1
ws_cdn_enable number: Websocket traffic statistics switch. 0: Off (default); 1: On. If enabled, WSCdnByteThreshold/WSCdnFrameThreshold/WSCdnUnit must also be configured
ws_cdn_frame_threshold number: Websocket connection frame threshold. Required only when WSCdnEnable=1.
ws_cdn_unit string: Websocket traffic threshold unit. KB: kilobytes; MB: megabytes. Required only when WSCdnEnable=1

accurateGroup GetCcRuleAccurateGroup: Advanced condition group. The current path Url and AccurateGroup are in an AND relationship; the rule takes effect only when both are matched. Do not pass this field if not enabled or the list is empty.
ccType Integer: Action. 0: Observe; 1: Rate limit; 2: Block; 6: JS challenge; 7: CAPTCHA.
countTime Integer: Statistical time window, unit: seconds. Range: 5–1800.
cronConfs List<GetCcRuleCronConf>: Scheduled activation configuration list. Required only when CronEnable=1.
cronEnable Integer: Scheduled activation switch. 0: Off (default); 1: On. If enabled, CronConfs must also be configured
customResponsePageId String: Custom response page ID. An empty string means not configured.
effectTime Integer: Action duration. Unit: seconds. Range: 1–86400
enable Integer: Rule switch. 0: Off; 1: On
exemptionTime Integer: Exemption time for CAPTCHA or JS challenge. Unit: seconds. Range: 1–3600
field String: Statistical object. Supports single or multiple fields, separated by commas. Up to 10 fields allowed. Basic format is DataType:Value, for example HEADER:Authorization, COOKIE:PHPSESSID, ARGS:device_id, CLIENTIP, JA3HASH, SESSION-ID, FP.
host String: Domain name. The website domain to protect. Make sure the domain has been added to the current WAF instance before calling
id String: Uniquely identifies the resource.
insertTime String: Rule initial entry time.
name String: Rule name. Must start with a Chinese character, letter, or number. Allows Chinese characters, letters, numbers, English period (.), underscore (_), and hyphen (-). Length: 1–128 characters.
pathThreshold Integer: Overall threshold for the current path. Range: 1–300000, unit: times
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: CC rule ID.
rulePriority Integer: Rule priority. Range: 0–9, where 0 is the highest priority
ruleTag String: Rule display ID. The RuleTag prefix for CC rules is always E, for example E000000003624
singleThreshold Integer: Threshold for a single statistical object. Range: 1–300000, unit: times.
updateTime String: Last rule update time.
url String: URL match path. Supports wildcards * and ?, where * matches zero or more characters and ? matches a single character. When AccurateGroup exists, Url and AccurateGroup are in an AND relationship.
wsCdnByteThreshold Integer: Websocket traffic threshold. Unit specified by WSCdnUnit. Required only when WSCdnEnable=1
wsCdnEnable Integer: Websocket traffic statistics switch. 0: Off (default); 1: On. If enabled, WSCdnByteThreshold/WSCdnFrameThreshold/WSCdnUnit must also be configured
wsCdnFrameThreshold Integer: Websocket connection frame threshold. Required only when WSCdnEnable=1.
wsCdnUnit String: Websocket traffic threshold unit. KB: kilobytes; MB: megabytes. Required only when WSCdnEnable=1

accurateGroup GetCcRuleAccurateGroup: Advanced condition group. The current path Url and AccurateGroup are in an AND relationship; the rule takes effect only when both are matched. Do not pass this field if not enabled or the list is empty.
ccType number: Action. 0: Observe; 1: Rate limit; 2: Block; 6: JS challenge; 7: CAPTCHA.
countTime number: Statistical time window, unit: seconds. Range: 5–1800.
cronConfs GetCcRuleCronConf[]: Scheduled activation configuration list. Required only when CronEnable=1.
cronEnable number: Scheduled activation switch. 0: Off (default); 1: On. If enabled, CronConfs must also be configured
customResponsePageId string: Custom response page ID. An empty string means not configured.
effectTime number: Action duration. Unit: seconds. Range: 1–86400
enable number: Rule switch. 0: Off; 1: On
exemptionTime number: Exemption time for CAPTCHA or JS challenge. Unit: seconds. Range: 1–3600
field string: Statistical object. Supports single or multiple fields, separated by commas. Up to 10 fields allowed. Basic format is DataType:Value, for example HEADER:Authorization, COOKIE:PHPSESSID, ARGS:device_id, CLIENTIP, JA3HASH, SESSION-ID, FP.
host string: Domain name. The website domain to protect. Make sure the domain has been added to the current WAF instance before calling
id string: Uniquely identifies the resource.
insertTime string: Rule initial entry time.
name string: Rule name. Must start with a Chinese character, letter, or number. Allows Chinese characters, letters, numbers, English period (.), underscore (_), and hyphen (-). Length: 1–128 characters.
pathThreshold number: Overall threshold for the current path. Range: 1–300000, unit: times
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: CC rule ID.
rulePriority number: Rule priority. Range: 0–9, where 0 is the highest priority
ruleTag string: Rule display ID. The RuleTag prefix for CC rules is always E, for example E000000003624
singleThreshold number: Threshold for a single statistical object. Range: 1–300000, unit: times.
updateTime string: Last rule update time.
url string: URL match path. Supports wildcards * and ?, where * matches zero or more characters and ? matches a single character. When AccurateGroup exists, Url and AccurateGroup are in an AND relationship.
wsCdnByteThreshold number: Websocket traffic threshold. Unit specified by WSCdnUnit. Required only when WSCdnEnable=1
wsCdnEnable number: Websocket traffic statistics switch. 0: Off (default); 1: On. If enabled, WSCdnByteThreshold/WSCdnFrameThreshold/WSCdnUnit must also be configured
wsCdnFrameThreshold number: Websocket connection frame threshold. Required only when WSCdnEnable=1.
wsCdnUnit string: Websocket traffic threshold unit. KB: kilobytes; MB: megabytes. Required only when WSCdnEnable=1

accurate_group GetCcRuleAccurateGroup: Advanced condition group. The current path Url and AccurateGroup are in an AND relationship; the rule takes effect only when both are matched. Do not pass this field if not enabled or the list is empty.
cc_type int: Action. 0: Observe; 1: Rate limit; 2: Block; 6: JS challenge; 7: CAPTCHA.
count_time int: Statistical time window, unit: seconds. Range: 5–1800.
cron_confs Sequence[GetCcRuleCronConf]: Scheduled activation configuration list. Required only when CronEnable=1.
cron_enable int: Scheduled activation switch. 0: Off (default); 1: On. If enabled, CronConfs must also be configured
custom_response_page_id str: Custom response page ID. An empty string means not configured.
effect_time int: Action duration. Unit: seconds. Range: 1–86400
enable int: Rule switch. 0: Off; 1: On
exemption_time int: Exemption time for CAPTCHA or JS challenge. Unit: seconds. Range: 1–3600
field str: Statistical object. Supports single or multiple fields, separated by commas. Up to 10 fields allowed. Basic format is DataType:Value, for example HEADER:Authorization, COOKIE:PHPSESSID, ARGS:device_id, CLIENTIP, JA3HASH, SESSION-ID, FP.
host str: Domain name. The website domain to protect. Make sure the domain has been added to the current WAF instance before calling
id str: Uniquely identifies the resource.
insert_time str: Rule initial entry time.
name str: Rule name. Must start with a Chinese character, letter, or number. Allows Chinese characters, letters, numbers, English period (.), underscore (_), and hyphen (-). Length: 1–128 characters.
path_threshold int: Overall threshold for the current path. Range: 1–300000, unit: times
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: CC rule ID.
rule_priority int: Rule priority. Range: 0–9, where 0 is the highest priority
rule_tag str: Rule display ID. The RuleTag prefix for CC rules is always E, for example E000000003624
single_threshold int: Threshold for a single statistical object. Range: 1–300000, unit: times.
update_time str: Last rule update time.
url str: URL match path. Supports wildcards * and ?, where * matches zero or more characters and ? matches a single character. When AccurateGroup exists, Url and AccurateGroup are in an AND relationship.
ws_cdn_byte_threshold int: Websocket traffic threshold. Unit specified by WSCdnUnit. Required only when WSCdnEnable=1
ws_cdn_enable int: Websocket traffic statistics switch. 0: Off (default); 1: On. If enabled, WSCdnByteThreshold/WSCdnFrameThreshold/WSCdnUnit must also be configured
ws_cdn_frame_threshold int: Websocket connection frame threshold. Required only when WSCdnEnable=1.
ws_cdn_unit str: Websocket traffic threshold unit. KB: kilobytes; MB: megabytes. Required only when WSCdnEnable=1

accurateGroup Property Map: Advanced condition group. The current path Url and AccurateGroup are in an AND relationship; the rule takes effect only when both are matched. Do not pass this field if not enabled or the list is empty.
ccType Number: Action. 0: Observe; 1: Rate limit; 2: Block; 6: JS challenge; 7: CAPTCHA.
countTime Number: Statistical time window, unit: seconds. Range: 5–1800.
cronConfs List<Property Map>: Scheduled activation configuration list. Required only when CronEnable=1.
cronEnable Number: Scheduled activation switch. 0: Off (default); 1: On. If enabled, CronConfs must also be configured
customResponsePageId String: Custom response page ID. An empty string means not configured.
effectTime Number: Action duration. Unit: seconds. Range: 1–86400
enable Number: Rule switch. 0: Off; 1: On
exemptionTime Number: Exemption time for CAPTCHA or JS challenge. Unit: seconds. Range: 1–3600
field String: Statistical object. Supports single or multiple fields, separated by commas. Up to 10 fields allowed. Basic format is DataType:Value, for example HEADER:Authorization, COOKIE:PHPSESSID, ARGS:device_id, CLIENTIP, JA3HASH, SESSION-ID, FP.
host String: Domain name. The website domain to protect. Make sure the domain has been added to the current WAF instance before calling
id String: Uniquely identifies the resource.
insertTime String: Rule initial entry time.
name String: Rule name. Must start with a Chinese character, letter, or number. Allows Chinese characters, letters, numbers, English period (.), underscore (_), and hyphen (-). Length: 1–128 characters.
pathThreshold Number: Overall threshold for the current path. Range: 1–300000, unit: times
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: CC rule ID.
rulePriority Number: Rule priority. Range: 0–9, where 0 is the highest priority
ruleTag String: Rule display ID. The RuleTag prefix for CC rules is always E, for example E000000003624
singleThreshold Number: Threshold for a single statistical object. Range: 1–300000, unit: times.
updateTime String: Last rule update time.
url String: URL match path. Supports wildcards * and ?, where * matches zero or more characters and ? matches a single character. When AccurateGroup exists, Url and AccurateGroup are in an AND relationship.
wsCdnByteThreshold Number: Websocket traffic threshold. Unit specified by WSCdnUnit. Required only when WSCdnEnable=1
wsCdnEnable Number: Websocket traffic statistics switch. 0: Off (default); 1: On. If enabled, WSCdnByteThreshold/WSCdnFrameThreshold/WSCdnUnit must also be configured
wsCdnFrameThreshold Number: Websocket connection frame threshold. Required only when WSCdnEnable=1.
wsCdnUnit String: Websocket traffic threshold unit. KB: kilobytes; MB: megabytes. Required only when WSCdnEnable=1

Supporting Types

GetCcRuleAccurateGroup

AccurateGroupPriority int: Advanced condition group priority. Not required when creating/updating, used only for list display.
AccurateRules List<Byteplus.GetCcRuleAccurateGroupAccurateRule>: List of subrules in advanced conditions
Id int: Advanced condition group ID. Not required for create/update; used only for list display
Logic int: Logical relationship. 1: AND; 2: OR.

AccurateGroupPriority int: Advanced condition group priority. Not required when creating/updating, used only for list display.
AccurateRules []GetCcRuleAccurateGroupAccurateRule: List of subrules in advanced conditions
Id int: Advanced condition group ID. Not required for create/update; used only for list display
Logic int: Logical relationship. 1: AND; 2: OR.

accurate_group_priority number: Advanced condition group priority. Not required when creating/updating, used only for list display.
accurate_rules list(object): List of subrules in advanced conditions
id number: Advanced condition group ID. Not required for create/update; used only for list display
logic number: Logical relationship. 1: AND; 2: OR.

accurateGroupPriority Integer: Advanced condition group priority. Not required when creating/updating, used only for list display.
accurateRules List<GetCcRuleAccurateGroupAccurateRule>: List of subrules in advanced conditions
id Integer: Advanced condition group ID. Not required for create/update; used only for list display
logic Integer: Logical relationship. 1: AND; 2: OR.

accurateGroupPriority number: Advanced condition group priority. Not required when creating/updating, used only for list display.
accurateRules GetCcRuleAccurateGroupAccurateRule[]: List of subrules in advanced conditions
id number: Advanced condition group ID. Not required for create/update; used only for list display
logic number: Logical relationship. 1: AND; 2: OR.

accurate_group_priority int: Advanced condition group priority. Not required when creating/updating, used only for list display.
accurate_rules Sequence[GetCcRuleAccurateGroupAccurateRule]: List of subrules in advanced conditions
id int: Advanced condition group ID. Not required for create/update; used only for list display
logic int: Logical relationship. 1: AND; 2: OR.

accurateGroupPriority Number: Advanced condition group priority. Not required when creating/updating, used only for list display.
accurateRules List<Property Map>: List of subrules in advanced conditions
id Number: Advanced condition group ID. Not required for create/update; used only for list display
logic Number: Logical relationship. 1: AND; 2: OR.

GetCcRuleAccurateGroupAccurateRule

HttpObj string: Match object. Fixed objects are automatically generated as HttpObj by ObjType; custom objects require a specific Key in HttpObj. For example: request.header.clientip, request.uri, request.queryargs.abc, request.header.custom-header, request.cookie.custom-cookie, etc
ObjType int: Match object type enumeration. 0: Request protocol; 1: Request URI; 2: Request method; 3: Request path; 4: Request parameters; 5: Request headers; 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: Match operator enumeration. 0–5: size comparison; 6–11: substring match; 12–15: set match; 16: regex; 17–21: IP identification (only request.header.clientip or custom objects); 23/24: include/exclude address group; 25/26: include/exclude 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 (only used when Opretar=17–21); 6: Country.
ValueString string: Match value. For Opretar=17–21 (IP identification), no match content is involved and can be an empty string; for Opretar=23–29, fill in according to the required format (IP address group ID/location code/IP intelligence tag/ASN); for other operators, enter the actual match value

HttpObj string: Match object. Fixed objects are automatically generated as HttpObj by ObjType; custom objects require a specific Key in HttpObj. For example: request.header.clientip, request.uri, request.queryargs.abc, request.header.custom-header, request.cookie.custom-cookie, etc
ObjType int: Match object type enumeration. 0: Request protocol; 1: Request URI; 2: Request method; 3: Request path; 4: Request parameters; 5: Request headers; 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: Match operator enumeration. 0–5: size comparison; 6–11: substring match; 12–15: set match; 16: regex; 17–21: IP identification (only request.header.clientip or custom objects); 23/24: include/exclude address group; 25/26: include/exclude 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 (only used when Opretar=17–21); 6: Country.
ValueString string: Match value. For Opretar=17–21 (IP identification), no match content is involved and can be an empty string; for Opretar=23–29, fill in according to the required format (IP address group ID/location code/IP intelligence tag/ASN); for other operators, enter the actual match value

http_obj string: Match object. Fixed objects are automatically generated as HttpObj by ObjType; custom objects require a specific Key in HttpObj. For example: request.header.clientip, request.uri, request.queryargs.abc, request.header.custom-header, request.cookie.custom-cookie, etc
obj_type number: Match object type enumeration. 0: Request protocol; 1: Request URI; 2: Request method; 3: Request path; 4: Request parameters; 5: Request headers; 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: Match operator enumeration. 0–5: size comparison; 6–11: substring match; 12–15: set match; 16: regex; 17–21: IP identification (only request.header.clientip or custom objects); 23/24: include/exclude address group; 25/26: include/exclude 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 (only used when Opretar=17–21); 6: Country.
value_string string: Match value. For Opretar=17–21 (IP identification), no match content is involved and can be an empty string; for Opretar=23–29, fill in according to the required format (IP address group ID/location code/IP intelligence tag/ASN); for other operators, enter the actual match value

httpObj String: Match object. Fixed objects are automatically generated as HttpObj by ObjType; custom objects require a specific Key in HttpObj. For example: request.header.clientip, request.uri, request.queryargs.abc, request.header.custom-header, request.cookie.custom-cookie, etc
objType Integer: Match object type enumeration. 0: Request protocol; 1: Request URI; 2: Request method; 3: Request path; 4: Request parameters; 5: Request headers; 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: Match operator enumeration. 0–5: size comparison; 6–11: substring match; 12–15: set match; 16: regex; 17–21: IP identification (only request.header.clientip or custom objects); 23/24: include/exclude address group; 25/26: include/exclude 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 (only used when Opretar=17–21); 6: Country.
valueString String: Match value. For Opretar=17–21 (IP identification), no match content is involved and can be an empty string; for Opretar=23–29, fill in according to the required format (IP address group ID/location code/IP intelligence tag/ASN); for other operators, enter the actual match value

httpObj string: Match object. Fixed objects are automatically generated as HttpObj by ObjType; custom objects require a specific Key in HttpObj. For example: request.header.clientip, request.uri, request.queryargs.abc, request.header.custom-header, request.cookie.custom-cookie, etc
objType number: Match object type enumeration. 0: Request protocol; 1: Request URI; 2: Request method; 3: Request path; 4: Request parameters; 5: Request headers; 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: Match operator enumeration. 0–5: size comparison; 6–11: substring match; 12–15: set match; 16: regex; 17–21: IP identification (only request.header.clientip or custom objects); 23/24: include/exclude address group; 25/26: include/exclude 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 (only used when Opretar=17–21); 6: Country.
valueString string: Match value. For Opretar=17–21 (IP identification), no match content is involved and can be an empty string; for Opretar=23–29, fill in according to the required format (IP address group ID/location code/IP intelligence tag/ASN); for other operators, enter the actual match value

http_obj str: Match object. Fixed objects are automatically generated as HttpObj by ObjType; custom objects require a specific Key in HttpObj. For example: request.header.clientip, request.uri, request.queryargs.abc, request.header.custom-header, request.cookie.custom-cookie, etc
obj_type int: Match object type enumeration. 0: Request protocol; 1: Request URI; 2: Request method; 3: Request path; 4: Request parameters; 5: Request headers; 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: Match operator enumeration. 0–5: size comparison; 6–11: substring match; 12–15: set match; 16: regex; 17–21: IP identification (only request.header.clientip or custom objects); 23/24: include/exclude address group; 25/26: include/exclude 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 (only used when Opretar=17–21); 6: Country.
value_string str: Match value. For Opretar=17–21 (IP identification), no match content is involved and can be an empty string; for Opretar=23–29, fill in according to the required format (IP address group ID/location code/IP intelligence tag/ASN); for other operators, enter the actual match value

httpObj String: Match object. Fixed objects are automatically generated as HttpObj by ObjType; custom objects require a specific Key in HttpObj. For example: request.header.clientip, request.uri, request.queryargs.abc, request.header.custom-header, request.cookie.custom-cookie, etc
objType Number: Match object type enumeration. 0: Request protocol; 1: Request URI; 2: Request method; 3: Request path; 4: Request parameters; 5: Request headers; 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: Match operator enumeration. 0–5: size comparison; 6–11: substring match; 12–15: set match; 16: regex; 17–21: IP identification (only request.header.clientip or custom objects); 23/24: include/exclude address group; 25/26: include/exclude 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 (only used when Opretar=17–21); 6: Country.
valueString String: Match value. For Opretar=17–21 (IP identification), no match content is involved and can be an empty string; for Opretar=23–29, fill in according to the required format (IP address group ID/location code/IP intelligence tag/ASN); for other operators, enter the actual match value

GetCcRuleCronConf

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. Range: 1–300000
SingleThreshold int: Threshold for a single object during this time period. 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. Range: 1–300000
SingleThreshold int: Threshold for a single object during this time period. 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. Range: 1–300000
single_threshold number: Threshold for a single object during this time period. 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. Range: 1–300000
singleThreshold Integer: Threshold for a single object during this time period. 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. Range: 1–300000
singleThreshold number: Threshold for a single object during this time period. 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. Range: 1–300000
single_threshold int: Threshold for a single object during this time period. 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. Range: 1–300000
singleThreshold Number: Threshold for a single object during this time period. 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.

Viewing docs for bytepluscc v0.0.46
published on Thursday, Aug 6, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

bytepluscc.waf.getCcRule

On this page

On this page

Using getCcRule

getCcRule Result

Supporting Types

GetCcRuleAccurateGroup

GetCcRuleAccurateGroupAccurateRule

GetCcRuleCronConf

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

bytepluscc.waf.getCcRule

On this page

On this page

Using getCcRule

getCcRule Result

Supporting Types

GetCcRuleAccurateGroup

GetCcRuleAccurateGroupAccurateRule

GetCcRuleCronConf

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.