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

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

説明

コンポーネント インターフェースの情報を取得します。

構文

/api/v2/iface/info?app=application&comp=component&iface=interface&vdc=controller-name 

引数

app

アプリケーションの名前

comp

コンポーネントの名前

iface

インターフェースの名前

vdc

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

トランザクション タイプ

同期

リクエスト タイプ

GET

例

WS_API_r271:main.srv の入力端子の情報を取得します。

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

サンプル出力

XML：

<interface>
  <connections>
    <connection>
      <loc_addr>F269030022000000</loc_addr>
      <loc_ip>1.24.34.11</loc_ip>
      <rem_addr>F2690300220E0000</rem_addr>
      <rem_ip>1.24.34.14</rem_ip>
      <type>None</type>
    </connection>
    <connection>
      <loc_addr>F269030022000000</loc_addr>
      <loc_ip>1.24.34.11</loc_ip>
      <rem_addr>F269030022150000</rem_addr>
      <rem_ip>1.24.34.10</rem_ip>
      <type>None</type>
    </connection>
  </connections>
  <device></device>
  <ip>1.24.34.11</ip>
  <mac>F2:69:03:00:22:00</mac>
  <name>in</name>
  <network>backbone</network>
  <state>active</state>
  <type>input</type>
  <vlan_id>0</vlan_id>
</interface>

JSON：

{
   "network" : "backbone",
   "connections" : [
      {
         "loc_ip" : "1.24.34.11",
         "rem_addr" : "F2690300220E0000",
         "rem_ip" : "1.24.34.14",
         "type" : "None",
         "loc_addr" : "F269030022000000"
      },
      {
         "loc_ip" : "1.24.34.11",
         "rem_addr" : "F269030022150000",
         "rem_ip" : "1.24.34.10",
         "type" : "None",
         "loc_addr" : "F269030022000000"
      }
   ],
   "ip" : "1.24.34.11",
   "name" : "in",
   "device" : "",
   "state" : "active",
   "vlan_id" : "0",
   "type" : "input",
   "mac" : "F2:69:03:00:22:00"
}

HTTP エラー コード

404

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

400.4

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

400.4

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

400.4

必要な引数（iface）がありません。 リクエストに引数 iface=iface がありません。

404.1

インターフェース test:main.vpn.ctl の情報を表示できませんでした。存在しません。 リクエストで無効なインターフェース、アプリケーションまたはコンポーネントが指定されているか、アプリケーションが停止状態にあります。

404.1

インターフェース test:main.srv の情報を表示できませんでした。詳細はログを参照してください。 リクエストで指定されたコンポーネントは実行されていません。