DescribeTransmitStatis

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

1. API Description

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

This API is used to get the business forwarding statistics, including forwarded traffic and packet forwarding rate.

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: DescribeTransmitStatis.
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, bgp: Anti-DDoS Pro (single IP), bgp-multip: Anti-DDoS Pro (multi-IP)
Id Yes String Anti-DDoS instance ID
MetricName Yes String Metric name. Valid values:
traffic: traffic bandwidth;
pkg: packet rate;
Period Yes Integer Statistical time granularity (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
IpList.N No Array of String Resource IP, which is required and only supports one IP if Business is bgp-multip. If this field is left empty, all IPs of a resource instance will be counted by default. If the resource instance has multiple IPs (such as Anti-DDoS Ultimate), the statistical method is summation;

3. Output Parameters

Parameter Name Type Description
InDataList Array of Float If MetricName is traffic, this field indicates the inbound traffic bandwidth in bps;
If MetricName is pkg, this field indicates the inbound packet rate in pps;
OutDataList Array of Float If MetricName is traffic, this field indicates the outbound traffic bandwidth in bps;
If MetricName is pkg, this field indicates the outbound packet rate in pps;
MetricName String Metric name:
traffic: traffic bandwidth;
pkg: packet rate;
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting business forwarding statistics

Input Example

https://dayu.tencentcloudapi.com/?Action=DescribeTransmitStatis
&Business=bgpip
&Id=bgpip-000000x7
&Period=300
&StartTime=2018-08-28 07:15:00
&EndTime=2018-08-28 10:05:00
&MetricName=traffic
&<Common request parameters>

Output Example

{
  "Response": {
    "InDataList": [
      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
    ],
    "OutDataList": [
      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": "traffic",
    "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