Modify status of an Alarm to be enabled or disabled#
既存のアラームの内容を変更します。
変更可能な内容は以下のとおりです。
- アラーム状態(有効/無効)
- アラームアクションの追加/削除
APIエンドポイント#
| リージョン | APIエンドポイント |
|---|---|
| 西日本リージョン3の場合 | https://telemetry.jp-west-3.cloud.global.fujitsu.com |
| 東日本リージョン3の場合 | https://telemetry.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
PUT
/v3.0/alarms/{alarm_id}
HTTPステータスコード#
正常時：200
エラー時：400,401,404,500
リクエストパラメータの説明#
| 名前 | In | Type | デフォルト値 /必須指定 |
Description |
|---|---|---|---|---|
| alarm_id | path | string | 必須 | アラームのID |
| X-Auth-Token | header | string | 必須 | 認証のトークン |
| Content-Type | header | string | 必須 | 「application/json」を設定します。 |
| AlarmAction | body | List<string> | 任意 | アラームアクションの追加リスト 追加したいアラームアクションを設定します。 - mail(メール通知) |
| DeleteAlarmAction | body | List<string> | 任意 | アラームアクションの削除リスト 削除したいアラームアクションを設定します。 - mail(メール通知) |
| Status | body | List<string> | 任意 | アラームの状態 有効/無効のどちらかです。 以下の文字列が設定できます。 - enabled - disabled |
リクエスト例#
curl -X PUT -H "Content-Type: application/json" \ -H "X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x..." \ -d <リクエストボディ> "https://telemetry.jp-west-3.cloud.global.fujitsu.com/v3.0/alarms/f50326fe..."
リクエストボディ(JSON形式)
{ "AlarmAction":[ "mail" ], "DeleteAlarmAction":[ "mail" ], "Status": "enabled" }