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

info-Methode (iface-Objekt)

Description

Informationen für eine Komponentenschnittstelle abrufen

Syntax

/api/v2/iface/info?app=application&comp=component&iface=interface&vdc=controller-name 

Argument

app

Name der Anwendung

comp

Name der Komponente

iface

Name der Schnittstelle

vdc

Name des virtuellen Rechenzentrums (Virtual Data Center), welches das Ziel darstellt

Transaktionsart

synchron

Anfragetyp

GET

Beispiele

Informationen für Terminal "in" für "WS_API_r271:main.srv" abrufen.

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

Beispielausgabe

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

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.

400.4

Erforderliche Argumente fehlen (iface). - Argument iface=iface ist in der Anfrage nicht vorhanden.

404.1

Informationen für Schnittstelle test:main.vpn.ctl konnten nicht angezeigt werden - sie ist nicht vorhanden. - Ungültige Schnittstelle, Anwendung oder Komponente in der Anfrage angegeben, oder die Anwendung befindet sich in angehaltenem Status.

404.1

Informationen für Schnittstelle test:main.srv konnten nicht angezeigt werden - Informationsabfrage ist fehlgeschlagen - siehe Protokoll für Details. - Die in der Anfrage angegebene Komponente wird nicht ausgeführt.