監視追加（API）

このAPIでは、Applications Managerに監視の設定ができます。サポートする監視は次の通りです。

リクエスト パラメーター

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

フィールド 説明
apikey * 「管理」タブのAPIキーの作成で生成したキーを指定してください。
displayname * 監視の表示名です。
subnet サーバーが稼働しているサブネットを指定します。デフォルト値は225.225.225.0です。
pollInterval サーバーへのポーリング間隔を指定します。この変数は任意項目です。指定が無ければ、デフォルト値の5分を採用します。
groupID（haid）

監視グループのIDです。Applications Managerで監視グループIDを調べる方法は、次の通りとなります。

  • 監視グループ テーブルで、グループ名をクリックしてください。監視グループ詳細ページが開きます。
  • 監視グループ詳細ページのURLは次のフォーマットです。

    http://app-windows:9090/showapplication.do?&method=showApplication&haid=10000040

  • URLにあるhaidは、対象とするグループのIDを指定しています。この場合は、10000040です。
resolvedns 値は「true」か「false」にしてください。単一DNS名に複数システムのIPアドレスがある場合は、DNS名を解決しないでください。
credentialID Applications Managerが認証情報にセットする一意の識別子です。
ラベル リソースに割り当てたラベルです。

*は必須項目です

代理管理者として新規監視を追加する

代理管理者として新規監視を追加する場合は、APIのURLに次のパラメーターを付加してください。

フィールド 説明        
addToGroup * 監視を監視グループに追加するか指定します。値は、trueかfalseです。
groupID * 監視の追加先とする監視グループのIDを指定します。

*必須項目

リクエスト サンプル

http://app-windows:9090/AppManager/AppManager/xml/AddMonitor?apikey=f746be1da5fb1a2668b00251742ccd2d&type=SilverStream&displayname=sliverstream&host=hostname&port=8081&ManagedServerID=1&addToGroup=true&groupID=10069

Enterprise EditionでAdminサーバーから新規監視を追加する

Enterprise EditionのAdminサーバーで新規監視を追加する場合、Managedサーバーは好みで選択可能です。APIのURLに次のパラメーターを付加してください。

フィールド 説明        
ManagedServerID * 新規監視の追加先となるManagedサーバーを、IDで指定するものです。
ManagedServerGroupName * 規監視の追加先となるManagedサーバーを、グループ名で指定するものです。

パラメーターを指定しない場合は、Managedサーバーは負荷にもとづき決定します。

メモ：
表示名やパスワードで、パラメーターで特殊文字を使うには、HTMLエンコードが必要です。例えば、パスワードに、#、&、%、+が含まれる場合は、APIにパスワードを渡す際、以下のように置き換えをする必要があります。
#は%23に置き換えます。
&は%26に置き換えます。
%は%25に置き換えます。
+は%2Bに置き換えます。
その他の記号のエンコード法などは、MDN Web Docs（Mozilla開発者情報）や、w3schools.com（簡易テスト ツールあり）を参照ください。
既存の監視にAddMonitor APIを使うと、表示名が変わります。

リクエスト サンプル

こちらの例では、Windows ServerをApplications Managerに追加しています。

http://app-windows:9090/AppManager/xml/AddMonitor?apikey=0b0fd47feeff9050d6a45dd7b5bb5791&type=servers&displayname=APM-Windows&host=hostname&snmptelnetport=161&os=WindowsXP&mode=SNMP&username=administrator&password=vembu

出力例

<AppManager-response uri="/AppManager/xml/AddMonitor">
   <result>
      <response response-code="4000">
         <message>Monitor added successfully.</message>
      </response>
   </result>
</AppManager-response>

サンプル エラー

APIを実行できない場合はリクエスト失敗となり、エラーが返ります。

<Apm-response uri="/AppManager/xml/AddMonitor">
   <result>
      <response response-code="4225">
         <message>The transaction mentioned inthe request URL should be yes or no.</message>
      </response>     
    </result>
</Apm-response>

Adminサーバーでの新規監視追加のサンプル

  • ManagedServerID

    サンプル：http://app-windows:9090/AppManager/xml/AddMonitor?apikey=627b1432529fbace2867388e6abf15e&type=mssql&displayname=mssql&username=sa&host=hostname&password=password@123&port=1433&instance=&authentication=SQL&ManagedServerID=2

  • ManagedServerGroupName

    サンプル：http://app-windows:9090/AppManager/xml/AddMonitor?apikey=627bce9dvsdv0db9fbace2867388e6abf15e&type=mssql&displayname=mssql&username=sa&host=hostname&password=password@123&port=1433&instance=&authentication=SQL&ManagedServerGroupName=WIN4

よくあるエラーの発生状況は、エラー対応の解説ページで確認ください。