アラーム一覧取得(GET /v2/alarms)

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

Request Headers

API共通項目」を参照してください。

Request Parameter

q.field

以下の検索対象のフィールドを指定します。

  • alarm_id:アラームのID
  • enabled:アラーム評価の有効/無効
  • name:アラームの名前
  • user_id:アラームを作成したユーザーのID

未指定の場合は、対象の全アラームを出力します。

Data Type Cardinality
String 0..10

q.op

以下の比較演算子を指定します。

  • q.fieldがalarm_idの場合

    eq:等しい

  • q.fieldがenabledの場合

    eq:等しい

  • q.fieldがnameの場合

    eq:等しい

  • q.fieldがuser_idの場合

    eq:等しい

未指定の場合は、"eq"が設定されます。

Data Type Cardinality
String 0..10

q.value

以下の比較対象データの値を指定します。

  • q.fieldがalarm_idの場合

    アラームのID

  • q.fieldがenabledの場合

    true:有効

    false:無効

  • q.fieldがnameの場合

    アラームの名前

  • q.fieldがuser_idの場合

    ユーザーID

使用可能文字:全角文字、半角英数字、半角記号

文字数:1~255文字

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 Alarm」を参照してください。

Example of Request

例1:アラームの一覧を取得します。


curl -H 'X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x...' \
'https://telemetry.jp-east-1.cloud.global.fujitsu.com/v2/alarms'
     

例2:アラーム評価が有効になっているアラームの一覧を取得します。


curl -H 'X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x...' \
'https://telemetry.jp-east-1.cloud.global.fujitsu.com/v2/alarms?q.field=enabled&q.value=true'
     

Example of Response


[
    {
        "alarm_actions": [],
        "alarm_id": "55c6a768-e8ab-487b-b724-892b0ad4fc2a",
        "description": "testAlarm",
        "enabled": true,
        "insufficient_data_actions": [],
        "name": "my_alarm",
        "ok_actions": [],
        "project_id": "39bd0d0341484a1a88f8ecdb1b21311c",
        "repeat_actions": false,
        "severity": "low",
        "state": "insufficient data",
        "state_timestamp": "2014-10-22T05:20:46.795969",
        "threshold_rule": {
            "comparison_operator": "gt",
            "evaluation_periods": 1,
            "exclude_outliers": false,
            "meter_name": "my_meter",
            "period": 120,
            "query": [],
            "statistic": "avg",
            "threshold": 0.0
        },
        "time_constraints": [],
        "timestamp": "2014-10-22T05:15:54.954117",
        "type": "threshold",
        "user_id": "9953aae1953a4caab3cc278e3018cf68"
    }
]