1. API Description
Domain name for API request: waf.intl.tencentcloudapi.com.
Enable or disable access control (from custom policy)
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.
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: ModifyCustomRuleStatus. |
| 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 |
Domain name |
| RuleId |
Yes |
Integer |
Rule ID |
| Status |
Yes |
Integer |
Status of the switch: 1 is On, 0 is Off |
| Edition |
No |
String |
Version of WAF. clb-waf indicates CLB WAF; sparta-waf indicates SaaS WAF. sparta-waf by default. |
| DomainRuleIdList.N |
No |
Array of DomainRuleId |
Rule ID |
3. Output Parameters
| 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. |
4. Example
Example1 Switching the Custom Rule
This example shows you how to switch the custom rule.
https:
&Domain="test.qlcoud.com"
&RuleId=12
&Status=0
&<Common request parameters>
Output Example
{
"Response": {
"RequestId": "1c30f037-a684-4d5b-b0a8-0bc0acc668d1",
"Success": {
"Message": "Success",
"Code": "Success"
}
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
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 |
| UnsupportedOperation |
The operation is not supported. |