前のトピック: comp オブジェクト

次のトピック: info メソッド(comp オブジェクト)

list メソッド(comp オブジェクト)

説明

アプリケーション コンポーネントを一覧表示します。

構文
/api/v1/comp/list?app=application&vdc=controller-name 
引数
application

アプリケーションの名前

controller-name

ターゲットの仮想データ センターの名前

トランザクション タイプ

同期

リクエスト タイプ

GET

アプリケーション test のコンポーネントを一覧表示します。

GET http://192.168.123.200/api/v1/comp/list?app=test&vdc=mygrid 
サンプル出力

XML

<application>
   <name>sugarcrm</name>
   <components>
       <component>
         <name>main.admin</name>
         <bw>50000000</bw>
         <cpu>0.05</cpu>
         <mem>67108864</mem>
         <server>srv2</server>
         <state>running</state>
      </component>
      <component>
          <name>main.config</name>
         <bw>150000000</bw>
         <cpu>0.20</cpu> 
         <mem>268435456</mem>
          <server>srv3</server>
         <state>running</state>
      </component>
      <component>
         <name>main.dbase</name>
         <bw>100000000</bw>
         <cpu>0.40</cpu>
         <mem>536870912</mem>
         <server>srv1</server>
         <state>running</state>
      </component>
         .
         .
         .
   </components>
</application>



JSON

{
   "component" : [
       {
         "bw" : "50000000",
   nbsp;     "cpu" : "0.05",
         "name" : "main.admin",
         "mem" : "67108864",
         "server" : "srv2",
         "state" : "running"
      }, 
      {
   
      "bw" : "150000000",
         "cpu" : "0.20",
         "name" : "main.config",
         "mem" : "268435456",
         "server" : "srv3",
         "state" : "running"
      }, 
      {
         "bw" : "100000000",
         "cpu" : "0.40",
         "name" : "main.dbase",
         "mem" : "536870912",
         "server" : "srv1",
         "state" : "running"
      }, 
      .
      .
      .
   ],
   "name" : "sugarcrm"
} 

メモ

JSON の出力はすべて UTF8 にエンコードされています。 UTF8 デコードを使用して UTF8 にエンコードされた出力をデコードします。

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

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

HTTP エラー コード
404

エンティティ vdc mygrid が見つかりません。WS_API アプリケーションに設定されていない VDC 名が指定されました。

400.4

必要な引数(app)がありません。リクエストに引数 app=app がありません。

404

アプリケーション test のコンポーネントを一覧表示できませんでした。インストールされていません。リクエストに無効なアプリケーション名が指定されました。

404

アプリケーション ws_api のコンポーネントを一覧表示できませんでした。情報の取得に失敗しました。実行中でないことが原因である可能性があります。 コンポーネント リストをリクエストしたアプリケーションは停止状態にあります。