メールアクションAPI

このAPIでは、アラート発生時に送るメールを設定できます。GETリクエストとPOSTリクエストをサポートしています。

リクエスト パラメーター

このAPIリクエストにかかわるパラメーターは、次の通りです。

フィールド 説明
emailactionname アクションの表示名です。メール アクションの表示名に特殊文字を使う場合は、以下のようにしてください。
  • #は%23に置き換えます。
  • &は%26に置き換えます。
  • +は%2Bに置き換えます。

これにより、emailactionnameのパラメーターを、REST APIに引き渡せます。
subject メールの件名です。
messaged メールの本文です。
businesstype

次の値を設定できます。

  • 1：業務時間内での実行を指定します。
  • 0：業務時間外での実行を指定します。
mailformat メール形式を、HTML・プレーン テキスト・双方から選択してください。
smtpserver SMTPサーバーを実行しているホストの、IPアドレスかホスト名を指定します。
smtpport SMTPポートです。デフォルトでは25となっています。
businesshouraction trueの指定で、業務時間をアクションに関連付け可能となります。
businessid ビジネスIDを指定してください。
appendmessage メールにApplications Managerが作成したアラート情報を付加するか、選択します（true、false）。
toaddress 受信者アドレスを指定します。
fromaddress 送信者アドレスを指定します。

メール作成アクション

管理者はこのAPIで、Applications Managerのメール アクションを作成できます。

構文

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

http://[APM Host]:[APM Port]/AppManager/xml/actions/emailaction?apikey=[API_KEY]&subject=[ Subject]&businesstype=[TYPE]&mailformat=[HTML/Plain Text/Both]&smtpserver=[SNMP_SERVER]&fromaddress=[SENDER_ADDRESS]&emailactionname=[NAME]&businesshouraction=[true/false]&message=[MESSAGE_TEXT]&businessid=[BUSINESS_ID]&toaddress=[RECERIVER_ADDRESS]&appendmessage=[true/false]&smtpport=[PORT]

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

http://[APM Host]:[APM Port]/AppManager/json/actions/emailaction?apikey=[API_KEY]&subject=[ Subject]&businesstype=[TYPE]&mailformat=[HTML/Plain Text/Both]&smtpserver=[SNMP_SERVER]&fromaddress=[SENDER_ADDRESS]&emailactionname=[NAME]&businesshouraction=[true/false]&message=[MESSAGE_TEXT]&businessid=[BUSINESS_ID]&toaddress=[RECERIVER_ADDRESS]&appendmessage=[true/false]&smtpport=[PORT]

例

http://app-windows:59090/AppManager/xml/actions/emailaction?apikey=09eebdd6893db4d20e16b84dff6664f1&subject=(Admin) Alarm from Applications Manager&businesstype=1&mailformat=both&smtpserver=smtp&fromaddress=vijay@appmanager.com&emailactionname=Applications Manager&businesshouraction=true&message=This information has been generated by Applications Manager&businessid=10000&toaddress=vijayakumar.mariappan@zohocorp.com&appendmessage=true&smtpport=25

メール更新アクション

管理者はこのAPIで、Applications Managerのメール アクションを編集できます。

構文

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

http://[APM Host]:[APM Port]/AppManager/xml/actions/emailaction?apikey=[API_KEY]&subject=[SUBJECT]&businesstype=[BUSINESS_TYPE]&mailformat=[HTML/Plain Text/Both]&smtpserver==[SNMP_SERVER]&fromaddress=[SENDER_ADDRESS]&emailactionname=[NAME]&businesshouraction=[true/false]&message=[MESSAGE_TEXT]&emailactionid=[ID]&businessid=[BUSINESS_ID]&toaddress=[RECEIVER_ADDRESS]&appendmessage=[true/false]&displayname=[DISPLAY_NAME]&smtpport=[PORT]

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

http://[APM Host]:[APM Port]/AppManager/json/actions/emailaction?apikey=[API_KEY]&subject=[SUBJECT]&businesstype=[BUSINESS_TYPE]&mailformat=[HTML/Plain Text/Both]&smtpserver==[SNMP_SERVER]&fromaddress=[SENDER_ADDRESS]&emailactionname=[NAME]&businesshouraction=[true/false]&message=[MESSAGE_TEXT]&emailactionid=[ID]&businessid=[BUSINESS_ID]&toaddress=[RECEIVER_ADDRESS]&appendmessage=[true/false]&displayname=[DISPLAY_NAME]&smtpport=[PORT]

例

http://app-windows:59090/AppManager/xml/actions/emailaction?apikey=09eebdd6893db4d20e16b84dff6664f1&subject=(Admin) Alarm from Applications Manager&businesstype=0&mailformat=html&smtpserver=smtp&fromaddress=vijay@appmanager.com&businesshouraction=true&message=This information has been generated by Applications Manager&emailactionid=10000&businessid=10000&toaddress=vijayakumar.mariappan@zohocorp.com&appendmessage=true&displayname=Applications Manager&smtpport=25

メール削除アクション

管理者はこのAPIで、Applications Managerのメール アクションをdeleteできます。

構文

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

http://[APM Host]:[APM Port]/AppManager/xml/actions/emailaction?apikey=[API_KEY]&emailactionid=[Business Id],&TO_DELETE=true

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

http://[APM Host]:[APM Port]/AppManager/json/actions/emailaction?apikey=[API_KEY]&emailactionid=[Business Id],&TO_DELETE=true

例

http://app-windows:59090/AppManager/xml/actions/emailaction?apikey=09eebdd6893db4d20e16b84dff6664f1&emailactionid=10000,&TO_DELETE=true

メール リスト アクション

管理者はこのAPIで、メール アクションをリストアップできます。

構文

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

http://[APM Host]:[APM Port]/AppManager/xml/actions/emailaction?apikey=[API_KEY]

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

http://[APM Host]:[APM Port]/AppManager/json/actions/emailaction?apikey=[API_KEY]

例

http://app-windows:59090/AppManager/xml/actions/emailaction?apikey=09eebdd6893db4d20e16b84dff6664f1