Método list (objeto iface)

Guías de integración › Guía de referencia de API de servicio Web › Objetos válidos › Objeto iface › Método list (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/v2/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

Recupera la interfaz de componente para 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

Ejemplo de salida

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"
}

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.