DescribeFirewallDropTrend - Cloud Firewall - Alibaba Cloud Documentation Center

Retrieves the overall firewall interception trends, including Internet, VPC, and NAT traffic.

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:DescribeFirewallDropTrend

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: 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 and must be specified together with EndTime. The value must be a UNIX timestamp in seconds and must be earlier than EndTime. If this parameter is not specified, the API returns ErrorTimeError(400).	1758470400
EndTime	integer	Yes	The end time of the query. Specify a UNIX timestamp in seconds. This parameter is required and must be specified together with StartTime. The value must be a UNIX timestamp in seconds and must be later than StartTime. If this parameter is not specified, the API returns ErrorTimeError(400).	1758474000

Response elements

Element	Type	Description	Example
	object
DataList	array<object>	The returned data list.
	object	The returned data list.
InternetDropSession	integer	The number of sessions blocked by the Internet firewall.	100
NatDropSession	integer	The number of sessions blocked by the NAT firewall.	100
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 all other fields are -1.	1758474000
TotalDropSession	integer	The total number of sessions blocked by the firewall.	300
VpcDropSession	integer	The number of sessions blocked by the VPC firewall.	100
MaxDropSession	integer	The maximum number of total blocked sessions.	300
MaxDropTime	integer	The time when the maximum number of total blocked sessions occurred. The value is a UNIX timestamp in seconds, such as 1672502400.	1656837360
RequestId	string	The request ID.	75E60025-43C5-5635-B7B7-272C5246****

Examples

Success response

JSON format

{
  "DataList": [
    {
      "InternetDropSession": 100,
      "NatDropSession": 100,
      "Time": 1758474000,
      "TotalDropSession": 300,
      "VpcDropSession": 100
    }
  ],
  "MaxDropSession": 300,
  "MaxDropTime": 1656837360,
  "RequestId": "75E60025-43C5-5635-B7B7-272C5246****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorAliUid	Aliuid invalid.	The aliuid is invalid.
400	ErrorIntervalError	The interval is invalid.	The interval is invalid.
400	ErrorTimeError	The time is invalid.	The time 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.
400	MissingParameter.StartTime	Parameter StartTime is required. Specify a valid Unix timestamp in seconds.	Parameter StartTime is required. Specify a valid Unix timestamp in seconds.
400	MissingParameter.EndTime	Parameter EndTime is required. Specify a valid Unix timestamp in seconds.	Parameter EndTime is required. Specify a valid Unix timestamp in seconds.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.