ping API

このAPIを利用すると、サーバーや監視のリソースIDに呼応するサーバーにpingができます。pingコマンドの実行後、結果はリクエストへのレスポンスとして引き渡されます。

XMLでのレスポンスを求める構文

http://[APM Host]:[APM Port]/AppManager/xml/ping?apikey=[API_KEY]&resourceid='10000157'

JSONでのレスポンスを求める構文

http://[APM Host]:[APM Port]/AppManager/json/ping?apikey=[API_KEY]&host='hemachand-0591'

リクエスト パラメーター

フィールド 説明
resourceid 監視のリソースIDを指定します。このIDを利用し、呼応するリソースを持ったホストにpingを行います。
host Applications Managerからpingするホストを表し、この値をパラメーターとして渡します。

レスポンス詳細

フィールド 説明
APIKey ユーザー名を特定できます。
説明 ユーザー アカウントの作成時に入力した説明を指します。
EmailID ユーザーのメール アドレスです。
GroupName ユーザーの役割タイプを指定します。operator、admin、managerなどです。
UserImage ユーザー画像のパスを指します。
UserID ユーザーのIDを指します。
UserName ユーザーの名前を指します。

リクエスト サンプル

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

http://prod-server:9090/AppManager/xml/Ping?apikey=apikey=c4e547c2330e2eb92d3e7af2262da9e9&resourceid='10000157'

XMLでのレスポンス

<AppManager-response uri="/AppManager/xml/Ping">
<result>
<response response-code="4000">
<PingResult Output="Pinging 127.0.0.1 with 32 bytes of data:<br>Reply from 127.0.0.1: bytes=32 time<1ms TTL=128<br><br>Ping statistics for 127.0.0.1:<br> Packets: Sent = 1, Received = 1, Lost = 0 (0% loss),<br>Approximate round trip times in milli-seconds:<br> Minimum = 0ms, Maximum = 0ms, Average = 0ms<br>" Host="127.0.0.1" IPAddress="127.0.0.1"/>
</response>
</result>
</AppManager-response>

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

http://apm-prod1:9090/AppManager/json/Ping?apikey=c4e547c2330e2eb92d3e7af2262da9e9&host=apm-prod1

JSONでのレスポンス

{"response-code":"4000","response":{"uri":"/AppManager/json/Ping","result":[{"Output":"Pinging apm-prod1.csez.zohocorpin.com [fe80::51a4:f642:390a:7e1f%14] with 32 bytes of data:<br>Reply from fe80::51a4:f642:390a:7e1f%14: time<1ms <br><br>Ping statistics for fe80::51a4:f642:390a:7e1f%14:<br> Packets: Sent = 1, Received = 1, Lost = 0 (0% loss),<br>Approximate round trip times in milli-seconds:<br> Minimum = 0ms, Maximum = 0ms, Average = 0ms<br>","Host":"apm-prod1.csez.zohocorpin.com","IPAddress":"192.168.26.79"}]}}