Documentation | Tencent Cloud

search by keyword

Recent Pages

Documentation

CreateCCFrequencyRules

Last updated: 2020-07-31 10:09:12

1. API Description

Domain name for API request: dayu.tencentcloudapi.com.

This API is used to add an access frequency control rule for CC protection.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: CreateCCFrequencyRules.
Version	Yes	String	Common parameter. The value used for this API: 2018-07-09.
Region	No	String	Common parameter. This parameter is not required for this API.
Business	Yes	String	Anti-DDoS service type. `bgpip`: Anti-DDoS Advanced; `net`: Anti-DDoS Ultimate
Id	Yes	String	Anti-DDoS instance ID
RuleId	Yes	String	Layer-7 forwarding rule ID, which can be obtained through the `DescribleL7Rules` API
Mode	Yes	String	Matching rule. Valid values: ["include" (prefix match), "equal" (exact match)]
Period	Yes	Integer	Reference period in seconds. Valid values: [10, 30, 60]
ReqNumber	Yes	Integer	Number of access requests. Value range: [1-10000]
Act	Yes	String	Action take. Valid values: ["alg" (CAPTCHA), "drop" (blocking)]
ExeDuration	Yes	Integer	Execution duration in seconds. Valid range: [1-900]
Uri	No	String	URI string, which must start with `/`, such as `/abc/a.php`. Length limit: 31. If URI is `/`, only prefix match can be selected as the matching mode;
UserAgent	No	String	`User-Agent` string. Length limit: 80
Cookie	No	String	Cookie string. Length limit: 40

3. Output Parameters

Parameter Name	Type	Description
CCFrequencyRuleId	String	Access frequency control rule ID for CC protection
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Adding access frequency control rule for CC protection

This example shows you how to add an access frequency control rule for CC protection. To add a unified frequency control rule for all URIs under a forwarding rule, simply set Uri to /.

Input Example

https://dayu.tencentcloudapi.com/?Action=CreateCCFrequencyRules
&Business=bgpip
&Id=bgpip-000000xe
&RuleId=rule-00000001
&Uri=/
&Mode=include
&Period=60
&ReqNumber=30
&Act=alg
&ExeDuration=120
&<Common request parameters>

Output Example

{
  "Response": {
    "CCFrequencyRuleId": "ccRule-000003h7",
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.