exec-Methode (comp-Objekt)

Integrationshandbücher › Webservice-API-Referenzhandbuch › Gültige Objekte › comp-Objekt › exec-Methode (comp-Objekt)

exec-Methode (comp-Objekt)

Description

Einen Shell-Befehl auf einer angegebenen Anwendungskomponente ausführen.

Syntax

/api/v2/comp/exec?app=test&comp=component&cmd=command&vdc=controller-name

Argument

app: Name der Anwendung
comp: Name der Komponente
cmd: Shell-Befehl, der ausgeführt werden soll.
vdc: Name des virtuellen Rechenzentrums (Virtual Data Center), welches das Ziel darstellt

Transaktionsart

synchron

Anfragetyp

GET

Beispiele

Ausführen des Befehls "vmstat" auf der Komponente test::mon.

GET http://192.168.123.200/api/v2/comp/exec?app=test&comp=main.mon&cmd=’vmstat’&vdc=mygrid

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: Anwendung "test" ist nicht vorhanden. - Ein ungültiger Anwendungsname wurde in der Anfrage angegeben.
404.1: Die Komponente "main.mon" ist nicht vorhanden. - Ein ungültiger Komponentenname wurde in der Anfrage angegeben.

Hinweis: Der Befehl wird nur ausgeführt, wenn für die Anwendung mit der Zielkomponente eine ACL festgelegt ist, die den Benutzer, der die Webservices-API darstellt, zum Steuern der Anwendung autorisiert.