type Alarm
- スケーリンググループ(AutoScalingGroup)定義による仮想サーバのオートスケールや自動復旧のアラーム設定方法について
Heatテンプレートで設定する必要があります。詳細は「機能説明書」や「HEATテンプレート解説書」をご参照ください。
alarm_actions
アラーム状態がalarmの時に実行されるアクション。
「type AlarmAction」をJSON形式の文字列で指定します。
リストの最大数：5
例：
"{\"service\": \"mail\", \"action\": \"send\", \"parameters\":{}}"
詳細は「type AlarmAction」を参照してください。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| list(AlarmAction) | 0..1 | None | None |
alarm_id
アラームのID。
登録時は指定しても無視されます。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | None | None |
combination_rule
他のアラームの組み合わせによる監視設定。
typeに"combination"を指定した場合は必須です。
"threshold_rule"と同時には指定できません。
詳細は「type AlarmCombinationRule」を参照してください。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| AlarmCombinationRule | 0..1 | None | None |
description
アラームの説明。
使用可能文字：全角文字、半角英数字、半角記号
文字数：1～1023
登録時に未指定の場合は、指定したthreshold_rule、またはcombination_ruleの内容に基づいて自動的に登録されます。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | None | None |
enabled
- true：有効
- false：無効
falseの場合はアラームの評価(しきい値監視)を行いません。
登録時に未指定の場合は、"true"が設定されます。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | 0..1 | None | None |
insufficient_data_actions
アラーム状態がinsufficient dataの時に実行されるアクション。
「type AlarmAction」をJSON形式の文字列で指定します。
リストの最大数：5
例：
"{\"service\": \"mail\", \"action\": \"send\", \"parameters\":{}}"
詳細は「type AlarmAction」を参照してください。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| list(AlarmAction) | 0..1 | None | None |
name
アラームの名前。
アラームを作成するユーザーが所属するプロジェクト内で一意となる値を指定します。
使用可能文字：全角文字、半角英数字、半角記号
文字数：1～255
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 1..1 | None | None |
ok_actions
アラーム状態がokの時に実行されるアクション。
「type AlarmAction」をJSON形式の文字列で指定します。
リストの最大数：5
例：
"{\"service\": \"mail\", \"action\": \"send\", \"parameters\":{}}"
詳細は「type AlarmAction」を参照してください。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| list(AlarmAction) | 0..1 | None | None |
project_id
プロジェクトのID。
登録時に未指定の場合は、APIを実行したユーザーが所属するproject_idが設定されます。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | None | None |
repeat_actions
アクションの実行方式。
- true：アクションを再実行する
- false：アクションを再実行しない
登録時に未指定の場合は、"false"が設定されます。
repeat_actionsの値をtrueに設定した場合、アラームの状態によってはアラームの評価の度にアクションが実行される可能性があります。特にアラームにメール送信アクションを指定している場合は、メールが大量に送信される場合もありますのでご注意ください。
アクションごとにrepeat_actionsの値を変更する場合は、それぞれ別のアラームとして作成してください。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Boolean | 0..1 | None | None |
state
- ok
- insufficient data
- alarm
作成直後のアラームの状態は、insufficient dataに設定されます。次回のアラーム評価時(約1分程度)で適切な状態に設定されます。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Enum | 1..1 | None | None |
state_timestamp
アラーム状態が最後に更新された時の日時(UTC)。
形式：「YYYY-MM-DDThh:mm:ss.SSSSSS」
登録時は指定しても無視されます。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Datetime | 0..1 | None | None |
threshold_rule
アラームのしきい値監視設定。
typeに"threshold"を指定した場合は必須です。
"combination_rule"と同時には指定できません。
詳細は「type AlarmThresholdRule」を参照してください。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| AlarmThresholdRule | 0..1 | None | None |
time_constraints
アラーム評価の有効期間設定。
詳細は「type AlarmTimeConstraint」を参照してください。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| AlarmTimeConstraint | 0..1 | None | None |
timestamp
アラームの最終更新日時。
形式：「YYYY-MM-DDThh:mm:ss.SSSSSS」
登録時は指定しても無視されます。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Datetime | 0..1 | None | None |
type
- threshold：しきい値を設定するアラーム
- combination：複数のアラームを組み合わせる複合アラーム
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Enum | 1..1 | None | None |
user_id
アラームを作成したユーザーのID。
登録時に未指定の場合は、APIを実行したユーザーのIDが登録されます。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | None | None |
severity
アラームの重要度。以下のいずれかを指定します。
- low：低
- moderate：中
- critical：高
登録時に未指定の場合は、"low"が設定されます。
アラームの識別用のパラメーターであり、アラーム評価(しきい値監視)の動作には影響しません。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| String | 0..1 | None | None |