Create a new Alarm#

新しいアラームを登録します。

デフォルトでは、ProjectIdで指定したプロジェクト配下の全ての仮想サーバが監視対象です。
個別の仮想サーバを指定したい場合はリクエストパラメータのInstancesに値を設定するか、集合体(aggregate)を作成し、そのAggregateIdを指定する必要があります。
集合体(aggregate)の作成方法は「Create a new aggregate」を参照してください。
リクエストパラメータのInstancesに値を設定した場合、集合体(aggregate)を払い出します。
個別の仮想サーバーを参照、変更をしたい場合は、払い出した集合体(aggregate)の参照や変更で対応できます。
方法は以下を参照してください。

📒注: アラームを登録した際、アラームの条件に一致している、していないに関わらず初期作成時の情報がアラームの履歴に登録されます。
また、アラームアクションを設定している場合、該当するアクションが実行されます。

APIエンドポイント#

リージョン APIエンドポイント
西日本リージョン3の場合 https://telemetry.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合 https://telemetry.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI#

POST

/v3.0/alarms

HTTPステータスコード#

正常時：200

エラー時：400,401,404,500

リクエストパラメータの説明#

名前 In Type デフォルト値
/必須指定		 Description
X-Auth-Token header string 必須 認証のトークン
Content-Type header string 任意 「application/json」を設定します。
IntervalDuration body string 必須 監視間隔
1秒単位で設定できます。60秒の場合は、60sと設定してください。
アラーム通知については、「アラーム通知例」を参照してください。
Severity body string 任意 アラームレベル
当項目を設定してもアラームの制御はできません。アラームの情報としてのみ利用可能です。
以下の文字が設定できます。
- critical
- error
- warning
- information
- none
AggregationFunction body string 必須 アラーム情報集計種別
平均、最大、最小、合計などを設定します。
以下の文字列が設定できます。
- average
- max
- min
- sum
ProjectId body string 必須 プロジェクトID
Threshold body integer 必須 比較値(しきい値や判定値)
CPUやメモリ使用率を監視項目とする場合は使用率、起動状態の場合は判定値というように、比較する監視項目に沿った値です。
MetricTypeの単位に対応した値が指定可能です。
詳細は「MetricType」を参照してください。
ComparisonFunction body string 必須 比較式
同一、超過、未満などです。
以下の文字列が設定できます。
- equal
- above
- below
Status body string enabled
任意		 アラームの状態
有効/無効で設定します。設定しない場合は有効で設定します。
以下の文字列が設定できます。
- enabled
- disabled
EventRuleScope body string 必須 アラームによって監視される対象の種別
以下の文字列が設定できます。
- instance
AggregateId body string 任意 集合体(aggregate)のID
アラームの対象を集合体で設定した対象に限定することができます。AggregateIdを設定しない場合はプロジェクト配下の全ての仮想サーバが監視対象です。
📒注: AggregateIdとInstancesを同時に指定した場合、Instancesの内容が優先されます。
IntervalCount body integer 必須 監視項目の状態判定回数
最後に監視を行った時点から過去に遡り、状態を判定する回数を示します。
アラーム通知については、「アラーム通知例」を参照してください。
IntervalsWithException body integer 1
任意		 アラーム通知のしきい値
最後に監視を行った時点からIntervalCount分、過去に遡り
監視条件に一致した回数が、IntervalsWithException以上となった場合、アラームが通知されます。
アラーム通知については、「アラーム通知例」を参照してください。
📘ヒント:「監視条件」とは、比較値(Threshold)、比較式(ComparisonFunction)、アラーム情報集計種別(AggregationFunction)で設定したCPUやメモリ使用率等の監視項目を監視するための条件です。
MetricType body string 必須 監視項目種別
値については、「MetricType」を参照してください。
Module body string 必須 アラームモジュール
以下の文字列が設定できます。
- alarms
Name body string 必須 アラーム名
Mode body string 必須 アラーム起動種別
以下の文字列が設定できます。
- alert
AlarmAction body List<string> 任意 アラームアクション
以下のアクションが設定できます。
- mail(メール通知)
Instances body List<string> 任意 監視対象仮想サーバ
監視対象とする仮想サーバIDをリスト形式で指定できます。
ProjectIdで指定したプロジェクト内に存在する仮想サーバだけ指定できます。
このパラメータを設定すると、集合体(aggregate)が自動的に作成されます。
📒注: AggregateIdとInstancesを同時に指定した場合、Instancesの内容が優先されます。
 

