Domain name for API request: waf.tencentcloudapi.com.
Add access control (from custom policy)
A maximum of 20 requests can be initiated per second for this API.
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 Params. The value used for this API: AddCustomRule. |
Version | Yes | String | Common Params. The value used for this API: 2018-01-25. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-seoul. |
Name | Yes | String | Rule name |
SortId | Yes | String | Priority |
Strategies.N | Yes | Array of Strategy | Policy details |
Domain | Yes | String | Domain name for adding policy |
ActionType | Yes | String | Action type: 1 for Block, 2 captcha, 3 for Observe, 4 for Redirect |
Redirect | No | String | If the action is redirect, it indicates the redirect address; otherwise, it can be left blank. |
ExpireTime | No | String | Expiration time: in second-level timestamp, for example, 1677254399 indicates the expiration time is 2023-02-24 23:59:59; 0 indicates it will never expire. |
Edition | No | String | WAF instance type: sparta-waf for SaaS WAF, clb-waf for CLB WAF. |
Bypass | No | String | Details of release |
EventId | No | String | Source of the rule addition, default is empty |
JobType | No | String | Rule execution mode: TimedJob indicates scheduled execution. CronJob indicates periodic execution. |
JobDateTime | No | JobDateTime | Rule execution time |
Source | No | String | Rule source. You can determine whether a rule comes from a mini program. |
Label | No | String | Rule tag. It is used for mini program rules and identifies whether a rule is a built-in rule or a custom rule. |
Status | No | Integer | Switch status. This value is passed when mini program risk control rules are used. |
PageId | No | String | Interception page ID |
Parameter Name | Type | Description |
---|---|---|
Success | ResponseCode | Operation status code: if all resource operations succeed, the success status code is returned; if any resource operation fails, the content of Message needs to be parsed to see which resource failed. |
RuleId | Integer | Successfully added rule ID Note: This field may return null, indicating that no valid values can be obtained. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Add access control (from custom policy)
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddCustomRule
<Common request parameters>
{
"Redirect": "/",
"Domain": "www.test.com",
"Name": "test",
"SortId": "100",
"ExpireTime": "\"\"",
"Edition": "clb-waf",
"ActionType": "1",
"Strategies": [
{
"Content": "\"\"",
"Field": "COOKIE",
"CompareFunc": "null",
"Arg": "\"\""
}
]
}
{
"Response": {
"RequestId": "1a16a333-76ac-42f5-8066-c0ea93cc8dc7",
"RuleId": 7025,
"Success": {
"Message": "Success",
"Code": "Success"
}
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalError | Internal error. |
InternalError.DBErr | DBErr |
LimitExceeded | The quota limit is exceeded. |
LimitExceeded.SpecificationErr | SpecificationErr |
UnsupportedOperation | The operation is not supported. |
Was this page helpful?