アラーム履歴一覧取得(GET /v2/alarms/{alarm_id}/history)
指定されたクエリに基づいて、指定されたアラームの履歴を取得します。
{alarm_id}:対象のアラームのIDを指定します。
Request Headers
「API共通項目」を参照してください。
Request Parameter
q.field
以下の検索対象のフィールドを指定します。
- timestamp:アラーム履歴の日時
- type:アラーム履歴の種類
未指定の場合は、対象のアラームの全履歴を出力します。
Data Type | Cardinality |
---|---|
String | 0..10 |
q.op
以下の比較演算子を指定します。
- q.fieldがtimestampの場合
gt:より大きい
ge:より大きいか等しい
lt:より小さい
le:より小さいか等しい
- q.fieldがtypeの場合
eq:等しい
未指定の場合は、"eq"が設定されます。
Data Type | Cardinality |
---|---|
String | 0..10 |
q.value
以下の比較対象データの値を指定します。
- q.fieldがtimestampの場合
日時(YYYY-MM-DDThh:mm:ss)
- q.fieldがtypeの場合
creation
rule change
state transition
deletion
action
Data Type | Cardinality |
---|---|
String | 0..10 |
limit
取得するアラーム履歴の最大数を指定します。
範囲:1~1440
未指定の場合は、1440が設定されます。
Data Type | Cardinality |
---|---|
Int | 0..1 |
offset
取得するアラーム履歴のオフセットとなる件数を指定します。
未指定の場合は、0が設定されます。
Data Type | Cardinality |
---|---|
Int | 0..1 |
Response Headers
ステータス
正常の場合は以下のステータスを返却します。
200:正常終了
異常の場合は、「API共通エラー情報」を参照してください。
Data Type | Cardinality |
---|---|
Int | 1..1 |
Response Elements
指定されたクエリに基づいて、アラームの履歴のリストをJSON形式で返します。
内容の詳細は、「type AlarmChange」を参照してください。
Example of Request
例1:指定したアラームの履歴を取得する。
curl -H 'X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x...' \
'https://telemetry.jp-east-1.cloud.global.fujitsu.com/v2/alarms/55c6a768-e8ab-487b-b724-892b0ad4fc2a/history'
例2:指定したアラームの特定の時間範囲の履歴を取得する。
curl -H 'X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x...' \
'https://telemetry.jp-east-1.cloud.global.fujitsu.com/v2/alarms/
55c6a768-e8ab-487b-b724-892b0ad4fc2a/history?q.field=timestamp&q.op=
gt&q.value=2014-10-22T00:00:00&q.field=timestamp&q.op=lt&q.value=
2014-10-24T00:00:00'
Example of Response
[
{
"alarm_id": "55c6a768-e8ab-487b-b724-892b0ad4fc2a",
"detail": "{\"state\": \"alarm\"}",
"event_id": "0c83ea48-d2c0-4cf9-8e54-fbebc463c313",
"on_behalf_of": "39bd0d0341484a1a88f8ecdb1b21311c",
"project_id": "39bd0d0341484a1a88f8ecdb1b21311c",
"timestamp": "2014-10-22T05:16:47.683476",
"type": "state transition",
"user_id": "9953aae1953a4caab3cc278e3018cf68"
},
{
"alarm_id": "55c6a768-e8ab-487b-b724-892b0ad4fc2a",
"detail": "{\"alarm_actions\": [], \"user_id\": \"9953aae1953a4caab3cc278e3018cf68\", \"name\": \"my_alarm\", \"state\": \"insufficient data\", \"timestamp\": \"2014-10-22T05:15:54.954117\", \"enabled\": true, \"state_timestamp\": \"2014-10-22T05:15:54.954117\", \"rule\": {\"meter_name\": \"my_meter\", \"evaluation_periods\": 1, \"period\": 120, \"statistic\": \"avg\", \"threshold\": 0.0, \"query\": [], \"comparison_operator\": \"gt\", \"exclude_outliers\": false}, \"alarm_id\": \"55c6a768-e8ab-487b-b724-892b0ad4fc2a\", \"time_constraints\": [], \"insufficient_data_actions\": [], \"repeat_actions\": false, \"ok_actions\": [], \"project_id\": \"39bd0d0341484a1a88f8ecdb1b21311c\", \"type\": \"threshold\", \"description\": \"testAlarm\"}",
"event_id": "5846db80-b465-40c1-a158-e4a178ceb0ed",
"on_behalf_of": "39bd0d0341484a1a88f8ecdb1b21311c",
"project_id": "39bd0d0341484a1a88f8ecdb1b21311c",
"timestamp": "2014-10-22T05:15:54.954117",
"type": "creation",
"user_id": "9953aae1953a4caab3cc278e3018cf68"
}
]