DescribeFirewallTrafficTrend - Cloud Firewall - Alibaba Cloud Documentation Center

Queries the traffic trend of a firewall.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cloudfirewall:DescribeFirewallTrafficTrend

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response message. zh (default): Chinese en: English	zh
StartTime	integer	Yes	The start time of the query. Specify a UNIX timestamp in seconds. This parameter is required. If this parameter is not specified, ErrorTimeError (400) is returned. Note The query interval (EndTime − StartTime) cannot exceed 90 days. If the interval exceeds 90 days, ErrorTimeError is returned. If the value is later than the current time, it is silently adjusted to the current time. If StartTime is later than EndTime, no error is returned, but the response contains empty data.	1758470400
EndTime	integer	Yes	The end time of the query. Specify a UNIX timestamp in seconds. This parameter is required. If this parameter is not specified, ErrorTimeError (400) is returned. Note The query interval (EndTime − StartTime) cannot exceed 90 days. If the interval exceeds 90 days, ErrorTimeError is returned. If the value is later than the current time, it is silently adjusted to the current time.	1758474000

Response elements

Element	Type	Description	Example
	object
MaxBandwidthTimeBps	object	The traffic distribution at the time of peak total traffic.
TotalBps	integer	The peak total traffic.	1000
InternetBps	integer	The Internet firewall traffic at the time of peak total traffic.	100
NatBps	integer	The NAT firewall traffic at the time of peak total traffic.	100
VpcBps	integer	The VPC firewall traffic at the time of peak total traffic.	100
MaxBandwidthTime	integer	The timestamp when the peak total traffic occurred. The value is a UNIX timestamp in seconds.	1758470400
RequestId	string	The request ID.	4E7F94C7-781F-5192-86CF-DB085****
DataList	array<object>	The returned data list.
	object	The returned data list.
Time	integer	The time when the traffic occurred. The value is a UNIX timestamp in seconds. If the data at this point in time has not been processed, the values of other fields are -1.	1758470400
InternetBps	integer	The Internet firewall traffic.	100
NatBps	integer	The NAT firewall traffic.	100
TotalBps	integer	The total firewall traffic.	300
VpcBps	integer	The VPC firewall traffic.	100

Examples

Success response

JSON format

{
  "MaxBandwidthTimeBps": {
    "TotalBps": 1000,
    "InternetBps": 100,
    "NatBps": 100,
    "VpcBps": 100
  },
  "MaxBandwidthTime": 1758470400,
  "RequestId": "4E7F94C7-781F-5192-86CF-DB085****",
  "DataList": [
    {
      "Time": 1758470400,
      "InternetBps": 100,
      "NatBps": 100,
      "TotalBps": 300,
      "VpcBps": 100
    }
  ]
}

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.