tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateIpAccessControl

Last updated: 2024-10-10 10:37:08

1. API Description

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

This API is used to add WAF IP allowlists/blocklists.

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: CreateIpAccessControl.
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, ap-singapore.
Domain Yes String Specific domain name, for example, test.qcloudwaf.com.
Global domain name, that is, global.
IpList.N Yes Array of String IP parameter list.
ActionType Yes Integer 42: blocklist; 40: allowlist.
ValidTS Yes Integer valid_ts indicates a valid date. Its value is a second-level timestamp, such as 1680570420, which indicates 2023-04-04 09:07:00.
InstanceId No String Instance ID
Edition No String WAF instance type: sparta-waf for SaaS WAF, clb-waf for CLB WAF.
SourceType No String Valid values: batch (adding in batches), bot (adding to the bot details list in bot traffic analysis), cc (adding to IP addresses of the CC attack type in the attack log list), custom (default value for adding not in batches).
Note No String Remarks
JobType No String Scheduled configuration type.
JobDateTime No JobDateTime Details of scheduled configuration.

3. Output Parameters

Parameter Name Type Description
RuleId Integer ID of the new rule.

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 Adding an IP Blocklist/Allowlist

Input Example

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



{
    "InstanceId": "waf_0xabc",
    "Domain": "www.qcloudwaf.com",
    "IpList": [
        "192.168.1.1",
        "192.168.2.1"
    ],
    "Edition": "abc",
    "ValidTS": 1680570420,
    "ActionType": 42,
    "SourceType": "abc"
}

Output Example

{
    "Response": {
        "RuleId": 55201922,
        "RequestId": "abc"
    }
}

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
FailedOperation.TheNumberOfAddedBlackAndWhiteListExceedsTheUpperLimit The number of additions to the blocklist/allowlist exceeds the limit.
InternalError Internal error.
InternalError.DBErr DBErr
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