ListActions API
このAPIでは、ユーザーに関連付いた監視に設定したアクションを、リストアップできます。アクションはタイプごとにグループ化されます。
構文
XMLでAPIレスポンスを取得
http://[ APM Host ]:[ APM Port ]/AppManager/xml/ListActions?apikey=[API_KEY]&type=all
JSONでAPIレスポンスを取得
http://[ APM Host ]:[ APM Port ]/AppManager/json/ListActions?apikey=[API_KEY]&type=all
将来の機能拡張に、次の項目を予定しています。
1：Adminサーバーでの当APIサポート
2：タイプを基準としたリストアップ
リクエスト パラメーター
| フィールド | 説明 |
|---|---|
| type | 取得するアクションのタイプを指定します。全タイプのアクションを取得するには、「all」としてください。指定がない場合も、全タイプを返します。 |
レスポンス詳細
| フィールド | 説明 |
|---|---|
| DisplayName | アクションの表示名を指定してください。 |
| Action | ID：アクションIDを指定します。 ExecuteActionPath：アクション実行URIを指定します。 NAME：アクションの名前を指定します。 ActionProps：メール送信元、宛先、本文（FROMADDRESS、TOADDRESS、MESSAGE）など、アクションのプロパティを指定します。アクション タイプにより設定内容が異なります。 |
リクエスト サンプル
入力XML：
http://apm-prod1:9090/AppManager/xml/ListActions?apikey=c4e547c2330e2eb92d3e7af2262da9e9&type=all
レスポンスXML：
<AppManager-response uri="/AppManager/xml/ListActions">
<result>
<response response-code="4000">
<Actions DisplayName="SMS Action(s)">
<Action ID="10000003" ExecuteActionPath="/common/executeSMS.do?method=testAction&remote=true&actionID=10000003" NAME="SMS">
<ActionProps MESSAGE="This information has been generated by the Applications Manager" FROMADDRESS="karthi@zohomail.com" TOADDRESS="karthi@zohomail.com" />
</Action>
</Actions>
</response>
</result>
</AppManager-response>
JSONでレスポンスを受けるには：
http://apm-prod1:9090/AppManager/json/ListActions?apikey=c4e547c2330e2eb92d3e7af2262da9e9&type=all
JSON Response
{"response-code":"4000","response":{"uri":"/AppManager/json/ListActions","result":[{"Action":[{"ID":"20000003","ExecuteActionPath":"/common/executeAction.do?method=testAction&remote=true&actionID=20000003","NAME":"alert_mail","ActionProps":{"FROMADDRESS":"user1@zohocorp.com","TOADDRESS":"user2@zohocorp.com","SUBJECT":"Alarm from the Applications Manager"}}],"DisplayName":"E-mail Action(s)"}]}}