client_attack_list – display a list of only active attacks or all attacks during a certain period of time

April 17, 2024

ID 249388

client_attack_list(Auth, client_id, group_id, resource_id, locale_id, start_time, end_time, offset, limit)

Description: the method displays a list of only active attacks or all attacks during a cer tain period of time.

Input parameters:

client_id (int) – customer ID (integer from 1 to 4 294 967 295).

group_id (int,nil) – resource group ID (integer, from 1 to 4 294 967 295). If set, then the list is displayed only for specified resource group.

resource_id (int,nil) – resource ID (целое число, от 1 до 4 294 967 295). If set, then the list is displayed only for specified resource.

locale_id (int) – locale ID (10 for English, 77 for Russian).

start_time (str,nil) – start of the period of time for which to display data (’YYYY-MM-DD hh:mm:ss’), if not set, then only active attacks are displayed.

end_time (str,nil) – end of the period of time for which to display data (’YYYY-MM-DD hh:mm:ss’), end_time should not be less than start_time). If not set, then the current moment of time is set by default.

offset (int,nil) – number of ignored records (integer from 0 to 4 294 967 295), default is 0.

limit (int,nil) – number of displayed records (integer from 1 to 1000).

Output parameters:

attack_id (int) – identifier of the attack.

attack_type (str) – type of attack in the selected locale.

attack_start (str) – timestamp of the start of the attack.

attack_end (str,nil) – timestamp of the end of the attack (nil if the attack is active).

attack_active (int) – attack activity flag (1 - active, 0 - finished).

resource_id (int) – resource ID.

resource_name (str) – name of the resource in the selected locale.

group_id (int) – resource group ID.

group_name (str) – resource group name in the specified locale.

attacked_ips (list of str) – list of attacked IP addresses.

attacked_domains (list of str) - list of attacked domains.

max_point_value_bps (float) – peak value of the measured parameter "Incoming traffic in bps" since the start of the attack.

max_point_value_pps (float) – peak value of the measured parameter "Incoming traffic in pps" since the start of the attack.

max_point_value_rps (float) – peak value of the measured parameter "HTTP requests, hits/sec" since the start of the attack.

Did you find this article helpful?
What can we do better?
Thank you for your feedback! You're helping us improve.
Thank you for your feedback! You're helping us improve.