アラーム更新 (PUT /v2/alarms/{alarm_id})

Request Headers

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

Request Parameter

ありません。

Request Body

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

必須フィールド("name", "type", "threshold_rule", "meter_name", "threshold")は省略できません。その他のフィールドは、省略した場合はデフォルトの値になります。

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

Response Headers

ステータス

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

200：正常終了

異常の場合は、「API共通エラー情報」を参照してください。

Response Elements

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

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

Example of Request

例：対象のアラーム評価を有効から無効に変更します。

curl -X PUT -H 'Content-Type: application/json' \
-H 'X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x...' \
-d <リクエストボディ> 'https://telemetry.jp-east-1.cloud.global.fujitsu.com/v2/alarms/8278b049-ca2b-4e05-99c9-641c0b692edd'

【リクエストボディ(JSON形式)】
{
    "enabled": false,
    "name": "my_alarm",
    "threshold_rule": {
        "comparison_operator": "gt",
        "meter_name": "my_meter",
        "threshold": 0.0
    },
    "type": "threshold"
}
     

Example of Response

{
    "alarm_actions": [],
    "alarm_id": "8278b049-ca2b-4e05-99c9-641c0b692edd",
    "description": "Alarm when my_meter is gt a avg of 0.0 over 60 seconds",
    "enabled": false,
    "insufficient_data_actions": [],
    "name": "my_alarm",
    "ok_actions": [],
    "project_id": "39bd0d0341484a1a88f8ecdb1b21311c",
    "repeat_actions": false,
    "state": "insufficient data",
    "state_timestamp": "2014-10-24T08:43:30.682976",
    "threshold_rule": {
        "comparison_operator": "gt",
        "evaluation_periods": 1,
        "exclude_outliers": false,
        "meter_name": "my_meter",
        "period": 60,
        "query": [],
        "statistic": "avg",
        "threshold": 0.0
    },
    "time_constraints": [],
    "timestamp": "2014-10-24T08:51:14.940014",
    "type": "threshold",
    "user_id": "9953aae1953a4caab3cc278e3018cf68"
}