Manuels d'intégration › Manuel de référence de l'API de service Web › Objets valides › Objet iface › Méthode list (objet iface)

Méthode list (objet iface)

Description

Récupérer une liste d'interfaces pour un composant d'application en cours d'exécution

Syntaxe

/api/v2/iface/list?app=application&comp=composant&vdc=nom_contrôleur 

Arguments

app

Nom de l'application

comp

Nom du composant

vdc

Nom du centre de données virtuel cible

Type de transaction

Synchrone

Type de requête

GET

Exemples

Pour récupérer l'interface du composant 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 

Exemple de sortie

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

Codes d'erreur HTTP

404

L'entité vdc mygrid est introuvable - Le nom de VDC spécifié n'est pas configuré dans l'application WS_API.

400.4

Missing required arguments (app). - La requête ne contient pas l'argument app=application.

400.4

Missing required arguments (comp). - La requête ne contient pas l'argument comp=composant.

404.1

Echec de l'énumération des interfaces du composant test:main.srv : l'application test n'a pas été installée. - Une application non valide a été spécifiée dans la requête.

404.1

Echec de l'énumération des interfaces du composant test:main.srv : l'application test n'est pas en cours d'exécution. - L'application spécifiée dans la requête est arrêtée.

404.1

Echec de l'énumération des interfaces du composant test:main.srv, car son état est Arrêté. - Le composant spécifié dans la requête est arrêté.

404.1

Echec de l'énumération des interfaces du composant test:main.srv, car il n'existe pas. - Un composant non valide a été spécifié dans la requête.