type Alarm
- 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.
alarm_actions
Actions to execute when the alarm state changes to "alarm".
Specify "type AlarmAction" in JSON format.
Maximum number of lists: 5
Example:
"{\"service\": \"mail\", \"action\": \"send\", \"parameters\": {}}"
Refer to "type AlarmAction" for details.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| list(AlarmAction) | 0..1 | None | None |
alarm_id
ID of the alarm.
Even if this value is specified, it will be ignored.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 0..1 | None | None |
combination_rule
Monitoring settings using a combination of other alarms.
This item is required when "combination" is specified for type.
"combination_rule" and "threshold_rule" are mutually exclusive.
Refer to "type AlarmCombinationRule" for details.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| AlarmCombinationRule | 0..1 | None | None |
description
Alarm description
Valid characters: Fullwidth characters, halfwidth alphanumeric characters and halfwidth symbols
Number of characters: 1 to 1023
If omitted during creation, a value based on the specified threshold_rule or the content of the combination_rule is used.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 0..1 | None | None |
enabled
- true: Enabled
- false: Disabled
If false, alarm evaluation (threshold value monitoring) will not be performed.
If omitted during creation, "true" is used.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Boolean | 0..1 | None | None |
insufficient_data_actions
Actions to execute when the alarm state changes to "insufficient data".
Specify "type AlarmAction" in JSON format.
Maximum number of lists: 5
Example:
"{\"service\": \"mail\", \"action\": \"send\", \"parameters\": {}}"
Refer to "type AlarmAction" for details.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| list(AlarmAction) | 0..1 | None | None |
name
Alarm name.
Specify a unique value within the project to which the user that creates the alarm belongs.
Valid characters: Fullwidth characters, halfwidth alphanumeric characters and halfwidth symbols
Number of characters: 1 to 255
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 1..1 | None | None |
ok_actions
Actions to execute when the alarm state changes to "ok"
Specify "type AlarmAction" in JSON format.
Maximum number of lists: 5
Example:
"{\"service\": \"mail\", \"action\": \"send\", \"parameters\": {}}"
Refer to "type AlarmAction" for details.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| list(AlarmAction) | 0..1 | None | None |
project_id
Project ID
If omitted during creation, the project_id of the user that executed the API is used.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 0..1 | None | None |
repeat_actions
Whether the actions should be re-executed.
- true: Re-execute the action
- false: Do not re-execute the action
If omitted during creation, "false" is used.
If "repeat_actions" is set to true, actions may be executed on each alarm evaluation, depending on the alarm state. Be aware that a large volume of emails may be sent, particularly if an email send action is specified for the alarm.
If you want to change the value of "repeat_actions" for each action, create each action as a separate alarm.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Boolean | 0..1 | None | None |
state
- ok
- insufficient data
- alarm
The alarm state immediately after creation is "insufficient data". The appropriate state is then set on the next alarm evaluation (approximately 1 minute).
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Enum | 1..1 | None | None |
state_timestamp
The datetime (UTC) when the alarm state was last updated.
Format: "YYYY-MM-DDThh:mm:ss.SSSSSS"
Even if this value is specified, it will be ignored.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Datetime | 0..1 | None | None |
threshold_rule
Alarm threshold monitoring setting.
This item is required when "threshold" is specified for type.
"combination_rule" and "threshold_rule" are mutually exclusive.
Refer to "type AlarmThresholdRule" for details.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| AlarmThresholdRule | 0..1 | None | None |
time_constraints
Sets the expiry period of alarm evaluation.
Refer to "type AlarmTimeConstraint" for details.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| AlarmTimeConstraint | 0..1 | None | None |
timestamp
Last update datetime of the alarm.
Format: "YYYY-MM-DDThh:mm:ss.SSSSSS"
Even if this value is specified, it will be ignored.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Datetime | 0..1 | None | None |
type
- threshold: Alarm triggered based on threshold value
- combination: Alarm comprising a combination of alarms
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Enum | 1..1 | None | None |
user_id
ID of the user that created the alarm.
If omitted during creation, the ID of the user that executed the API is used.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 0..1 | None | None |
severity
Severity of the alarm. Specify one of the following:
- low
- moderate
- critical
If omitted during creation, "low" is used.
This parameter is used to identify the alarm, and has no effect on operation of alarm evaluation (threshold monitoring).
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 0..1 | None | None |