API の一般的な構文

オブジェクトの API リクエストを開始するには、以下の形式でコマンドを使用します。

GET "http://ws-ip/api/v1/obj/method?arg1=<value>&arg2=<value>&vdc=<grid>"

各項目の説明：

ws-ip は「WS_API」アプリケーションにアクセスするために使用される IP アドレスです。
obj は、アプリケーション、クラスなどの API オブジェクトです。
method は、開始、停止などのようにオブジェクトに実行されるアクションです。
arg1 と arg2 はメソッドに渡される引数です。
vdc はグリッド コントローラの名前です。

メモ

• "--" が CLI パラメータに含まれている場合、関連する WS API パラメータでは "&" が使用されます。

  例： CLI に "--option" が含まれている場合、WS API では "&option" が代わりに使用されます。

  CLI に "--debug" が含まれている場合、WS API では "&debug" が代わりに使用されます。

• オブジェクトの API リクエストを開始すると、必須パラメータのみがリスト表示されます。 残りのパラメータはオプションで、「コマンド ライン シェル リファレンス ガイド」で参照できます。

例：

オブジェクト アプリケーションのメソッドを取得します。
curl http://192.168.123.200/api/v1/obj/info?obj=app&vdc=mygrid

出力例：

{
   "method" : [
      {
         "name" : "config"
      },
      {
         "name" : "copy"
      },
      {
         "name" : "create"
      },
      {
         "name" : "destroy"
      },
      .
      .
      .
   ]
}

出力形式

受け入れ可能な出力形式は XML または JSON です。 これらは API リクエスト内で指定できます。

例：

オブジェクト アプリケーションのメソッドを XML 形式で取得します。

curl http://192.168.123.200/api/v1/obj/info?obj=app&vdc=mygrid -H "Accept: application/xml"

オブジェクト アプリケーションのメソッドを JSON 形式で取得します。

curl http://192.168.123.200/api/v1/obj/info?obj=app&vdc=mygrid -H "Accept: application/json"