Ausführen von REST-Befehlen

Beispiel: Ausführen einfacher REST-Befehle mit curl

ncurl
-k -u jsmith:passw0rd 
  https://hostname:port/cli/component?active=true
  -X GET

In diesem Beispiel wird der Benutzername jsmith und das Kennwort passw0rd verwendet. In den meisten Fällen erstellen Sie ein dediziertes Benutzerkonto, die die REST-Befehle verwenden, und weisen diesem Konto die entsprechenden Berechtigungen zu.

ncurl
-k -u jsmith:passw0rd 
  https://ucdeploy.example.com:8443/cli/component?active=true
  -X GET

Übergeben von Parametern an REST-Befehle

ncurl
-k -u jsmith:passw0rd 
  "https://ucdeploy.example.com:8443/cli/
  version/getLink?component=JPetStore-APP
  &version=1.0
  &linkName=IBM%20web%20site"

Übergeben von JSON-Zeichenfolgen an Befehle

{
  "description": "Description",
  "enforceCompleteSnapshots": "Specify true to require
     an explicit version for each component",
  "name": "Application name or ID",
  "notificationScheme": "Notification scheme"
}

{
  "description": "My new application",
  "enforceCompleteSnapshots": "false",
  "name": "My Application",
  "notificationScheme": "Default Notification Scheme"
}

ncurl
-k -u jsmith:passw0rd 
  https://ucdeploy.example.com:8443/cli/application/create 
  -X PUT -d @newApplication.json

ncurl
-k -u jsmith:passw0rd 
  https://ucdeploy.example.com:8443/cli/application/create 
  -X PUT
  -d {"description":"My new application",
      "enforceCompleteSnapshots":"false",
      "name":"My Application 67",
      "notificationScheme":"Default Notification Scheme"}

Zusammenstellen von JSON-Zeichenfolgen

Es gibt zwei Hauptmethoden, die Vorlage der JSON-Zeichenfolge für einen Befehl zu erhalten. Die Vorlagen werden in den Referenzinformationen für jeden Befehl aufgelistet. Sie können auch den äquivalenten Befehlszeilenclient-Befehl mit der Option -t ausführen. Wenn Sie den CLI-Befehl mit dieser Option ausführen, wird die JSON-Vorlage ausgedruckt.

Da die Serverschnittstelle die REST-API verwendet, können Sie sich auch wie üblich beim Server anmelden und die Anforderungen überwachen, die die Webanwendung generiert. Sie können diese Anforderungen mit Web-Browser-Erweiterungen oder externen Programmen überwachen. Um beispielsweise die JSON-Zeichenfolge für die PUT-Methode der Ressource resource/create anzusehen, erstellen Sie eine Ressource auf dem Webserver wie üblich und sehen sich dann die JSON-Zeichenfolge in der Browseranforderung an, wie in der nachstehenden Abbildung gezeigt. Die JSON-Zeichenfolge für den REST-Befehl gleicht dieser Zeichenfolge.

Zugriff auf Blueprints in REST-Befehlen

Die meisten Blueprint-Befehle akzeptieren sowohl einen URL-Parameter als auch den Header Location. Beispiel: Der Befehl Get the contents of a blueprint hat zwei Parameter, die auf den Ziel-Blueprint verweisen: der Parameter {blueprintId} in der URL und der Header Location. Wenn Befehle beide Parameter aufweisen, hat der Header Location Priorität. Wenn Sie daher das vollständige Verzeichnis im Header Location angeben wie /landscaper/orion/file/jsmith_8a6bfff7_2c77_45db_a235_adda61ad6653-OrionContent/myTeam/myBlueprint/myBlueprint.yml, verwendet der Befehl diesen Blueprint unabhängig vom Wert des Parameters {blueprintId}. Sie erhalten das Verzeichnis eines Blueprints mit dem Befehl List blueprints.

Ist der Header Location nicht angegeben, verwendet der Befehl den Wert des Parameters {blueprintId}. In diesem Fall geht der Befehl davon aus, dass sich der Blueprint im Standard-Repository befindet. Darüber hinaus wird angenommen, dass der Name der Blueprint-Datei mit dem Wert des Parameters {blueprintId} mit der Erweiterung .yml übereinstimmt.

Antworten