統合ガイド › Web サービス API リファレンスガイド › API の一般的な構文

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 はグリッドコントローラの名前です。
ノート

値のあるオプション構文：値のあるオプションは、通常、以下の形式で表現されます。
```
<property_name>=<value>
```
値は、URI のパスコンポーネントに固有のルールに従って、URI エンコード（Uniform Resource Identifier パーセントエンコーディング）される必要があります。パーセント、スペースおよびタブ、等号、カンマ、スラッシュ、疑問符、一重および二重引用符などの URI のパスフィールド用の任意の予約文字をそのパーセントエンコードされたバージョンの %HH に置換します。ここで、HH は問題の文字の 16 進数の ASCII 表現です。

注： URI エンコーディングの詳細については、RFC 3986 を参照してください。

オプションフラグ構文： CLI はオプションフラグ（通常、値のないオプション）を指定するためにプレフィックスとして二重ハイフンまたは en ダッシュ（—）を使用しますが、Web サービス API は今でもプレフィックスとしてアンパサンド（&）を使用します。そのため、CLI に --option が含まれている場合、Web サービスは代わりに &option を使用します。たとえば、CLI に --debug が含まれている場合、Web サービス 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"

注： JSON の出力はすべて UTF8 にエンコードされています。 UTF8 デコードを使用して UTF8 にエンコードされた出力をデコードします。 UTF8 にエンコードされた JSON 出力をデコードするシンプルな PHP スクリプトの例を以下に示します。

<? 
$json = '{"a": "\u00e3\u0081\u0082" }'; 
$j = json_decode($json); 
echo utf8_decode($j->{'a'}); 
?>

このセクションには、以下のトピックが含まれています。

共通の引数タイプ

以下に示す多くのコマンドに共通の一般的な引数タイプを使用できます。特定のコマンドの説明で特定の引数タイプが参照される場合は、検討するタイプについて以下の詳細情報を使用します。

<principal>

<principal> はペルソナを表します。これは、個人またはグループ、指定されたスコープ、ローカルまたはグローバルを表します。以下の構文のいずれかに従って、プリンシパルを指定します。

<name>

ローカルユーザまたはグループ。

/<name>

グローバルユーザまたはグループ。

<scope>:<type>:<name>

完全修飾プリンシパル名。<scope> は「global」または「local」、<type> は「group」または「user」、<name> はグループ名またはユーザ名になります。

注：プリンシパルは URL エンコードされる必要があります。たとえば、local:user:api@3tera.com は local%3Auser%3Aapi%403tera.com として渡す必要があります