Argomento precedente: Metodo list (oggetto iface)Argomento successivo: Metodo enable (oggetto iface)

Guide di integrazione › Guida di riferimento API del servizio Web › Oggetti validi › Oggetto iface › Metodo info (oggetto iface)

Metodo info (oggetto iface)
Description

Recupera le informazioni per l'interfaccia di un componente

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

Nome dell'applicazione

comp

Nome del componente

iface

Nome dell'interfaccia

vdc

Nome del data center virtuale di destinazione

Tipo di transazione

sincrona

Tipo di richiesta

GET

Esempi

Recupera le informazioni per il terminale in per 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
Output di esempio
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"
}
Codici di errore HTTP
404

Entità vdc mygrid non trovata - È stato specificato un nome di VDC non configurato nell'applicazione WS_API.

400.4

Argomenti necessari mancanti (app). - Argomento app=app mancante nella richiesta.

400.4

Argomenti necessari mancanti (comp). - Argomento comp=comp mancante nella richiesta.

400.4

Argomenti necessari mancanti (iface). - Argomento iface=iface mancante nella richiesta.

404.1

Impossibile visualizzare le informazioni per l'interfaccia test:main.vpn.ctl - L'interfaccia non esiste. - Interfaccia applicazione o componente specificati nella richiesta non validi o applicazione in stato di interruzione.

404.1

Impossibile visualizzare le informazioni per l'interfaccia test:main.srv - Raccolta informazioni non riuscita. Per ulteriori informazioni, consultare il log. - Il componente specificato nella richiesta non è in esecuzione.