Integrationshandbücher › Webservice-API-Referenzhandbuch › Generische API-Syntax

Generische API-Syntax

Um eine API-Anfrage für ein Objekt zu initiieren, verwenden Sie einen Befehl mit dem folgenden Format:

GET "http://ws-ip/api/v1/obj/method?arg1=<value>&arg2=<value>&vdc=<grid>"

Erläuterung:: ws-ip ist die IP-Adresse, die verwendet wird, um auf die Anwendung 'WS_API' zuzugreifen.
object ist ein API-Objekt wie "app", "class" usw.
method ist die für das Objekt auszuführende Aktion wie Starten, Anhalten usw.
arg1, arg2 sind die an die Methode übergebenen Argumente.
vdc ist der Name der Grid-Steuerung.
Hinweise

Syntax für geschätzte Optionen: Eine geschätzte Option wird im Allgemeinen im folgenden Format ausgedrückt:
```
<property_name>=<value>
```
Der Wert muss URI-verschlüsselt sein ((Prozent-Verschlüsselung des Uniform Resource Identifier), entsprechend den speziellen Regeln für die Komponente path des URI. Ersetzen Sie ein für das Feld path eines URI ein beliebiges Zeichen, z. B. das Prozentzeichen, Leerzeichen und Tabulator-Taste, Gleichzeichen, Komma, Querstrich, Fragezeichen sowie einzelne oder doppelte Anführungszeichen, mit der jeweiligen prozentverschlüsselten Version "%HH", wobei <3HH<3 für die hexadezimale ASCII-Darstellung des jeweiligen Zeichens steht.

Hinweis: Weitere Informationen zur URI-Verschlüsselung finden Sie unter RFC 3986.

Syntax von Options-Flags: Obwohl das CLI einen doppelten Bindestrich oder "Em-Dash" (—) als ein Präfix zum Bezeichnen eines Optionsflags (in der Regel eine Option ohne einen Wert) verwendet, wird von der Webservices-API stattdessen immer noch das Und-Zeichen (&) als Präfix verwendet. Das heißt, immer wenn das CLI --option verwendet, verwenden die Webservices stattdessen &option. Wenn das CLI beispielsweise --debug aufweist, verwenden die Webservices stattdessen &debug.
Die Beschreibungen der API-Anfragen für ein Objekt umfassen zwar sämtliche obligatorischen Parameter, jedoch nur einige der optionalen Parameter. Die in diesem Handbuch nicht enthaltenen optionalen Parameter werden im Befehlszeilen-Shell-Referenzhandbuch beschrieben.

Beispiel:

Methoden für Objekt "app" aufrufen.
curl http://192.168.123.200/api/v1/obj/info?obj=app&vdc=mygrid

Beispielausgabe:

{
   "method" : [
      {
         "name" : "config"
      },
      {
         "name" : "copy"
      },
      {
         "name" : "create"
      },
      {
         "name" : "destroy"
      },
      aus.
      aus.
      aus.
   ]
}

Ausgabeformate

Die akzeptablen Ausgabeformate können XML oder JSON sein. Sie können in der API-Anfrage angegeben werden.

Beispiel:

Methoden für Objekt "app" in XML-Format aufrufen.

curl http://192.168.123.200/api/v1/obj/info?obj=app&vdc=mygrid -H "Accept: application/xml"

Methoden für Objekt "app" in JSON-Format aufrufen.

curl http://192.168.123.200/api/v1/obj/info?obj=app&vdc=mygrid -H "Accept: application/json"

Hinweis: In JSON ist die gesamte Ausgabe UTF8-codiert. Verwenden Sie einen UTF8-Decodierer, um die UTF8-codierte Ausgabe zu decodieren Es folgt ein Beispiel für ein einfaches PHP-Skript, mit dem UTF8-codierte JSON-Ausgaben decodiert werden:

<? 
$json = '{"a": "\u00e3\u0081\u0082" }'; 
$j = json_decode($json); 
echo utf8_decode($j->{'a'}); 
?>

Dieses Kapitel enthält folgende Themen:

Allgemeine Argumenttypen

Sie können den folgenden allgemeinen Argumenttyp verwenden, der für viele Befehle gebräuchlich ist. Wenn auf einen bestimmten Argumenttyp von einer bestimmten Befehlsbeschreibung Bezug genommen wird, verwenden Sie die folgenden detaillierten Informationen für den zu berücksichtigenden Typ.

<principal>

<principal> stellt eine Persona dar, eine einzelne Person oder eine Gruppe, mit einem bestimmten Umfang, lokal oder global. Geben Sie einen Prinzipal entsprechend einer der folgenden möglichen Syntaxen an:

<name>: Lokale Benutzer oder Gruppen.
/<name>: Globale Benutzer oder Gruppen.
<scope>:<type>:<name>: Ein voll qualifizierter Prinzipalname, wobei <scope> global oder lokal, <type> die Gruppe oder der Benutzer und <name> der Gruppen- oder Benutzername ist.

Hinweis: Ein Prinzipal muss URL-kodiert sein. local:user:api@3tera.com sollte z. B. als local%3Auser%3Aapi%403tera.com übergeben werden.