Domain name for API request: waf.tencentcloudapi.com.
This API is used to edit a precise allowlist.
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: ModifyCustomWhiteRule. |
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. |
Domain | Yes | String | Edited domain |
RuleId | Yes | Integer | Edited rule ID |
RuleName | Yes | String | Edited rule name |
Bypass | Yes | String | Whether to continue executing other check logics when bypassing, continue executing regional ban protection - geoip; continue executing CC policy protection - cc; continue executing WEB application protection: owasp; continue executing AI engine protection - ai; continue executing information leakage protection - antileakage. If multiple items are selected, concatenate with commas (,). |
SortId | Yes | Integer | Priority, an integer from 1 to 100. The smaller the number, the higher the execution priority of this rule. |
ExpireTime | Yes | Integer | Rule expiration deadline: 0 - permanently effective; other values correspond to the timestamp of the specified time. |
Strategies.N | Yes | Array of Strategy | Matching condition array |
JobType | No | String | Scheduled task type |
JobDateTime | No | JobDateTime | Scheduled task configuration |
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. |
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. |
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyCustomWhiteRule
<Common request parameters>
{
"RuleId": 1100000001,
"Domain": "waf.tencentcloudapi.com",
"RuleName": "test",
"Bypass": "cc",
"SortId": 100,
"ExpireTime": 123456,
"Strategies": [
{
"Field": "COOKIE",
"CompareFunc": "eq",
"Content": "abc",
"Arg": ""
}
]
}
{
"Response": {
"RequestId": "5d207f4f-0d41-4f5d-bce2-0320090c98d8",
"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 |
InvalidParameter | Parameter error. |
UnsupportedOperation | The operation is not supported. |
Was this page helpful?