Tema anterior: Objeto iface

Tema siguiente: Método info (objeto iface)


Método list (objeto iface)
Descripción

Permite recuperar una lista de interfaces de componente para un componente de la aplicación que esté en ejecución.

Sintaxis
/api/v1/iface/list?app=application&comp=component&vdc=controller-name 
Argumentos
app

Nombre de la aplicación

comp

Nombre del componente

vdc

Nombre del centro de datos virtual de destino

Tipo de transacción

sincrónica

Tipo de solicitud

GET

Ejemplos

Recuperación de la interfaz de componente para sugarcrm:main.srv1

GET http://192.168.123.200/api/v1/iface/list?app=sugarcrm&comp=main.srv1&vdc=mygrid 
Ejemplo de salida
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"
} 

Códigos de error de HTTP
404

Entidad mygrid de vdc no encontrada: se ha especificado un nombre de VDC que no está configurado en la aplicación WS_API.

400.4

Faltan argumentos obligatorios (app): el argumento app=app falta en la solicitud.

400.4

Faltan argumentos obligatorios (comp): el argumento comp=comp falta en la solicitud.

404.1

No se pudieron enumerar interfaces para el componente test:main.srv: la aplicación test no está instalada: se ha especificado una aplicación no válida en la solicitud.

404.1

No se pudieron enumerar interfaces para el componente test:main.srv: la aplicación test no se está ejecutando: la aplicación especificada en la solicitud se encuentra en estado detenido.

404.1

No se pudieron enumerar interfaces para el componente test:main.srv: la aplicación se encuentra en estado "detenido": el componente especificado en la solicitud se encuentra en estado detenido.

404.1

No se pudieron enumerar interfaces para el componente test:main.srv: no existe: se ha especificado un componente no válido en la solicitud.