アラートアクション(API)

このAPIでは、アラートのピックアップやピックアップ解除、クリアにくわえ、メモの追加とリストアップができます。

XMLでレスポンスを受けるには

http://[APM Host]:[APM Port]/AppManager/xml/AlarmAction?apikey=[API_KEY]&action=[ACTION_TYPE]&entity=[ALARM_ENTITY]&username=[USER_NAME]&message=[MESSAGE]

JSONでレスポンスを受けるには

http://[APM Host]:[APM Port]/AppManager/json/AlarmAction?apikey=[API_KEY]&action=[ACTION_TYPE]&entity=[ALARM_ENTITY]&username=[USER_NAME]&message=[MESSAGE]

リクエスト パラメーター

フィールド 説明
AppManager_Host Applications Managerのインストール先サーバーです。
AppManager_Port Applications ManagerのWebサーバー ポートを指定します。
api_key 操作を実行しているユーザーのAPIキーを指定します。
action_typee PickupAlarm、UnpickupAlarm、ClearAlarm、AddAnnotation、ListAnnotationsから指定します。
entity [Resource ID of Monitor]_[Attribute ID]形式で指定してください。Applications Managerでアラートの一意の識別子として利用します。
message アラートに付けるメモを記載します。
username アラートのピックアップに使うユーザーの名前を示します。指定がない場合、APIキーのユーザーが利用されます。

XMLでレスポンスを受けるには

http://apm-prod1:9090/AppManager/xml/AlarmAction?apikey=37097301e45784daa94889f35f2509ab&action=ClearAlarm&entity=10000285_527

XMLレスポンスのサンプル

<AppManager-response uri="/AppManager/xml/AlarmAction"><result><response response-code="4000"><message>Successfully Cleared the Alarm!</message></response></result></AppManager-response>

JSONでレスポンスを受けるには

http://apm-prod1:9090/AppManager/json/AlarmAction?apikey=37097301e45784daa94889f35f2509ab&action=ClearAlarm&entity=10000285_527

JSONレスポンスのサンプル

{"response":{"result":[{"message":"Successfully Cleared the Alarm!"}],"uri":"/AppManager/json/AlarmAction"},"response-code":"4000"}