tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeListIPAlarmConfig

Last updated: 2024-07-01 09:55:41

    1. API Description

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

    This API is used to get a list of IP alarm threshold configurations.

    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: DescribeListIPAlarmConfig.
    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-*.
    FilterAlarmType Yes Integer Alarm threshold type filter. Valid values:
    1: alarm threshold for inbound traffic
    2: alarm threshold for cleansing attack traffic
    ]
    FilterIp No String IP filter
    FilterCname No String CNAME of the Anti-DDoS Advanced instance

    3. Output Parameters

    Parameter Name Type Description
    Total Integer Total number of lists
    ConfigList Array of IPAlarmThresholdRelation List of IP alarm threshold configurations
    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 IP alarm threshold configurations

    Input Example

    https://antiddos.tencentcloudapi.com/?Action=DescribeListIPAlarmConfig
&Offset=0
&Limit=25
&FilterIp=1.1.1.1
&FilterInstanceId=bgpip-0000011x
&FilterAlarmType=1
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "a3056c16-1cb6-4bdb-9d3b-a2361fe5b63c",
        "ConfigList": [
            {
                "AlarmType": 2,
                "AlarmThreshold": 2000,
                "InstanceDetailList": [
                    {
                        "EipList": [
                            "1.1.1.1"
                        ],
                        "InstanceId": "bgpip-0000011x"
                    }
                ]
            },
            {
                "AlarmType": 1,
                "AlarmThreshold": 5000,
                "InstanceDetailList": [
                    {
                        "EipList": [
                            "1.1.1.1"
                        ],
                        "InstanceId": "bgpip-0000011x"
                    }
                ]
            }
        ],
        "Total": 2
    }
}

    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.

    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy