統合ガイド › Web サービス API リファレンス ガイド › 有効なオブジェクト › iface オブジェクト › list メソッド（iface オブジェクト）

list メソッド（iface オブジェクト）

説明

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

構文

/api/v/api/v2/iface/list?app=application&comp=component&vdc=controller-name 

引数

app

アプリケーションの名前

comp

コンポーネントの名前

vdc

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

トランザクション タイプ

同期

リクエスト タイプ

GET

例

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

GET http://10.130.86.146/api/v1/iface/list?app=WS_API_r271&comp=main.api_srv&vdc=mygrid 

サンプル出力

XML：

<component>
  <interfaces>
    <interface>
      <ip>0.0.0.0</ip>
      <mac>F2:69:03:00:22:01</mac>
      <name>db</name>
      <network>backbone</network>
      <state>idle</state>
      <type>output</type>
      <vlan_id>0</vlan_id>
    </interface>
     
     
     
    <interface>
      <ip>1.24.34.3</ip>
      <mac>F2:69:03:00:22:02</mac>
      <name>fs</name>
      <network>backbone</network>
      <state>active</state>
      <type>output</type>
      <vlan_id>0</vlan_id>
    </interface>
  </interfaces>
  <name>main.api_srv</name>
</component>

JSON：

{
   "interface" : [
      {
         "network" : "backbone",
         "ip" : "0.0.0.0",
         "name" : "db",
         "type" : "output",
         "mac" : "F2:69:03:00:22:01",
         "state" : "idle",
         "vlan_id" : "0"
      },
      {
         "network" : "backbone",
         "ip" : "1.24.34.20",
         "name" : "default",
         "type" : "raw",
         "mac" : "F2:69:03:00:22:07",
         "state" : "active",
         "vlan_id" : "0"
      },
       
       
       
      {
         "network" : "backbone",
         "ip" : "1.24.34.3",
         "name" : "fs",
         "type" : "output",
         "mac" : "F2:69:03:00:22:02",
         "state" : "active",
         "vlan_id" : "0"
      }
   ],
   "name" : "main.api_srv"
}

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 のインターフェースを一覧表示できませんでした。存在しません。 リクエストに無効なコンポーネントが指定されています。