集成指南 › 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 的 in 终端的信息。

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 的信息－获取信息失败－有关详细信息，请参阅日志。 －请求中指定的组件未运行。