Get a single 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#

GET

/v4.0/alarms/{alarm_id}

HTTPステータスコード#

正常時：200

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

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

名前 In Type デフォルト値
/必須指定		 Description
alarm_id path string 必須 アラームのID
X-Auth-Token header string 必須 認証のトークン

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

名前 Type Description
id string アラームID
name string アラーム名
description string アラームの説明
project_id string プロジェクトID
target_type string アラーム設定対象のタイプ
値については、「TargetType」を参照してください。
object_id string アラーム設定対象のオブジェクトID
値については、「TargetType」を参照してください。
metric_type string 監視項目種別
値については、「監視項目」を参照してください。
interval_duration string 監視間隔
from string 集計対象期間
ある監視タイミングにおいて、直近のどれくらいの期間のデータを集計対象とするかを示します。
aggregation_function string 集計関数
集計期間内の監視データの集計方法を示します。
値については、「集計関数」を参照してください。
comparison_function string 比較式
集計値としきい値の比較式（超過、未満）です。
以下の文字列のいずれかが設定されます。
- above
- below
threshold decimal 比較値(しきい値や判定値)
CPUやメモリ使用率を監視項目とする場合は使用率、ネットワーク帯域の場合は Mbpsというように、比較する監視項目に沿った値です。
詳細は「監視項目」を参照してください。
alert_count integer アラーム通知のしきい値
監視条件が満たされた状態が何分続いたら alert を上げるかを設定します。
severity string アラームレベル
enabled bool アラームの状態
有効(true)/無効(false)のどちらかが示されます。
falseに設定されている場合、アラームの評価は継続して実行されますが、アラームが条件を満たしてもアラームアクションが実行されません。
nodata_alert bool 監視データ取得不可時の通知有無
有効の場合は true、無効の場合は falseで設定します。アラームアクションにメール通知を設定している、かつ本項目の設定値が trueの場合、監視条件に合致するデータが取得できない状態を検知するとメール通知を実行します。
alarm_action List<string> アラームアクション
リストが空の場合は何もアクションを実行しません。
設定されている場合は対応したアクションを実行します。
アクションについては以下の設定があります。
- mail (メール通知)
- autoscale (オートスケール)
autoscale_url string オートスケールの実行先
OS::Heat::ScalingPolicy タイプのリソースの signal urlが示されます。

リクエスト例#

curl -H "X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x..." \
"https://telemetry.jp-west-3.cloud.global.fujitsu.com/v4.0/alarms/8e39017a-211e-b23f-64b3-26247c6175c7"

レスポンス例#

{
  "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": true,
    "nodata_alert": true,
    "alarm_action": [
      "mail"
    ]
  }
}