Método info (objeto iface)

Guías de integración › Guía de referencia de API de servicio Web › Objetos válidos › Objeto iface › Método info (objeto iface)

Método info (objeto iface)

Descripción

Permite recuperar información para la interfaz de un componente.

Sintaxis

/api/v2/iface/info?app=application&comp=component&iface=interface&vdc=controller-name

Argumentos

app: Nombre de la aplicación
comp: Nombre del componente
iface: Nombre de la interfaz
vdc: Nombre del centro de datos virtual de destino

Tipo de transacción

sincrónica

Tipo de solicitud

GET

Ejemplos

Recuperación de información de un terminal para WS_API_r271:main.srv.

GET
http://10.130.86.146/api/v1/iface/info?app=WS_API_r271&comp=main.api_srv&iface=in&vdc=mygrid

Ejemplo de salida

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

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.
400.4: Faltan argumentos obligatorios (iface): el argumento iface=iface falta en la solicitud.
404.1: No se pudo mostrar información para la interfaz test:main.vpn.ctl: no existe: se ha especificado una interfaz, una aplicación o un componente no válido en la solicitud o la aplicación se encuentra en estado detenido.
404.1: No se pudo mostrar información para la interfaz test:main.srv: se ha producido un error al obtener información: consulte el registro para obtener detalles. El componente especificado en la solicitud no se encuentra en ejecución.