集成指南 › Web 服务 API 参考指南 › 有效对象 › iface 对象 › list 方法（iface 对象）

list 方法（iface 对象）

说明

检索正在运行的应用组件的组件接口列表。

语法

/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 的接口－它不存在。 －请求中指定的组件无效。