Retrieve NAT Firewall Blocked Traffic Trends via API - Cloud Firewall - Alibaba Cloud - Cloud 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:DescribeNatFirewallDropTrafficTrend

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the request.	122.190.56.XXX
StartTime	integer	Yes	The start time. Specify a UNIX timestamp in seconds. This parameter is required. If this parameter is not specified, the API returns ErrorTimeError (400). Specify a UNIX timestamp in seconds. The value of StartTime must be earlier than the value of EndTime.	1740968766
EndTime	integer	Yes	The end time. Specify a UNIX timestamp in seconds. This parameter is required. If this parameter is not specified, the API returns ErrorTimeError (400). Specify a UNIX timestamp in seconds. The value of EndTime must be later than the value of StartTime.	1758334822

Response elements

Element	Type	Description	Example
	object	Schema of Response
DropSessionMax	integer	The maximum number of dropped sessions (peak value) within the corresponding period.	62436
DropSessionMaxTime	string	The period in which the maximum number of dropped sessions occurred. The value is a UNIX timestamp in seconds, which represents the number of seconds that have elapsed since January 1, 1970 (UTC).	1525662720
RequestId	string	The request ID.	F0F82705-CFC7-5F83-86C8-A063892F****
DataList	array<object>	The data list on the overview page.
	object	The data list on the overview page.
Time	integer	The data timestamp. The value is a UNIX timestamp in seconds.	1659405600
TotalSession	integer	The total number of requests.	153188
DropSession	integer	The number of blocked sessions.	10

Examples

Success response

JSON format

{
  "DropSessionMax": 62436,
  "DropSessionMaxTime": "1525662720",
  "RequestId": "F0F82705-CFC7-5F83-86C8-A063892F****",
  "DataList": [
    {
      "Time": 1659405600,
      "TotalSession": 153188,
      "DropSession": 10
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorAliUid	The aliuid is 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	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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.