Méthode info (objet iface)

Manuels d'intégration › Manuel de référence de l'API de service Web › Objets valides pour l'API CA AppLogic › 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/v1/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 d'entrée du composant sugarcrm:main.srv1 :

GET http://192.168.123.200/api/v1/iface/info?app=sugarcrm&comp=main.srv1&iface=in&vdc=mygrid

Exemple de sortie

XML

<interface>
   <name>in</name>
   <connections>
       <name>connections[0]</name>
      <loc_addr>F2640A00361E0000</loc_addr>
       <loc_ip>10.80.54.18</loc_ip>
      <rem_addr>F2640A0036350000</rem_addr>
       <rem_ip>10.80.54.17</rem_ip>
      <type>None</type>
    </connections>
    <device>eth0</device>
   <ip>10.80.54.18</ip>
   <mac>F2:64:0A:00:36:1E</mac>
   <state>active</state>
   <type>input</type>
</interface>

JSON

{
   "connections" : {
       "connections[0]" : {
         "loc_ip" : "10.80.54.18",
         "rem_addr" : "F2640A0036350000",
         "rem_ip" : "10.80.54.17",
         "type" : "None",
         "loc_addr" : "F2640A00361E0000"
      }
   },
   "ip" : "10.80.54.18",
   "name" : "in",
   "type" : "input",
   "mac" : "F2:64:0A:00:36:1E",
   "device" : "eth0",
   "state" : "active"
}

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.