tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeListBGPIPInstances

Last updated: 2024-07-01 09:54:39

    1. API Description

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

    This API is used to get a list of Anti-DDoS Advanced instances.

    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: DescribeListBGPIPInstances.
    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.
    FilterIp No String IP filter
    FilterInstanceId No String Anti-DDoS instance ID filter. For example, you can filter the Anti-DDoS Advanced instance ID by bgpip-00000001.
    FilterLine No Integer Anti-DDoS Advanced line filter. Valid values:
    1: BGP line
    2: China Telecom
    3: China Unicom
    4: China Mobile
    99: third-party line
    ]
    FilterRegion No String Region filter. For example, ap-guangzhou.
    FilterName No String Name filter
    FilterEipType No Integer Whether to obtain only Anti-DDoS EIP instances. 1: Yes; 0: No.
    FilterEipEipAddressStatus.N No Array of String Anti-DDoS Advanced instance binding status filter. Valid values: BINDING, BIND, UNBINDING, UNBIND. This filter is only valid when FilterEipType = 1.
    FilterDamDDoSStatus No Integer Whether to obtain only Anti-DDoS instances with Sec-MCA enabled. Valid values: 1 (only obtain Anti-DDoS instances with Sec-MCA enabled) and 0 (obtain other Anti-DDoS instances).
    FilterStatus No String Filters by the status of bound resources. Values: idle (normal), attacking (being attacked), blocking (being blocked), trial (in trial)
    FilterCname No String Filters by the instance CNAME
    FilterInstanceIdList.N No Array of String Filters by the instance ID
    FilterTag No TagFilter Searches by tag
    FilterPackType.N No Array of String Filters by package type.
    FilterConvoy No Integer Filters out Convoy instances

    3. Output Parameters

    Parameter Name Type Description
    Total Integer Total number of lists
    InstanceList Array of BGPIPInstance List of Anti-DDoS Advanced instances
    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 Advanced instances

    Input Example

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

{
    "Limit": "1",
    "Offset": "0"
}

    Output Example

    {
    "Response": {
        "RequestId": "0381c271-292d-4e2a-adcc-cd7bcd6977a7",
        "InstanceList": [
            {
                "InstanceDetail": {
                    "EipList": [
                        "2402:4e00:31:804::17"
                    ],
                    "InstanceId": "bgpip-00000001"
                },
                "SpecificationLimit": {
                    "ProtectBandwidth": 30000,
                    "ProtectCCQPS": 40000,
                    "ElasticBandwidth": 50000,
                    "NormalBandwidth": 1000,
                    "ForwardRulesLimit": 60,
                    "AutoRenewFlag": 0,
                    "Line": 1
                },
                "Usage": {
                    "PortRulesUsage": 0,
                    "DomainRulesUsage": 0,
                    "Last7DayAttackCount": 0
                },
                "Region": {
                    "Region": "ap-shanghai"
                },
                "PackInfo": null,
                "StaticPackRelation": null,
                "EipAddressPackRelation": null,
                "AnycastOutPackRelation": null,
                "Tgw": 2,
                "ZoneId": 0,
                "Name": "",
                "V6Flag": 1,
                "Domain": "",
                "Status": "idle",
                "ExpiredTime": "2023-01-08 21:22:24",
                "CreatedTime": "2022-12-08 21:22:24",
                "EipAddressStatus": "",
                "EipFlag": 0,
                "EipAddressInfo": null,
                "ConvoyId": "",
                "DamDDoSStatus": 0,
                "BGPIPChannelFlag": 0,
                "TagInfoList": [],
                "InstanceVersion": 3
            }
        ],
        "Total": 12
    }
}

    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
    AuthFailure CAM signature/authentication error.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy