tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateBanWhiteList

Last updated: 2024-12-06 15:39:59

1. API Description

Domain name for API request: cwp.intl.tencentcloudapi.com.

This API is used to add the list of block allowlists.

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: CreateBanWhiteList.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
Rules Yes BanWhiteList Block rules
EventId No Integer Event list ID, which is passed when the event list is allowlisted. After it is successfully allowlisted, the events in the list will be marked as whitelisted.

3. Output Parameters

Parameter Name Type Description
IsGlobal Boolean Whether a global rule
IsDuplicate Boolean Whether the addition of a rule would result in a duplicate
DuplicateHosts Array of DuplicateHosts Information on duplicate machines
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 a Blocking Allowlist

Input Example

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

{
    "Rules": {
        "Remark": "xx",
        "Uuid": "xx",
        "IsGlobal": true,
        "Id": "xx",
        "ModifyTime": "2020-09-22 00:00:00",
        "SrcIp": "xx",
        "CreateTime": "2020-09-22 00:00:00",
        "Quuids": [
            "xx"
        ]
    }
}

Output Example

{
    "Response": {
        "IsDuplicate": true,
        "IsGlobal": false,
        "DuplicateHosts": [
            {
                "Quuid": "05f0bcab-726c-4ea4-8109-bcd03d5598f7",
                "Uuid": "05f0bcab-726c-4ea4-8109-bcd03d5598f7",
                "Id": 1
            }
        ],
        "RequestId": "be6f6eec-0825-4e67-ab9a-c8568bbf736c"
    }
}

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
InvalidParameter Incorrect parameter.
InvalidParameter.IllegalRequest Invalid request.
InvalidParameter.InvalidFormat Incorrect parameter format.
InvalidParameter.IpNoValid The IP format is invalid.
InvalidParameter.MissingParameter Missing parameter.
InvalidParameter.ParsingError Incorrect parameter parsing.
InvalidParameterValue Invalid parameter value.
MissingParameter Missing parameter error.
ResourceNotFound The resource does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy