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

Metodo list (oggetto iface)

Description

Recupera un elenco di interfacce per un componente dell'applicazione in esecuzione.

Sintassi

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

Argomenti

app

Nome dell'applicazione

comp

Nome del componente

vdc

Nome del data center virtuale di destinazione

Tipo di transazione

sincrona

Tipo di richiesta

GET

Esempi

Recupera l'interfaccia di un componente per 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 

Output di esempio

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

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.

404.1

Impossibile elencare le interfacce dell'elenco per il componente test:main.srv - La verifica dell'applicazione non è installata. - Applicazione non valida specificata nella richiesta.

404.1

Impossibile elencare le interfacce dell'elenco per il componente test:main.srv - La verifica dell'applicazione non è in esecuzione. - L'applicazione specificata nella richiesta è in stato di interruzione.

404.1

Impossibile elencare le interfacce per il componente test:main.srv - è 'interrotto'. - Il componente specificato nella richiesta è in stato di interruzione.

404.1

Impossibile elencare le interfacce per il componente test:main.srv - Non esiste. - Componente non valido specificato nella richiesta.