新規アラーム登録 (POST /v2/alarms)

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

注意:
アラームの評価(しきい値監視)は監視サービス内部の監視間隔(60秒)に従って行われます。そのため、アラームを登録するタイミングによっては、現在の監視間隔ではなく、次回の監視間隔に登録したアラームが評価される場合があります。

Request Headers

API共通項目」を参照してください。

Request Parameter

ありません。

Request Body

登録するアラームの情報をJSON形式で指定します。

内容の詳細は、「type Alarm」を参照してください。

Response Headers

ステータス

正常の場合は以下のステータスを返却します。

201:正常終了

異常の場合は、「API共通エラー情報」に加えて、以下のステータスを返却します。

409:既に同じアラーム名が存在している場合

Data Type Cardinality
Int 1..1

Response Elements

登録したアラームの情報をJSON形式で返します。

内容の詳細は、「type Alarm」を参照してください。

Example of Request

例:アラーム状態になるとメールを送信するアラームを登録します。


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

【リクエストボディ(JSON形式)】
 {
  "alarm_actions": [
   "{\"service\": \"mail\", \"action\": \"send\", \"parameters\":{} }"
  ],
  "name": "my_alarm ",
  "repeat_actions": false,
  "threshold_rule": {
   "meter_name": "my_meter",
   "threshold": 99.0
  },
  "type": "threshold"
 }
     

Example of Response


       {
        "alarm_actions": [
         "{\"service\": \"mail\", \"action\": \"send\", \"parameters\":{} }"
        ],
        "alarm_id": "8aa66462-e17b-480f-9493-909ffdb2179e",
        "description": "Alarm when cpu_util is eq a avg of 99.0 over 60 seconds",
        "enabled": true,
        "insufficient_data_actions": [],
        "name": "my_alarm",
        "ok_actions": [],
        "project_id": "22ef168c58d94872a66c90d74297136a",
        "repeat_actions": false,
        "state": "insufficient data",
        "state_timestamp": "2014-10-22T08:42:23.817799",
        "threshold_rule": {
         "comparison_operator": "eq",
         "evaluation_periods": 1,
         "exclude_outliers": false,
         "meter_name": "my_meter",
         "period": 60,
         "query": [],
         "statistic": "avg",
         "threshold": 99.0
        },
        "time_constraints": [],
        "timestamp": "2014-10-22T08:42:23.817799",
        "type": "threshold",
        "user_id": "13d97e9c31454563b8aa78b0b2e92385"
       }