tencent cloud

文档反馈

DescribeListProtectThresholdConfig

最后更新时间:2023-05-24 14:57:53

1. API Description

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

This API is used to get a list of protection threshold configurations for AI protection switch, protection level, and CC threshold switch.

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: DescribeListProtectThresholdConfig.
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
FilterDomain No String Domain name filter for querying CC protection thresholds of domain names and protocols
FilterProtocol No String Protocol filter for querying CC protection thresholds of domain names and protocols

3. Output Parameters

Parameter Name Type Description
Total Integer Total number of lists
ConfigList Array of ProtectThresholdRelation List of protection threshold configurations
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting a list of protection threshold configurations

Input Example

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

{
    "FilterInstanceId": "bgpip-0000011x",
    "FilterIp": "1.1.1.1",
    "Limit": "25",
    "Offset": "0"
}

Output Example

{
    "Response": {
        "Total": 1,
        "ConfigList": [
            {
                "DDoSThreshold": 1,
                "RstFloodPktThreshold": 1,
                "SynAckFloodThreshold": 1,
                "DDoSAI": "om",
                "CCEnable": 1,
                "ListenerCcThresholdList": [
                    {
                        "CCThreshold": 0,
                        "Domain": "*.examw.com",
                        "Protocol": "http",
                        "CCEnable": 0
                    }
                ],
                "AckFloodThreshold": 1,
                "SynFloodThreshold": 1,
                "InstanceDetailList": [
                    {
                        "InstanceId": "bgpip-0000011x",
                        "EipList": [
                            "1.1.1.1"
                        ]
                    }
                ],
                "CCThreshold": 1,
                "UdpFloodPktThreshold": 1,
                "AckFloodPktThreshold": 1,
                "UdpFloodThreshold": 1,
                "SynAckFloodPktThreshold": 1,
                "RstFloodThreshold": 1,
                "DDoSLevel": "middle",
                "SynFloodPktThreshold": 1
            }
        ],
        "RequestId": "f56cc9dc-29d9-4594-b12d-22239c7bc888"
    }
}

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.