generateAlert API

アラート生成用のAPIとパラメーターを、下記、説明します。

構文

http://localhost:14170/AppManager/xml/generateAlert?apikey=[API_KEY]&resourceid=[RESOURCE_ID]&attributeid=[ATTRIBUTE_ID]&severity=[SEVERITY_AS_NUMBER]&alarmMessage=[CAUSE_FOR_ALERT]

リクエスト パラメーター

APIリクエストに関わる共通パラメーターを、下に説明します。

フィールド 説明
resourceid * アラート発生元の監視や監視グループのリソースIDを指定します。
attributeid * 障害のある属性のIDです。
entity 上記の2つを指定するか、entityをresourceid_attributeid形式で指定してください。
severity*

生成するアラートの重要度を指定します（1は重大、4は警告、5はクリア）。
alarmMessage * アラートの原因を示す、テキストのカスタム メッセージです。これが冒頭に付加されるため、ポーリングにより発生したアラートと、このAPIから発生したアラートを区別できます。
actualAlarmMessage カスタム メッセージにRCAメッセージの付加を望まない場合、アラートMessageの代わりにこのパラメーターを利用できます。アラートMessageとactualAlarmMessageの双方を指定すると、後者が優先されます。
eventParams このパラメーターには、JSONオブジェクトもリクエスト パラメーターも渡すことができます。SyncEventServletをアラート同期に利用し、JSONに対応しました。このAPIで大きな変更なしにアラート同期が可能です。

メモ：*の記載があるパラメーターは必須項目です。

リクエスト サンプル

http://localhost:14170/AppManager/xml/generateAlert?apikey=XXXXXXXXXXXXXXXXX&resourceid=10000140&attributeid=400&severity=1&alarmMessage=test message

または、

http://localhost:2105/AppManager/xml/generateAlert?apikey=XXXXXXXXXXXXXXXXXXXX&eventParams={entity:10000138_402,severity:5,alarmMessage:test_alert}

制限事項

  1. 監視や監視グループのステータスは、直接変更できません。
  2. アラート生成にはトラップ属性IDを利用しており、トラップ リスナーは設定済みの監視や監視グループに影響を与えません。