参考:アラーム通知例#

監視間隔(IntervalDuration):60s、監視項目の状態判定回数(IntervalCount):5、アラーム通知のしきい値(IntervalsWithException):2の場合
60秒間隔で最後に監視を行った時点から5回分過去に遡って判定し、2回以上監視条件に一致すれば、条件が一致した旨のアラームを通知します。

レスポンスボディ（正常系）の説明#

名前 Type Description
EventRuleId string アラームID
IntervalDuration string 監視間隔
Severity string アラームレベル
AggregationFunction string アラーム情報集計種別
平均、最大、最小、合計などを示します。
以下の文字列が設定されます。
- average
- max
- min
- sum
ProjectId string プロジェクトID
Threshold integer 比較値(しきい値や判定値)
CPUやメモリ使用率を監視項目とする場合は使用率、起動状態の場合は判定値というように、比較する監視項目に沿った値です。
詳細は「MetricType」を参照してください。
ComparisonFunction string 比較式
同一、超過、未満などを示します。
以下の文字列が設定されます。
- equal
- above
- below
EventRuleScope string アラームによって監視される対象の種別
Status string アラームの状態
有効、無効を示します。
以下の文字列が設定されます。
- enabled
- disabled
AggregateId string 集合体(aggregate)のID
リクエストでInstancesを設定すると、自動で作成された集合体(aggregate)のIDが設定されます。
ConfigurationStatus string アラームの状態
IntervalCount integer 監視項目の状態判定回数
MetricType string 監視項目種別
値については、「MetricType」を参照してください。
EventRuleType string アラーム計測種別
TriggerRuleType string トリガー種別
IntervalsWithException integer アラーム通知のしきい値
Module string アラームモジュール
Name string アラーム名
Mode string アラーム起動種別
AlarmAction List<string> アラームアクション
リストが空の場合は何もアクションを行いません。
設定されている場合は対応したアクションを行います。
アクションについては以下の設定があります。
- mail(メール通知)
Instances List<string> 監視対象仮想サーバ

リクエスト例#

curl -X POST -H "Content-Type: application/json" \
-H "X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x..." \
-d <リクエストボディ> "https://telemetry.jp-west-3.cloud.global.fujitsu.com/v3.0/alarms"

リクエストボディ(JSON形式)の例

{
    "IntervalDuration": "60s",
    "Severity": "critical",
    "AggregationFunction": "average",
    "ProjectId": "sample_project_id",
    "Threshold": 80.0,
    "ComparisonFunction": "above",
    "EventRuleScope": "instance",
    "AggregateId": null,
    "ConfigurationStatus": "instance",
    "IntervalCount": 1,
    "MetricType": "cpu.usage",
    "IntervalsWithException": 1,
    "Module": "alarms",
    "Name": "cpu_test",
    "Mode": "alert",
    "AlarmAction": [
      "mail"
    ],
    "Instances":[
      "instance1_id",
      "instance2_id"
   ]
}

レスポンス例#

{
    "EventRuleId": "11f3ak61casii26s",
    "IntervalDuration": "60s",
    "Severity": "critical",
    "AggregationFunction": "average",
    "ProjectId": "sample_project_id",
    "Threshold": 80.0,
    "ComparisonFunction": "above",
    "EventRuleScope": "instance",
    "Status": "enabled",
    "AggregateId": "AUTO_CREATE_11f3ak61casii26s",
    "ConfigurationStatus": "instance",
    "TriggerRuleType": "instance",
    "IntervalCount": 1,
    "MetricType": "cpu.usage",
    "EventRuleType": "static",
    "IntervalsWithException": 1,
    "Module": "alarms",
    "Name": "cpu_test",
    "Mode": "alert",
    "AlarmAction": [
      "mail"
    ],
    "Instances":[
      "instance1_id",
      "instance2_id"
   ]
}