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

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


list メソッド(iface オブジェクト)
説明

実行中のアプリケーション コンポーネントのコンポーネント インターフェースのリストを取得します。

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

アプリケーションの名前

comp

コンポーネントの名前

vdc

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

トランザクション タイプ

同期

リクエスト タイプ

GET

sugarcrm:main.srv1 のコンポーネント インターフェースを取得します。

GET http://192.168.123.200/api/v1/iface/list?app=sugarcrm&comp=main.srv1&vdc=mygrid 
サンプル出力
XML:
<component>
   <name>main.srv1</name>
   <interfaces>
       <interface>
         <name>aux</name>
          <ip>10.80.54.26</ip>
         <mac>F2:64:0A:00:36:22</mac>
          <state>idle</state>
         <type>output</type>
      </interface>
      <interface>
         <name>db</name>
         <ip>10.80.54.23</ip>
         <mac>F2:64:0A:00:36:1F</mac>
         <state>idle</state>
          <type>output</type>
      </interface>
      <interface>
          <name>default</name>
         <ip>10.80.54.43</ip>
          <mac>F2:64:0A:00:36:25</mac>
         <state>active</state>
          <type>raw</type>
      </interface>
       
         
       
   </interfaces>
</component> 
JSON:
{
   "interface" : 
      {
         "ip" : "10.80.54.26",
         "name" : "aux",
         "type" : "output",
         "mac" : "F2:64:0A:00:36:22",
         "state" : "idle"
      },
       {
         "ip" : "10.80.54.23",
         "name" : "db",
         "type" : "output",
         "mac" : "F2:64:0A:00:36:1F",
         "state" : "idle"
      },
       {
         "ip" : "10.80.54.43",
         "name" : "default",
         "type" : "raw",
         "mac" : "F2:64:0A:00:36:25",
         "state" : "active"
      },
       
       
       
   ],
   "name" : "main.srv1"
} 

HTTP エラー コード
404

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

400.4

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

400.4

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

404.1

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

404.1

コンポーネント test:main.srv のインターフェースを一覧表示できませんでした。アプリケーション test が実行されていません。 リクエストで指定されたアプリケーションは停止状態にあります。

404.1

コンポーネント test:main.srv のインターフェースを一覧表示できませんでした。「停止」状態にあります。 リクエストで指定されたコンポーネントは停止状態にあります。

404.1

コンポーネント test:main.srv のインターフェースを一覧表示できませんでした。存在しません。 リクエストに無効なコンポーネントが指定されています。