AlertCreateRequest

AlertCreateRequest

NameDescriptionSchemaDefault
description
optional
Alert Description
Example : Description for Alert Test
any of [string, null]
dimension
optional
Dimension
any of [DimensionDTO, null]
dimensions
optional
List of Dimensions
any of [array[DimensionDTO], null]
evaluation_count
optional
Evaluation Count for the Alert Condition
Example : 3
integer1
individual_items
optional
List of Individual Items
any of [array[MetricIndividualItemDto], null]
level
required
Alert Level - HIGH, MIDDLE, LOW
Example : HIGH
enum (HIGH, MIDDLE, LOW)
lower_bound
optional
Lower bound for the Alert range operator
Example : 80.0
any of [object, null]
metric_id
required
Metric ID
Example : f13aab3b88c341b2bc73f8925a0e8cc5
string
missing_data_option
optional
Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNORE
Example : BREACHING
any of [enum (MISSING, BREACHING, NOT_BREACHING, IGNORE), null]IGNORE
name
required
Alert Name
Example : Alert Test
Minimum length : 3
Maximum length : 100
string
namespace_id
required
Namespace ID
Example : 1d9d05af5c624f2cb80a45f2c911e2f4
string
operator
required
Operator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGE
Example : RANGE
enum (GTE, GT, LTE, LT, EQ, NOT_EQ, RANGE)
period
required
Period (seconds)
Example : 300
integer
recipient_ids
optional
List of User IDs
Example : ['1234da92-634a-4f8c-932e-9d650599ab1b', '1234da92-634a-4f8c-932e-9d650599ab1a', '1234da92-634a-4f8c-932e-9d650599ab1c']
any of [array[string], null]
statistic
required
Statistic - SUM, AVG, MAX, MIN
Example : AVG
enum (AVG, SUM, MAX, MIN, CNT)
tags
optional
List of Tags
any of [array[TagDTO], null]
threshold
optional
Threshold for the Alert Condition (except fro RANGE operator)
Example : 80.0
any of [object, null]
upper_bound
optional
Upper bound for the Alert range operator
Example : 90.0
any of [object, null]
violation_count
optional
Violation Count for the Alert Condition
Example : 2
integer1