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
/v3.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 |
|---|---|---|
| EventRuleId | string | アラームID |
| Name | string | アラーム名 |
| IntervalDuration | string | 監視間隔 |
| Severity | string | アラームレベル |
| AggregationFunction | string | アラーム情報集計種別 平均、最大、最小、合計などを示します。 以下の文字列が設定されます。 - average - max - min - sum |
| ProjectId | string | プロジェクトID |
| Threshold | integer | 比較値(しきい値や判定値) CPUやメモリ使用率を監視項目とする場合は使用率、起動状態の場合は判定値というように、比較する監視項目に沿った値です。 詳細は「MetricType」を参照してください。 |
| ComparisonFunction | string | 比較式 同一、超過、未満などを示します。 以下の文字列が設定されます。 - equal - above - below |
| EventRuleScope | string | アラームによって監視される対象の種別 |
| Status | string | アラームの状態 有効、無効を示します。 以下の文字列が設定されます。 - enabled - disabled |
| AggregateId | string | 集合体(aggregate)のID リクエストでInstancesを設定すると、自動で作成された集合体(aggregate)のIDが設定されます。 |
| ConfigurationStatus | string | アラームの定義反映状態 |
| IntervalCount | integer | 監視項目の状態判定回数 |
| MetricType | string | 監視項目種別 値については、「MetricType」を参照してください。 |
| EventRuleType | string | アラーム計測種別 |
| TriggerRuleType | string | トリガー種別 |
| IntervalsWithException | integer | アラーム通知のしきい値 |
| Module | string | アラームモジュール |
| Mode | string | アラーム起動種別 |
| AlarmAction | List<string> | アラームアクション リストが空の場合は何もアクションを行いません。 設定されている場合は対応したアクションを行います。 アクションについては以下の設定があります。 - mail(メール通知) |
リクエスト例#
curl -H "X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x..." \ "https://telemetry.jp-west-3.cloud.global.fujitsu.com/v3.0/alarms/7d4a2a34..."
レスポンス例#
{ "EventRuleId": "5e1cf886-27e2-11eb-a7fc-0242ac120006", "IntervalDuration": "60", "Severity": "none", "AggregationFunction": "average", "ProjectId": "91fc0665ef814cc29193f616e8189e35", "Threshold": 50, "ComparisonFunction": "above", "EventRuleScope": "instance", "Status": "enabled", "ConfigurationStatus": "completed", "TriggerRuleType": "instance", "IntervalCount": 1, "MetricType": "cpu.usage", "EventRuleType": "static", "IntervalsWithException": 1, "Module": "alarms", "Name": "cpu_alarm_high", "Mode": "alert", "AlarmAction":[ "mail" ] }