Eine CAPI-Schnittstelle erstellen oder erweitern

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 1 Minute Lesedauer
  • Sie können eine neue CAPI-Schnittstelle erstellen oder eine vorhandene erweitern, indem Sie neue Vorgänge hinzufügen.

    Vorbereitungen

    • Erforderliche Rolle: admin
    • Überprüfen Sie Standard-CAPI-APIs und stellen Sie sicher, dass weder Anbieter noch Produkte, die Sie erstellen möchten, bereits vorliegen.
    • Machen Sie sich mit der Cloud-Anbieter-API vertraut, damit Sie wissen, wie REST-Aufrufe an den Anbieter erstellt werden. Wenn Sie mit Headern, Authentifizierungsanforderungen, Endpunkt und Daten, die Sie an die Provider-API übergeben können, nicht vertraut sind, können Sie keine eigenen CAPI-Komponenten erstellen.

    Warum und wann dieser Vorgang ausgeführt wird

    Normalerweise können Sie die Standardschnittstellen verwenden, die in der Anwendung Cloud Provisioning and Governance bereitgestellt werden. Für das Erstellen einer benutzerdefinierten Schnittstelle sollte eine ähnliche, bereits bestehende als Basis verwendet werden.

    Prozedur

    1. Navigieren Sie in Portal für Cloud-Admin.zu Design > Cloud-API, und klicken Sie dann auf die Registerkarte Schnittstelle.
    2. Klicken Sie auf Neu.
    3. Geben Sie im Fenster „Add Cloud interface“ (Cloudschnittstelle hinzufügen) einen Namen für die Schnittstelle und eine hilfreiche Beschreibung ein, und wählen Sie die relevanteste Kategorie aus, der die API-Schnittstelle angehören soll.

      Dieses Beispiel zeigt eine Schnittstelle für Azure-Speicher:

      Azure-Speicherschnittstelle

    4. Klicken Sie in der zugehörigen Liste für CAPI-Schnittstellenvorgänge auf New (Neu).

      Jeder Vorgang, den Sie erstellen, entspricht einem anderen REST API-Aufruf.

    5. Geben Sie einen Namen für den Vorgang an, der der API entspricht, die Sie im Anbieter aufrufen möchten.

      Beispielsweise können Sie einen Vorgang namens CreateContainer erstellen, der dem Vorgang „Create Container“ (Container erstellen) in Azure entspricht.

      Container erstellen

    6. Klicken Sie mit der rechten Maustaste auf die Kopfzeile und wählen Sie Speichern.
    7. Klicken Sie in der zugehörigen Liste „Schnittstellen-Vorgangsparameter“ auf Neu.
    8. Erstellen Sie einen Parameter, den der Vorgang gemäß der Definition der REST API-Dokumentation des Cloud-Anbieters benötigt.

      Wenn Sie die Parameter nicht kennen, schlägt der Vorgang fehl. Im Beispiel mit Azure-Speicher muss der Vorgang CreateContainer den Namen des Containers haben, der hier als ContainerName bezeichnet wird.

      Containername

    9. Klicken Sie auf Absenden.
    10. Fügen Sie so viele Parameter hinzu, wie Sie für den Vorgang benötigen, und fügen Sie dann alle erforderlichen Vorgänge hinzu.

    Nächste Maßnahme

    Eine CAPI-API erstellen