SDK

X-MON API が手軽にご利用いただけるように、PHPによるライブラリを用意いたしました。

SDKファイルのダウンロード

以下、ご利用いただけるサーバの環境です。

SDKファイルはこちらよりダウンロードください。

ダウンロード

対応サーバ環境	PHP 5.2.0 以上
md5	88dfe2bc44a55bb719af497bd1351216

リクエスト先URL

リクエスト先URL(X-MONサーバ)は、以下になります。PHPライブラリクラスをご利用の際に指定します。

(X-MONサーバURL)/1.0/xmon_api.php

クラス

クラス名は、XmonApiです。インスタンスを生成する際の引数は以下になります。

第一引数	リクエスト先URL
第二引数	X-MON APIアクセスキー画面にて発行した "user_id" の値
第三引数	X-MON APIアクセスキー画面にて発行した "auth_token" の値

メソッド

setMethod()	利用したいリクエストメソッド名を引数に指定します。例) setMethod('hosts.get');
setParams()	パラメータを指定する場合、setParams()メソッドを利用します。必須項目ではありませんので、リクエストにご不要な場合は指定する必要はございません。 json data {"params":{"key":"X-MON"}} を指定する場合、setParams(array('key' => 'X-MON'));と指定します。
request()	X-MONサーバに対し、リクエスト送信を行う際に利用します。リクエスト先URLの指定や、setMethod()の指定に誤りがある場合、PHPの例外処理を返します。実行例は以下の例をご確認ください。

setMethod()

利用したいリクエストメソッド名を引数に指定します。

例) setMethod('hosts.get');

setParams()

パラメータを指定する場合、setParams()メソッドを利用します。必須項目ではありませんので、リクエストにご不要な場合は指定する必要はございません。

json data {"params":{"key":"X-MON"}} を指定する場合、setParams(array('key' => 'X-MON'));と指定します。

request()

X-MONサーバに対し、リクエスト送信を行う際に利用します。

リクエスト先URLの指定や、setMethod()の指定に誤りがある場合、PHPの例外処理を返します。

実行例は以下の例をご確認ください。

実行例

ホストX-MONの情報を取得する

リクエスト

<?php require_once 'XmonApi.php'; // SDKファイルの呼び出し // インスタンス生成 $XmonApi = new XmonApi( 'http://192.168.10.58/1.0/xmon_api.php', 'admin', 'ce1ddf8452bd1c10533cf695f4cbe767cccedf5f' ); try { $XmonApi->setMethod('hosts.get'); // 利用メソッドの指定 // 利用オプションの指定 $XmonApi->setParams( array( 'key' => 'X-MON' ) ); // リクエスト $res = $XmonApi->request(); var_dump($res); } catch (Exception $e) { // リクエスト失敗時 echo $e->getMessage(); }

レスポンス

array(3) { ["jsonrpc"]=> string(3) "2.0" ["result"]=> array(1) { [0]=> array(59) { ["id"]=> string(5) "X-MON" ["host_name"]=> string(5) "X-MON" ["alias"]=> string(5) "X-MON" ["address"]=> string(9) "127.0.0.1" ["display_name"]=> NULL ["parents"]=> NULL ["hostgroups"]=> NULL ["check_command"]=> string(16) "check-host-alive" // 省略 ["initial_state"]=> string(2) "up" } } } ["id"]=> string(40) "6a32c8b1bf5b96d7a9ccc5d67708259acdabbf4c" }