Integrationshandbücher › Webservice-API-Referenzhandbuch › Gültige Objekte › iface-Objekt › list-Methode (iface-Objekt)

list-Methode (iface-Objekt)

Description

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

Syntax

/api/v2/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 "WS_API_r271:main.srv" abrufen.

GET http://10.130.86.146/api/v1/iface/list?app=WS_API_r271&comp=main.api_srv&vdc=mygrid 

Beispielausgabe

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>
    aus.
    aus.
    aus.
    <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"
      },
      aus.
      aus.
      aus.
      {
         "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"
}

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.