tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Anti-DDoS
    Documentation
    Download PDF

    DescribeListBGPInstances

    Last updated: 2024-07-01 09:54:38
    Download PDF

      1. API Description

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

      This API is used to get the list of Anti-DDoS Pro 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: DescribeListBGPInstances.
      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 Filters by IP.
      FilterInstanceId No String Anti-DDoS instance ID filter. For example, bgp-00000001.
      FilterRegion No String Filters by region. For example, ap-guangzhou.
      FilterName No String Filters by name.
      FilterLine No Integer Line filter. Valid values: 1: BGP; 2: Non-BGP.
      FilterStatus No String Filters by instance status. idle: Running; attacking: Being attacked; blocking: Being blocked.
      FilterBoundStatus No String Filters by binding status. bounding: The instance is bound; failed: The binding failed.
      FilterInstanceIdList.N No Array of String Array of instance IDs
      FilterEnterpriseFlag No Integer Enterprise edition. Values: 1 (the Convoy package included), 2 (the Convoy package not included)
      FilterLightFlag No Integer Whether it’s a Lighthouse edition
      FilterChannelFlag No Integer Whether it’s a Channel edition
      FilterTag No TagFilter Filters by tag
      FilterTrialFlag No Integer Filters out trial instances. Values: 1 (emergency protection instances), 2 (PLG instances)
      FilterConvoy No Integer Filters out Convoy instances
      ExcludeAdvancedInfo No Boolean Whether to exclude the advanced information (such as InstanceList[0].Usage). Values: true (exclude), false (do not exclude). The default value is false.

      3. Output Parameters

      Parameter Name Type Description
      Total Integer Total number of Anti-DDoS Pro instances
      InstanceList Array of BGPInstance List of Anti-DDoS Pro 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 the list of Anti-DDoS Pro instances

      Getting the list of Anti-DDoS Pro instances

      Input Example

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

{
    "Limit": "1",
    "Offset": "0",
    "FilterInstanceId": "bgp-00000001",
    "FilterIp": "1.1.1.1"
}

      Output Example

      {
    "Response": {
        "InstanceList": [
            {
                "BoundStatus": "idle",
                "CCEnable": 0,
                "CreatedTime": "2022-12-08 18:55:54",
                "DDoSLevel": "high",
                "EipProductInfos": [],
                "ElasticServiceBandwidth": 0,
                "ExpiredTime": "2023-12-08 18:55:54",
                "InstanceDetail": {
                    "EipList": [],
                    "InstanceId": "bgp-00000001"
                },
                "IpCountNewFlag": 0,
                "Line": 1,
                "Name": "zbhh",
                "PackInfo": {
                    "PackId": "zbhh-00000001",
                    "PackType": "zbhh"
                },
                "Region": {
                    "Region": "ap-hongkong"
                },
                "SpecificationLimit": {
                    "AutoRenewFlag": 0,
                    "BattleEditionFlag": 0,
                    "ChannelEditionFlag": 0,
                    "ElasticLimit": 0,
                    "EnterpriseFlag": 1,
                    "ProtectBandwidth": 560000,
                    "ProtectCountLimit": 999999999,
                    "ProtectIPNumberLimit": 10,
                    "ServiceBandWidth": 150,
                    "UnionPackFlag": 0
                },
                "Status": "idle",
                "TagInfoList": [
                    {
                        "TagKey": "xxx",
                        "TagValue": "test"
                    }
                ],
                "Usage": {
                    "Last7DayAttackCount": 0,
                    "ProtectCountUsage": 999999999,
                    "ProtectIPNumberUsage": 0
                },
                "VitalityVersion": 0
            }
        ],
        "RequestId": "0381c271-292d-4e2a-adcc-cd7bcd6977a7",
        "Total": 53
    }
}

      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.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy