Méthode list (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 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/v1/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 sugarcrm:main.srv1 :

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

Exemple de sortie

XML

<component>
   <name>main.srv1</name>
   <interfaces>
       <interface>
         <name>aux</name>
          <ip>10.80.54.26</ip>
         <mac>F2:64:0A:00:36:22</mac>
          <state>idle</state>
         <type>output</type>
      </interface>
      <interface>
         <name>db</name>
         <ip>10.80.54.23</ip>
         <mac>F2:64:0A:00:36:1F</mac>
         <state>idle</state>
          <type>output</type>
      </interface>
      <interface>
          <name>default</name>
         <ip>10.80.54.43</ip>
          <mac>F2:64:0A:00:36:25</mac>
         <state>active</state>
          <type>raw</type>
      </interface>
      .
      .  
      .
   </interfaces>
</component>

JSON

{
   "interface" : 
      {
         "ip" : "10.80.54.26",
         "name" : "aux",
         "type" : "output",
         "mac" : "F2:64:0A:00:36:22",
         "state" : "idle"
      },
       {
         "ip" : "10.80.54.23",
         "name" : "db",
         "type" : "output",
         "mac" : "F2:64:0A:00:36:1F",
         "state" : "idle"
      },
       {
         "ip" : "10.80.54.43",
         "name" : "default",
         "type" : "raw",
         "mac" : "F2:64:0A:00:36:25",
         "state" : "active"
      },
      .
      .
      .
   ],
   "name" : "main.srv1"
}

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.