1. API Description
Domain name for API request: antiddos.intl.tencentcloudapi.com.
This API is used to get a list of Anti-DDoS feature filtering 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.
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: DescribeListPacketFilterConfig. |
| 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. |
| Offset |
Yes |
Integer |
Starting offset of the page. Value: (number of pages – 1) * items per page. |
| Limit |
Yes |
Integer |
Number of items per page. The default value is 20 when Limit = 0. The maximum value is 100. |
| FilterInstanceId |
Yes |
String |
Anti-DDoS instance ID filter. Anti-DDoS instance prefix wildcard search is supported. For example, you can filter Anti-DDoS Pro instances by bgp-*. |
| FilterIp |
No |
String |
IP filter |
3. Output Parameters
| Parameter Name |
Type |
Description |
| Total |
Integer |
Total number of lists |
| ConfigList |
Array of PacketFilterRelation |
Feature filtering configuration |
| 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 Getting a list of Anti-DDoS feature filtering rules
POST / HTTP/1.1
Host: antiddos.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeListPacketFilterConfig
<Common request parameters>
{
"FilterInstanceId": "bgpip-0000011x",
"FilterIp": "1.1.1.1",
"Limit": "25",
"Offset": "0"
}
Output Example
{
"Response": {
"Total": 1,
"ConfigList": [
{
"InstanceDetailList": [
{
"InstanceId": "bgpip-0000011x",
"EipList": [
"1.1.1.1"
]
}
],
"PacketFilterConfig": {
"MatchType2": "sunday",
"MatchBegin2": "begin-l5",
"Str2": "",
"SportEnd": 0,
"IsNot": 0,
"PktlenMax": 1500,
"MatchLogic": "none",
"MatchBegin": "begin-l5",
"Offset": 0,
"SportStart": 0,
"DportStart": 0,
"PktlenMin": 0,
"IsNot2": 0,
"Depth": 20,
"Str": "",
"Action": "drop",
"Protocol": "tcp",
"MatchType": "sunday",
"DportEnd": 0,
"Offset2": 5,
"Depth2": 20,
"Id": ""
},
"ModifyTime": "2022-01-29 17:47:48"
}
],
"RequestId": "3eb91f01-96dd-4ad3-9e16-edde46b8cf40"
}
}
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
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.