Get the history of an alarm#

指定されたクエリに基づいて、指定されたアラームの履歴を取得します。

アラームの履歴は、作成するアラームの種別によって登録されるタイミングと条件が異なります。
タイミングと条件は以下のとおりです。

  • 監視サービスのAPIやIaaSポータルからアラームを作成した場合
    アラームに設定された間隔で、定期的に状態を監視し、アラームの状態が変更されたことを検知したタイミングで履歴が登録されます。
    監視サービスのAPIやIaaSポータルについては、機能説明書の「アラームとは」を参照してください。

  • オーケストレーションでアラームを作成した場合
    アラームに設定された間隔で定期的に状態を監視し、条件に一致している場合は履歴を登録します。
    また、条件に一致し続ける場合は、監視を行うごとに履歴を登録します。
    オーケストレーションについては、機能説明書の「オーケストレーション機能とは」を参照してください。

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

/v3.0/alarm/history/{alarm_id}

HTTPステータスコード#

正常時：200

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

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

名前 In Type デフォルト値
/必須指定		 Description
alarm_id path string 必須 アラームID
X-Auth-Token header string 必須 認証のトークン
start query string 任意 開始日時(3桁のミリ秒を含む13桁のUNIX時刻)
end query string 任意 終了日時(3桁のミリ秒を含む13桁のUNIX時刻)
alarm_type query string 任意 特定のアラームの状態を指定し抽出します。
アラームの条件一致、条件不一致、無効などを設定します。
以下の値が指定できます。
- active: 条件一致
- inactive: 条件不一致
- disabled: 無効化
- triggered: 条件一致(オーケストレーション)

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

名前 Type Description
eventRuleId string アラームID
name string アラーム名
description string 発生したアラームの詳細内容
timestampStr string アラーム発生時間(3桁のミリ秒を含む13桁のUNIX時刻)
state string 発生したアラームの状態
アラームの条件一致、条件不一致、無効などを示します。
アラームの作成方法によって設定される内容は、以下のとおり異なります。

- 監視サービスのAPIやIaaSポータルからアラームを作成した場合
以下の文字列が設定されます。
  - active: 条件一致
  - inactive: 条件不一致
  - disabled: アラーム無効

- オーケストレーションでアラームを作成した場合
以下の文字列が設定されます。
  - triggered: 条件一致
entityType string アラーム対象の種別
entityId string アラーム対象のID
kind string アラーム種別
intervalDuration string 監視間隔
severity string アラームレベル
module string アラームモジュール
intervalCount string 監視項目の状態判定回数
intervalsWithException integer アラーム通知のしきい値
actionId string アラームの履歴ID
Threshold integer 比較値(しきい値や判定値)
CPUやメモリ使用率を監視項目とする場合は使用率、起動状態の場合は判定値というように、比較する監視項目に沿った値です。
詳細は「MetricType」を参照してください。
metricType string 監視項目種別
値については、「MetricType」を参照してください。
mode string アラーム起動種別
aggregationFunction string アラーム情報集計種別
平均、最大、最小、合計などを示します。
以下の文字列が設定されます。
- average
- max
- min
- sum
comparisonFunction string 比較式
同一、超過、未満などを示します。
以下の文字列が設定されます。
- equal
- above
- below
apiVersion string アラームで使用する内部apiのバージョン
alarmAction List<string> アラームアクション
リストが空の場合は何もアクションを行いません。
設定されている場合は対応したアクションを行います。
アクションについては以下の設定があります。
- mail:(メール通知)

リクエスト例#

curl -H "X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x..." \
 "https://telemetry.jp-west-3.cloud.global.fujitsu.com/v3.0/alarm/history/7d4a2a34..."

レスポンス例#

{
  "actionHistorys": [
    {
      "actionId": "k5ipek1ce8cqj1t",
      "entityId": "ansible_bare_host__172_29_1_30",
      "timestampStr": "1506046255000",
      "description": "Host ansible_bare_host__172_29_1_30: average cpu.usage above 80 {u\u0027Sample_Value\u0027: 87.21}",
      "entityType": "host",
      "state": "active",
      "kind": "Alarm",
      "aggregationFunction": "average",
      "intervalDuration": 60,
      "severity": "error",
      "module": "alarms",
      "intervalCount": 1,
      "metricType": "cpu.usage",
      "name": "test01",
      "eventRuleId": "1hk82tb1ce8cqiih",
      "mode": "alert",
      "intervalsWithException": 1,
      "threshold": 80,
      "comparisonFunction": "equal",
      "apiVersion": "v1",
      "alarmAction": "[mail]"
    }
  ]
}