get_resource_anomaly_list – get a list of anomalies in measured parameters configured for the specific Protected resource that are visible to the Customer
April 17, 2024
ID 206506
get_resource_anomaly_list(Auth, client_id, locale_id, resource_id, start, end, limit, offset)
Description: the method displays a list of anomalies in measured parameters configured for the specific Protected resource that are visible to the Customer.
Input parameters:
client_id (int) – customer ID (integer from 1 to 4 294 967 295).
locale_id (int) – locale ID (10 for English, 77 for Russian).
resource_id (int) – Protected resource ID (integer from 1 to 4 294 967 295).
start (str) – start of the interval for data output ('YYYY-MM-DD hh:mm:ss').
end (str,nil) – end of the interval for data output ('YYYY-MM-DD hh:mm:ss', the interval end must not be earlier than the interval start). This can be nil, in which case the current time is used.
limit (int,nil) – number of displayed records (integer from 1 to 1000). This can be nil, in which case it is treated as 1000.
offset (int,nil) – number of ignored records (integer from 0 to 4 294 967 295). This can be nil, in which case it is treated as 0.
Note: The maximum time interval is 1 day.
Output parameters:
id (int) – identifier of the anomaly in the System.
color (int) – color/level of the anomaly (0 – green, 1 – yellow/attention, 2 – red/alarm).
start (str) – timestamp of the start of the anomaly.
last (str) – timestamp of the last point of the anomaly.
state (str) – indicator of whether the anomaly is active/recent.
measured_parameter_id (int) – identifier of the measured parameter.
measured_parameter_type_id (int) – identifier of the type of measured parameter.
measured_parameter_short_name (str) – name of the measured parameter in the specified locale.
measured_parameter_units (str) – units of measurement of the parameter in the specified locale.
measured_parameter_direction (str) – direction of profile intersection for anomaly detection (1: upward, -1: downward).
max_point_timestamp (str) – time of the anomaly peak.
max_point_value (str) – peak value of the measured parameter.
max_point_threshold (str) – value of the anomaly detection profile at the moment of the peak value.
max_point_percentage (str) – percent deviation of the peak value from the detection profile.
