All Products
Search
Document Center

Cloud Firewall:DescribeInternetTrafficTrend

Last Updated:Oct 16, 2025

Queries Internet traffic trends.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

SourceIp deprecated

string

No

The source IP address of the visitor.

101.80.171.196

Lang

string

No

The language of the request and response. Valid values:

  • zh (default): Chinese

  • en: English

zh

Lang

string

No

The language of the request and response. Valid values:

  • zh (default): Chinese

  • en: English

zh

Direction

string

No

The direction of the Internet traffic. Valid values:

  • in: inbound

  • out: outbound

in

StartTime

string

Yes

The start of the time range to query. This value is a UNIX timestamp in seconds.

1670307484

EndTime

string

Yes

The end of the time range to query. This value is a UNIX timestamp in seconds.

1674958929

SourceCode

string

Yes

The source tracking code.

yundun

SrcPublicIP

string

No

The source public IP address.

47.112.210.136

SrcPrivateIP

string

No

The source private IP address.

10.100.134.60

TrafficType

string

No

The type of traffic to query. Valid values:

  • max (default): peak traffic

  • avg: average traffic

max

Response elements

Element

Type

Description

Example

object

Schema of Response

MaxTotalBps

integer

The peak total network throughput for inbound and outbound traffic. Unit: bps.

89783147

MaxBandwidthTime

integer

The UNIX timestamp when the peak bandwidth was reached. Unit: seconds.

1672736400

AvgInBps

integer

The average inbound network throughput. Unit: bps.

6114152

RequestId

string

The ID of the request.

C7E837BE-0379-565E-B7B4-DE595C8D337C

MaxInBps

integer

The peak inbound network throughput. Unit: bps.

10275643

MaxOutBps

integer

The peak outbound network throughput. Unit: bps.

395188

AvgSession

integer

The average number of requests.

79013

MaxSession

integer

The peak number of requests.

931641

AvgTotalBps

integer

The average total network throughput for inbound and outbound traffic. Unit: bps.

2306

AvgOutBps

integer

The average outbound network throughput. Unit: bps.

70148993

TotalInBytes

integer

The total inbound traffic. Unit: bytes.

41536824243873

TotalOutBytes

integer

The total outbound traffic. Unit: bytes.

2660894567178

TotalBytes

integer

The total inbound and outbound traffic. Unit: bytes.

963227674958

TotalSession

integer

The total number of requests.

1061449

TotalExceedBytes

integer

The total excess traffic.

4243873

MaxDayExceedBytes

integer

The peak daily excess traffic.

873

DataList

array<object>

A list of traffic statistics.

object

A list of traffic statistics.

SessionCount

integer

The number of requests.

27

Time

integer

The time when the traffic was recorded. This value is a UNIX timestamp in seconds.

If data for this time point has not been processed, the values of other fields are -1.

1659405600

InBps

integer

The inbound network throughput. Unit: bps.

187

InPps

integer

The inbound packet rate. Unit: pps.

2

NewConn

integer

The number of new connections.

27

OutBytes

integer

The outbound traffic. Unit: bytes.

1123

OutPps

integer

The outbound packet rate. Unit: pps.

2

InBytes

integer

The inbound traffic. Unit: bytes.

235

OutBps

integer

The outbound network throughput. Unit: bps.

45

TotalBps

integer

The total inbound and outbound network throughput. Unit: bps.

232

Examples

Success response

JSON format

{
  "MaxTotalBps": 89783147,
  "MaxBandwidthTime": 1672736400,
  "AvgInBps": 6114152,
  "RequestId": "C7E837BE-0379-565E-B7B4-DE595C8D337C",
  "MaxInBps": 10275643,
  "MaxOutBps": 395188,
  "AvgSession": 79013,
  "MaxSession": 931641,
  "AvgTotalBps": 2306,
  "AvgOutBps": 70148993,
  "TotalInBytes": 41536824243873,
  "TotalOutBytes": 2660894567178,
  "TotalBytes": 963227674958,
  "TotalSession": 1061449,
  "TotalExceedBytes": 4243873,
  "MaxDayExceedBytes": 873,
  "DataList": [
    {
      "SessionCount": 27,
      "Time": 1659405600,
      "InBps": 187,
      "InPps": 2,
      "NewConn": 27,
      "OutBytes": 1123,
      "OutPps": 2,
      "InBytes": 235,
      "OutBps": 45,
      "TotalBps": 232
    }
  ]
}

Error codes

HTTP status code

Error code

Error message

Description

400 ErrorAliUid Aliuid invalid. The aliuid is invalid.
400 ErrorSourceCodeError The source code is invalid. The source code is invalid.
400 ErrorDirectionError The direction is invalid. The direction is invalid.
400 ErrorIpFormat The IP address is invalid. The IP address is invalid.
400 ErrorSrcDstIPError SrcPublicIP and DstPublicIP cannot be specified at the same time. The source public IP address and destination public IP address cannot be specified at the same time.
400 ErrorTrafficType The traffic type is invalid. The traffic type is invalid.
400 ErrorIntervalError The interval is invalid. The interval is invalid.
400 ErrorTimeError The time is invalid. The time is invalid.
400 ErrorDataTypeError The data type is invalid. The data type is invalid.
400 ErrorDBSelectError A database select error occurred. The error message returned because an internal error has occurred in querying the database.
400 ErrorMarshalJSON internal error. Internal error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.