tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

AddCustomWhiteRule

Last updated: 2024-10-10 10:36:58

1. API Description

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

Add precision allowlist rules

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 Params. The value used for this API: AddCustomWhiteRule.
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
ExpireTime Yes String Expiration time
Strategies.N Yes Array of Strategy Policy details
Domain Yes String Domain name for adding policy
Bypass Yes String Details of release
JobType No String Scheduled task type
JobDateTime No JobDateTime Scheduled task configuration

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.
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.

4. Example

Example1 Add precision allowlist rules

Input Example

POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddCustomWhiteRule
<Common request parameters>



{
    "Name": "test",
    "SortId": "100",
    "ExpireTime": "",
    "Domain": "waf.tencentcloudapi.com",
    "Bypass": "",
    "Strategies": [
        {
            "Field": "COOKIE",
            "CompareFunc": "eq",
            "Content": "abc",
            "Arg": ""
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "5d207f4f-0d41-4f5d-bce2-0320090c98d8",
        "RuleId": 7025,
        "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
InvalidParameter Parameter error.
InvalidParameterValue Invalid parameter value.
LimitExceeded The quota limit is exceeded.
LimitExceeded.SpecificationErr SpecificationErr
UnsupportedOperation The operation is not supported.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy