tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBgpBizTrend

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

    1. API Description

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

    This API is used to obtain Anti-DDoS Pro traffic data.

    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: DescribeBgpBizTrend.
    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.
    Business Yes String Anti-DDoS service code. bgp-multip indicates Anti-DDos Pro.
    StartTime Yes String Beginning of the time range for the query, such as 2020-09-22 00:00:00.
    EndTime Yes String End of the time range for the query, such as 2020-09-22 00:00:00.
    MetricName Yes String Statistical metric. Values: intraffic, outtraffic, inpkg, and outpkg.
    InstanceId Yes String Instance ID
    Flag Yes Integer 0: Fixed time. 1: Custom time.

    3. Output Parameters

    Parameter Name Type Description
    DataList Array of Integer Values of the samples
    Total Integer Number of samples
    MetricName String Statistical metric
    MaxData Integer Maximum value of the arrays returned
    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 This example shows you how to obtain Anti-DDoS Pro traffic data.

    Input Example

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

{
    "Business": "bgp-multip",
    "InstanceId": "bgp-00000001",
    "Flag": 1,
    "StartTime": "2022-11-29 00:00:00",
    "EndTime": "2022-11-29 01:00:00",
    "MetricName": "intraffic"
}

    Output Example

    {
    "Response": {
        "DataList": [
            1
        ],
        "Total": 1,
        "MaxData": 1,
        "RequestId": "f4b3915e-c1bd-4ca4-aaef-e88eaa8aa66e",
        "MetricName": "intraffic"
    }
}

    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