集成指南 › Web 服务 API 参考指南 › CA AppLogic API 的有效对象 › iface 对象 › list 方法（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 的接口－它不存在。 －请求中指定的组件无效。