list-Methode (iface-Objekt)

Integrationshandbücher › Webservice-API-Referenzhandbuch › Zulässige Objekte für CA AppLogic-API › iface-Objekt › list-Methode (iface-Objekt)

list-Methode (iface-Objekt)

Beschreibung

Eine Liste von Komponentenschnittstellen für eine ausgeführte Anwendungskomponente abrufen.

Syntax

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

Argument

app: Name der Anwendung
comp: Name der Komponente
vdc: Name des virtuellen Rechenzentrums (Virtual Data Center), welches das Ziel darstellt

Transaktionsart

synchron

Anfragetyp

GET

Beispiele

Komponentenschnittstelle für "sugarcrm:main.srv1" abrufen.

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

Beispielausgabe

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>
      aus.
      aus.  
      aus.
   </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"
      },
      aus.
      aus.
      aus.
   ],
   "name" : "main.srv1"
}

HTTP-Fehlercodes

404: Entität vdc mygrid nicht gefunden - Es wurde ein VDC-Name angegeben, der in der WS_API-Anwendung nicht konfiguriert worden ist.
400.4: Erforderliche Argumente fehlen (app). - Argument app=app ist in der Anfrage nicht vorhanden.
400.4: Erforderliche Argumente fehlen (comp). - Argument comp=comp ist in der Anfrage nicht vorhanden.
404.1: Schnittstellen für Komponente test:main.srv konnten nicht aufgelistet werden - Anwendung test ist nicht installiert. - In der Anfrage wurde eine ungültige Anwendung angegeben.
404.1: Schnittstellen für Komponente test:main.srv konnten nicht aufgelistet werden - Anwendung test wird nicht ausgeführt. - Die in der Anfrage angegebene Anwendung ist in angehaltenem Status.
404.1: Schnittstellen für Komponente test:main.srv konnten nicht aufgelistet werden - sie befindet sich im angehaltenen Status. - Die in der Anfrage angegebene Komponente befindet sich in angehaltenem Status.
404.1: Schnittstellen für Komponente test:main.srv konnten nicht aufgelistet werden - sie ist nicht vorhanden. - In der Anfrage wurde eine ungültige Komponente angegeben.