type AlarmThresholdRule

  • The alarm setting method for virtual server auto scaling and automatic recovery by scaling group (AutoScalingGroup) definition

    must be configured using a Heat template. Refer to the "Features Handbook" and the "Heat Template Specifications" for details.

comparison_operator

Specifies the comparison operator to use against the sample value statistics and threshold value (if "gt" is specified, the comparison performed will be "statistic > threshold").
  • eq: Equal to
  • gt: Greater than
  • ge: Greater than or equal to
  • lt: Less than
  • le: Less than or equal to

If omitted, "eq" is used.

Data type Cardinality Parent element Child element
Enum 0..1 None None

evaluation_periods

Number of periods for evaluating the threshold.

Range: 1 to "period" x evaluation_periods <= 86400.

If omitted, "1" is used.

Data type Cardinality Parent element Child element
int 0..1 None None

exclude_outliers

Specifies whether to exclude sample data that lies outside a certain standard for alarm evaluation.
  • true: Exclude
  • false: Do not exclude

Find the standard deviation of the target sample data, and exclude sample data that lies more than two standard deviations outside the mean.

If omitted, "false" is used.

Data type Cardinality Parent element Child element
Boolean 0..1 None None

meter_id

Name of the meter for threshold monitoring.

Data type Cardinality Parent element Child element
String 1..1 None None

period

Period for determining the threshold (seconds).

Range: 60 to period x evaluation_periods <= 86400 (multiples of 60)

If omitted, 60 seconds is used.

Data type Cardinality Parent element Child element
int 0..1 None None

query

Query setting for searching for samples to calculate the statistics.

Maximum number of lists: 10

"field": May contain the following values for the field to be used in the comparison:
  • resource_id: ID of the resource.
  • source: Source meter.
  • user_id: ID of the user that created the meter.
"op": May contain the following operators to be used in the comparison:
  • If field is the resource_id:

    eq: Equal to

  • If field is the source:

    eq: Equal to

  • If field is the user_id:

    eq: Equal to

"value": May contain the following values to be used in the comparison:
  • If field is the resource_id:

    Resource ID

  • If field is the source:

    Source

  • If field is the user_id:

    User ID

Valid characters: Fullwidth characters, halfwidth alphanumeric characters and halfwidth symbols

Number of characters: 1 to 255

If the project of the user that issued the API for creation differs from the project specified using the "project_id", the following will be inserted automatically:


{
  "field": "project_id",
  "value": "valueSpecifiedUsingProject_Id",
  "op": "eq"
}

By default, samples are searched for based only on the above project_id as the searched field.

Refer to "type Query" for details.

Data type Cardinality Parent element Child element
list(Query) 0..1 None None

statistic

Specifies the aggregation method to be used in the comparison against the threshold.
  • avg: average value
  • count: number of samples
  • max: maximum value
  • min: minimum value
  • sum: total value

If omitted, "avg" is used.

Data type Cardinality Parent element Child element
Enum 0..1 None None

threshold

Specifies the threshold.

Range: -1E+308 to +1E+308

Data type Cardinality Parent element Child element
float 1..1 None None