Update an Alarm#

既存のアラームの内容を変更します。

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

/v4.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」を設定します。
name	body	string	任意	アラーム名。半角英数字記号100文字まで空文字を指定した場合、エラーとなります。
description	body	string	任意	アラームの説明。255文字まで。空文字を指定した場合、説明文を削除します。
project_id	body	string	任意	プロジェクトID 空文字を指定した場合、エラーとなります。
target_type	body	string	任意	アラーム設定対象のタイプ空文字を指定した場合、エラーとなります。値については、「TargetType」を参照してください。
object_id	body	string	任意	アラーム設定対象のオブジェクトID 空文字を指定した場合、エラーとなります。値については、「TargetType」を参照してください。 📒注: instances指定時は指定不要です。object_idと instancesを同時に指定した場合、instancesの内容が優先されます。
metric_type	body	string	任意	監視項目種別空文字を指定した場合、エラーとなります。値については、「監視項目」を参照してください。
interval_duration	body	string	1m/任意	監視間隔 1分単位で設定できます。5分の場合は、5mと設定してください。空文字を指定した場合、エラーとなります。
from	body	string	1m/任意	1分単位で設定できます。集計対象期間ある監視タイミングにおいて、直近のどれくらいの期間のデータを集計対象とするかを設定します。空文字を指定した場合、エラーとなります。
aggregation_function	body	string	任意	集計関数集計期間内の監視データの集計方法を示します。空文字を指定した場合、エラーとなります。値については、「集計関数」を参照してください。
comparison_function	body	string	任意	比較式集計値としきい値の比較式（超過、未満）です。空文字を指定した場合、エラーとなります。以下の文字列が設定できます。 - above - below
threshold	body	decimal	任意	比較値(しきい値や判定値) CPUやメモリ使用率を監視項目とする場合は使用率、ネットワーク帯域の場合は Mbpsというように、比較する監視項目に沿った値です。 metric_typeの単位に対応した値が指定可能です。詳細は「監視項目」を参照してください。
alert_count	body	integer	1/任意	アラーム通知のしきい値監視条件が満たされた状態が何分続いたら alert を上げるかを設定します。
severity	body	string	任意	アラームレベル当項目を設定してもアラームの制御はできません。アラームの情報としてだけ利用可能です。以下の文字が設定できます。 - critical - error - warning - information - none 空文字を指定した場合、アラームレベルを削除します。
enabled	body	bool	true/任意	アラームの状態有効の場合は true、無効の場合は falseで設定します。falseに設定されている場合、アラームの評価は継続して実行されますが、アラームが条件を満たしてもアラームアクションが実行されません。
nodata_alert	body	bool	false/任意	監視データ取得不可時の通知有無有効の場合は true、無効の場合は falseで設定します。アラームアクションにメール通知を設定している、かつ本項目の設定値がtrueの場合、監視条件に合致するデータが取得できない状態を検知するとメール通知を実行します。
alarm_action	body	List<string>	任意	アラームアクション以下のアクションが設定できます。 - mail (メール通知) - autoscale (オートスケール) 空リストを指定した場合、アラームアクションを削除（アクションなしに）します。
autoscale_url	body	string	任意	オートスケールの実行先 `OS::Heat::ScalingPolicy` タイプのリソースの signal urlを指定します。空文字を指定した場合、URLを削除します。
instances	body	List<string>	任意	監視対象仮想サーバ監視対象とする仮想サーバIDをリスト形式で指定できます。 project_idで指定したプロジェクト内に存在する仮想サーバだけ指定できます。このパラメータを設定すると、集合体(aggregate)が自動的に作成されます。空リストを指定した場合、エラーとなります。 📒注: object_idと instancesを同時に指定した場合、instancesの内容が優先されます。

In の列が body となっているパラメータのうち、一つ以上を必ず指定してください。
一つも指定されていない場合、エラーとなります。
リクエストで指定されていないパラメータは、既存の値のままとなります。

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

変更後のアラームの内容を返却します。
id以外のパラメータは、リクエスト時に設定した値が設定されています。
（リクエスト時に設定していないパラメータの値は既存のアラームの値となります）

名前	Type	Description
id	string	アラームID
name	string	アラーム名
description	string	アラームの説明
project_id	string	プロジェクトID
target_type	string	アラーム設定対象のタイプ
object_id	string	アラーム設定対象のオブジェクトID リクエストでinstancesを設定すると、自動で作成された集合体(aggregate)のIDが設定されます。
metric_type	string	監視項目種別
interval_duration	string	監視間隔
from	string	集計対象期間
aggregation_function	string	集計関数
comparison_function	string	比較式
threshold	decimal	比較値
alert_count	integer	アラーム通知のしきい値
severity	string	アラームレベル
enabled	bool	アラームの状態
nodata_alert	bool	監視データ取得不可時の通知有無
alarm_action	List<string>	アラームアクション
instances	List<string>	監視対象仮想サーバ

リクエスト例#

curl -X PUT -H "Content-Type: application/json" \
-H "X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x..." \
-d <リクエストボディ> "https://telemetry.jp-west-3.cloud.global.fujitsu.com/v4.0/alarms/8e39017a-211e-b23f-64b3-26247c6175c7"

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

{
  "alarm": {
    "alarm_action":[],
    "enabled": false
  }
}

レスポンス例#

{
  "alarm": {
    "id": "8e39017a-211e-b23f-64b3-26247c6175c7",
    "name": "cpu_test",
    "description": "alert when cpu usage > 80%",
    "project_id": "a6944d763bf64ee6a275f1263fae0352",
    "target_type": "aggregate",
    "object_id": "1a6877a6-ea01-1aa1-09d7-a6cf9939220b",
    "metric_type": "instance.cpu.usage",
    "interval_duration": "1m",
    "from": "5m",
    "aggregation_function": "avg",
    "comparison_function": "above",
    "threshold": 80.0,
    "alert_count": 3,
    "severity": "critical",
    "enabled": false,
    "nodata_alert": false,
    "alarm_action": []
  }
}