DescribeInternetTrafficTrend - Cloud Firewall - Alibaba Cloud Documentation Center

Queries the trends of Internet traffic.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-cloudfirewall:DescribeInternetTrafficTrend	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
SourceIp`deprecated`	string	No	The IP address of the access source.	101.80.171.196
Lang	string	No	The language of the content in 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 traffic out: outbound traffic	in
StartTime	string	Yes	The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds.	1670307484
EndTime	string	Yes	The end of the time range to query. The value is a UNIX timestamp. Unit: seconds.	1674958929
SourceCode	string	Yes	The source code.	yundun
SrcPublicIP	string	No	The public IP address of the source.	47.112.210.136
SrcPrivateIP	string	No	The private IP address of the source.	10.100.134.60
TrafficType	string	No	The type of the traffic that is captured. Valid values: max (default): peak traffic avg: average traffic	max

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
MaxTotalBps	long	The total maximum inbound and outbound network throughput, which indicates the maximum number of bits that are sent inbound and outbound per second. Unit: bit/s.	89783147
MaxBandwidthTime	long	The timestamp generated when the bandwidth reaches the peak value. The value is a UNIX timestamp. Unit: seconds.	1672736400
AvgInBps	long	The average inbound network throughput, which indicates the average number of bits that are sent inbound per second. Unit: bit/s.	6114152
RequestId	string	The request ID.	C7E837BE-0379-565E-B7B4-DE595C8D337C
MaxInBps	long	The maximum inbound network throughput, which indicates the maximum number of bits that are sent inbound per second. Unit: bit/s.	10275643
MaxOutBps	long	The maximum outbound network throughput, which indicates the maximum number of bits that are sent outbound per second. Unit: bit/s.	395188
AvgSession	long	The average number of requests.	79013
MaxSession	long	The number of requests during the peak hour of the network throughout.	931641
AvgTotalBps	long	The total average inbound and outbound network throughput, which indicates the average number of bits that are sent inbound and outbound per second. Unit: bit/s.	2306
AvgOutBps	long	The average outbound network throughput, which indicates the average number of bits that are sent outbound per second. Unit: bit/s.	70148993
TotalInBytes	long	The inbound network throughput, which indicates the total number of bytes that are sent inbound. Unit: bytes.	41536824243873
TotalOutBytes	long	The outbound network throughput, which indicates the total number of bytes that are sent outbound. Unit: bytes.	2660894567178
TotalBytes	long	The total inbound and outbound network throughput, which indicates the total number of bytes that are sent inbound and outbound. Unit: bytes.	963227674958
TotalSession	long	The total number of requests.	1061449
TotalExceedBytes	long	The total volume of excess traffic.	4243873
MaxDayExceedBytes	long	The maximum volume of excess traffic allowed per day.	873
DataList	array<object>	The statistics on traffic.
	object
SessionCount	long	The number of requests.	27
Time	integer	The time when traffic is generated. The value is a UNIX timestamp. Unit: seconds. If processing is not complete at this point in time, -1 is returned for all other fields.	1659405600
InBps	long	The inbound network throughput, which indicates the number of bits that are sent inbound per second. Unit: bit/s.	187
InPps	long	The inbound network throughput, which indicates the number of packets that are sent inbound per second. Unit: packets per second (pps).	2
NewConn	long	The number of new connections.	27
OutBytes	long	The outbound network throughput, which indicates the total number of bytes that are sent outbound. Unit: bytes.	1123
OutPps	long	The outbound network throughput, which indicates the number of packets that are sent outbound per second. Unit: pps.	2
InBytes	long	The inbound network throughput, which indicates the total number of bytes that are sent inbound. Unit: bytes.	235
OutBps	long	The outbound network throughput, which indicates the number of bits that are sent outbound per second. Unit: bit/s.	45
TotalBps	long	The total outbound and inbound network throughput, which indicates the total number of bits that are sent inbound and outbound per second. Unit: bit/s.	323

Examples

Sample success responses

JSONformat

{
  "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": 323
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-05-16	The response structure of the API has changed	View Change Details
2023-09-20	The response structure of the API has changed	View Change Details