- Release Notes and Announcements
- Product Introduction
- Comparison of Anti-DDoS Solutions
- Purchase Guide
- Getting Started
- Operation Guide
- Practical Tutorial
- Remote Protection Scheme with Anti-DDoS Pro
- Using Anti-DDoS Pro Together with WFA
- Suggestions on Stress Tests
- Solutions to Real Server IP Exposure
- Creating an Anti-DDoS EIP
- Configuration Directions and Notes on CC Protection Policies
- Syncing Forwarding Rules to New Anti-DDoS Advanced Instances
- Smart Scheduling of CTCC/CUCC/CMCC Traffic
- Troubleshooting
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Anti-DDoS Advanced Instance APIs
- Resource List APIs
- Protection Configuration APIs
- CreateBlackWhiteIpList
- CreateCcBlackWhiteIpList
- CreateCcGeoIPBlockConfig
- CreateDDoSAI
- CreateDDoSGeoIPBlockConfig
- CreateDDoSSpeedLimitConfig
- CreatePacketFilterConfig
- CreateProtocolBlockConfig
- CreateWaterPrintConfig
- CreateWaterPrintKey
- DeleteCcBlackWhiteIpList
- DeleteCcGeoIPBlockConfig
- DeleteDDoSGeoIPBlockConfig
- DeleteDDoSSpeedLimitConfig
- DeletePacketFilterConfig
- DeleteWaterPrintConfig
- DeleteWaterPrintKey
- DescribeCcBlackWhiteIpList
- DescribeCcGeoIPBlockConfigList
- DescribeListBlackWhiteIpList
- DescribeListDDoSAI
- DescribeListDDoSGeoIPBlockConfig
- DescribeListDDoSSpeedLimitConfig
- DescribeListPacketFilterConfig
- DescribeListProtocolBlockConfig
- DescribeListWaterPrintConfig
- ModifyCcBlackWhiteIpList
- ModifyDDoSGeoIPBlockConfig
- ModifyDDoSSpeedLimitConfig
- ModifyPacketFilterConfig
- SwitchWaterPrintConfig
- Other APIs
- Alarm Notification APIs
- Connection Configuration APIs
- Intelligent Scheduling APIs
- Black hole unblocking APIs
- Statistical Report APIs
- Data Types
- Error Codes
- FAQs
- Service Level Agreement
- Product Policy
- Glossary
- Release Notes and Announcements
- Product Introduction
- Comparison of Anti-DDoS Solutions
- Purchase Guide
- Getting Started
- Operation Guide
- Practical Tutorial
- Remote Protection Scheme with Anti-DDoS Pro
- Using Anti-DDoS Pro Together with WFA
- Suggestions on Stress Tests
- Solutions to Real Server IP Exposure
- Creating an Anti-DDoS EIP
- Configuration Directions and Notes on CC Protection Policies
- Syncing Forwarding Rules to New Anti-DDoS Advanced Instances
- Smart Scheduling of CTCC/CUCC/CMCC Traffic
- Troubleshooting
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Anti-DDoS Advanced Instance APIs
- Resource List APIs
- Protection Configuration APIs
- CreateBlackWhiteIpList
- CreateCcBlackWhiteIpList
- CreateCcGeoIPBlockConfig
- CreateDDoSAI
- CreateDDoSGeoIPBlockConfig
- CreateDDoSSpeedLimitConfig
- CreatePacketFilterConfig
- CreateProtocolBlockConfig
- CreateWaterPrintConfig
- CreateWaterPrintKey
- DeleteCcBlackWhiteIpList
- DeleteCcGeoIPBlockConfig
- DeleteDDoSGeoIPBlockConfig
- DeleteDDoSSpeedLimitConfig
- DeletePacketFilterConfig
- DeleteWaterPrintConfig
- DeleteWaterPrintKey
- DescribeCcBlackWhiteIpList
- DescribeCcGeoIPBlockConfigList
- DescribeListBlackWhiteIpList
- DescribeListDDoSAI
- DescribeListDDoSGeoIPBlockConfig
- DescribeListDDoSSpeedLimitConfig
- DescribeListPacketFilterConfig
- DescribeListProtocolBlockConfig
- DescribeListWaterPrintConfig
- ModifyCcBlackWhiteIpList
- ModifyDDoSGeoIPBlockConfig
- ModifyDDoSSpeedLimitConfig
- ModifyPacketFilterConfig
- SwitchWaterPrintConfig
- Other APIs
- Alarm Notification APIs
- Connection Configuration APIs
- Intelligent Scheduling APIs
- Black hole unblocking APIs
- Statistical Report APIs
- Data Types
- Error Codes
- FAQs
- Service Level Agreement
- Product Policy
- Glossary
1. API Description
Domain name for API request: antiddos.tencentcloudapi.com.
This API is used to add an Anti-DDoS IP blocklist/allowlist.
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: CreateBlackWhiteIpList. |
| Version | Yes | String | Common Params. The value used for this API: 2020-03-09. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| InstanceId | Yes | String | Anti-DDoS instance ID |
| IpList.N | Yes | Array of String | List of IPs |
| Type | Yes | String | IP type. Valid values: black (blocklisted IP), white(allowlisted IP). |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| 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 Anti-DDoS IP blocklist/allowlist
Input Example
https://antiddos.tencentcloudapi.com/?Action=CreateBlackWhiteIpList
&InstanceId=bgpip-00001001
&IpList.0=1.1.1.1
&Type=black
&<Common request parameters>
Output Example
{
"Response": {
"RequestId": "b7739a1e-837d-4248-bf9f-16a9bf77db22"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| LimitExceeded | The quota limit should not be exceeded. |
| ResourceNotFound | The resource does not exist. Please try again later. |
| UnsupportedOperation | Unsupported operation. |
Yes
No
Was this page helpful?