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

Méthode info (objet iface)

Description

Récupérer les informations pour une interface de composant.

Syntaxe

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

Arguments

app

Nom de l'application

comp

Nom du composant

iface

Nom de l'interface

vdc

Nom du centre de données virtuel cible

Type de transaction

Synchrone

Type de requête

GET

Exemples

Pour récupérer les informations relatives au terminal in pour 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

Exemple de sortie

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

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.

400.4

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

404.1

Echec de l'affichage des informations de l'interface test:main.vpn.ctl, car elle n'existe pas. - Une interface, une application ou un composant non valide a été spécifié dans la requête ou l'application est arrêtée.

404.1

Echec de l'affichage des informations de l'interface test:main.srv : échec de l'obtention des informations. Pour en savoir plus, consultez le journal. - Le composant spécifié dans la requête n'est pas en cours d'exécution.