Tencent Cloud

Prev Next

请输入关键字

Recent Pages

文档

DescribeBizTrend

最后更新时间：2024-07-01 09:54:32

1. API Description

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

This API is used to get the traffic flow data collected in the specified period.

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: DescribeBizTrend.
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.
Statistics	Yes	String	Statistical method. Valid values: `max`, `min`, `avg`, `sum`. It can only be `max` if the statistical dimension is traffic rate or packet rate.
Business	Yes	String	Anti-DDoS service type (`bgpip`: Anti-DDoS Advanced)
Period	Yes	Integer	Sampling interval in seconds. Valid values: `60`, `300`, `1800`, `3600`, `21600`, `86400`
StartTime	Yes	Timestamp	Beginning of the time range for the query, such as `2020-09-22 00:00:00`.
EndTime	Yes	Timestamp	End of the time range for the query, such as `2020-09-22 00:00:00`.
Id	Yes	String	Instance ID
MetricName	Yes	String	Metric. Valid values: `connum`, `new_conn`, `inactive_conn`, `intraffic`, `outtraffic`, `inpkg`, `outpkg`, `qps`
Domain	No	String	You can query data by specifying a domain name when the metric is `qps`.
ProtoInfo.N	No	Array of ProtocolPort	Protocol and port list, which is valid when the metric is `connum`, `new_conn` or `inactive_conn`. Valid protocols: `TCP`, `UDP`, `HTTP`, `HTTPS`

3. Output Parameters

Parameter Name	Type	Description
DataList	Array of Float	Value at a time point on the curve
MetricName	String	Statistical dimension
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 Querying the time series traffic data of an Anti-DDoS Advanced instance

This example shows you how to query the time series traffic data of an Anti-DDoS Advanced instance.

Input Example

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

{
    "Domain": "test.com",
    "Statistics": "avg",
    "Business": "bgpip",
    "ProtoInfo": [
        {
            "Protocol": "TCP",
            "Port": 1
        }
    ],
    "Period": 1,
    "StartTime": "2020-09-22 00:00:00",
    "EndTime": "2020-09-22 00:00:00",
    "Id": "bgpip-00000001",
    "MetricName": "qps"
}

Output Example

{
    "Response": {
        "DataList": [
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236,
            236
        ],
        "MetricName": "intraffic",
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

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

Tencent Cloud CLI 3.0

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
DryRunOperation	The DryRun operation means that the request will be successful, but an extra DryRun parameter is passed.
FailedOperation	Operation failed.
InternalError	Internal error. Please try again later.
InvalidParameter	Parameter error.
InvalidParameterValue	Invalid parameter value.
LimitExceeded	The quota limit should not be exceeded.
MissingParameter	Missing parameters. Please check and try again.
ResourceInUse	The resource is occupied.
ResourceNotFound	The resource does not exist. Please try again later.
ResourceUnavailable	The resource is unavailable.

联系我们

联系我们，为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持

tencent cloud

Recent Pages

DescribeBizTrend

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying the time series traffic data of an Anti-DDoS Advanced instance

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？

tencent cloud

注册

登录

Recent Pages

DescribeBizTrend

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying the time series traffic data of an Anti-DDoS Advanced instance

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？