DescribeBaradData

Last updated: 2020-07-31 10:08:54

1. API Description

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

This API is used to provide business forwarding metric data of Anti-DDoS services.

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 parameter. The value used for this API: DescribeBaradData.
Version Yes String Common parameter. The value used for this API: 2018-07-09.
Region No String Common parameter. This parameter is not required for this API.
Business Yes String Anti-DDoS service type. bgpip: Anti-DDoS Advanced; net: Anti-DDoS Ultimate
Id Yes String Anti-DDoS instance ID
MetricName Yes String Metric name. Valid values:
connum: number of active TCP connections;
new_conn: number of new TCP connections;
inactive_conn: number of inactive connections;
intraffic: inbound traffic;
outtraffic: outbound traffic;
alltraffic: sum of inbound and outbound traffic;
inpkg: inbound packet rate;
outpkg: outbound packet rate;
Period Yes Integer Statistical time granularity in seconds (300: 5-minute, 3600: hourly, 86400: daily)
StartTime Yes Timestamp Statistics start time. The second part is kept at 0, and the minute part is a multiple of 5
EndTime Yes Timestamp Statistics end time. The second part is kept at 0, and the minute part is a multiple of 5
Statistics Yes String Statistical method. Valid values:
max: maximum value;
min: minimum value;
avg: average;
ProtocolPort.N No Array of ProtocolPort Protocol port array
Ip No String Resource instance IP, which is required only if Business is net (Anti-DDoS Ultimate), because an Anti-DDoS Ultimate instance has multiple IPs;

3. Output Parameters

Parameter Name Type Description
DataList Array of BaradData Returned metric value
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting forwarding report data

Input Example

https://dayu.tencentcloudapi.com/?Action=DescribeBaradData
&Business=shield
&Id=bgpip-000000x7
&Period=300
&StartTime=2018-08-28 07:15:00
&EndTime=2018-08-28 10:05:00
&Statistics=max
&MetricName=connum
&ProtocolPort.0.Protocol=tcp
&ProtocolPort.0.Port=80
&<Common request parameters>

Output Example

{
  "Response": {
    "DataList": [
      {
        "MetricName": "connum",
        "Data": [
          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
        ],
        "Count": 35
      },
      {
        "MetricName": "new_conn",
        "Data": [
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0
        ],
        "Count": 35
      }
    ],
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help