---
sourceDocument: Yokohama IT Operations Management
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/it-operations-management

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama IT Operations Management

ft:clusterId :

    - itom

bundleId :

    - itom

workflow :

    - Technology


---

# Erstellen Sie eine CAPI-API

# Erstellen Sie eine CAPI-API {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 Minuten Lesedauer

Wenn die vorhandenen CAPI-APIs nicht in die CAPI-Schnittstelle für einen Anbieter integriert werden, können Sie eine API erstellen. Die Schritte in Ressourcenblöcken können Ihre API-Methoden aufrufen, wenn Vorgänge ausgeführt werden.

## Vorbereitungen

* Erforderliche Rolle: Administrator
* Überprüfen [Standard-CAPI-APIs](https://servicenow-prod.fluidtopics.net/doYCZUVe4VLip9CtfDxBaw "Mehrere CAPI-APIs werden standardmäßig mit bereitgestellt Cloud Provisioning and GovernanceAnwendung.")Und stellen Sie sicher, dass der Anbieter und das Produkt, die Sie erstellen, nicht vorhanden sind.
* Machen Sie sich mit der Cloud-Provider-API vertraut, damit Sie wissen, wie REST-Aufrufe für den Anbieter erstellt werden. Wenn Sie nicht mit den Headern, Authentifizierungsanforderungen, dem Endpunkt und den Daten vertraut sind, die Sie an die Provider-API übergeben können, können Sie keine eigenen CAPI-Komponenten erstellen.

## Warum und wann dieser Vorgang ausgeführt wird

Dieses Thema enthält Anweisungen zum Erstellen einer CAPI-API. Sie decken auch die Konfiguration von CAPI, Ressourcenblöcken, Blueprints und Anmeldeinformationszuordnungen ab.

## Prozedur

1. In Portal für Cloud-Admin., Navigieren Sie zu DesignCloud-APIan.
2. Klicken Sie auf API Registerkarte.
3. Klicken Sie auf Neu.
4. Füllen Sie die Formularfelder aus (siehe Tabelle):  
   {#create-api__table_ib1_q1k_v2b__entry__2}

   | Feld | Beschreibung |
   |-|-|
   | Cloud-API | Geben Sie einen beschreibenden Namen an. |
   | Schnittstelle | Wählen Sie aus den vorhandenen Schnittstellen aus, die die benötigten Vorgänge bereitstellen. |
   | Connector | Skript-Connector Wird in diesem Feld angezeigt, wenn der Connector ein Java-Connector ist, der sofort verfügbar ist und nicht geändert werden kann. Sie müssen diese Skript-Connectors nicht ändern. |
   | Produkt | Wählen Sie das Produkt aus, das Teil des Anbieters ist. Das Produkt enthält Ressourcentypen in der CMDB. |
   | Version | Geben Sie eine Versionsnummer an, um diese API zu identifizieren. Eingabetaste <kbd class="ph userinput">1,0 </kbd>Ob diese API die erste Version ist. Sie können mehrere Versionen derselben API erstellen und dann in den Vorgangsschritten von Ressourcenblöcken auf die spezifischen Versionen verweisen. |
   | Geskriptet | Dieses Feld ist ausgewählt, wenn Schnittstelle Wert ist Skript-Connector . |
   | Skript-Typ | Wählen Sie die Sprache für das Skript aus. Hinweis: JavaScript wird empfohlen. Die von Zuordnungen verwendete Methode MID-ServerSkripteinbindungen, die in JavaScript geschrieben wurden. |
   | ExecuteScriptOnInstance |   |
   | Beschreibung | Geben Sie eine Beschreibung für diese API an. |
   [ ]

   {#create-api__table_ib1_q1k_v2b}
5. Stellen Sie sicher, dass alle erforderlichen Vorgänge in angezeigt werden CAPI-Methodenzuordnungen Zugehörige Liste.  
   Die Vorgänge in der Liste „CAPI-Methodenzuordnungen" sind die gleichen Vorgänge in der von Ihnen ausgewählten Schnittstelle. Sie sind an diese API gebunden. Sie können der Liste keine Vorgänge hinzufügen oder daraus entfernen. Einige der Vorgänge, insbesondere Azure-Vorgänge, werden verwendet MID-ServerSkripteinbindungen, die die tatsächliche Implementierung für die API durchführen. Das Skript enthält einen Aufruf der REST-API für den Anbieter, z. B. AWS oder Azure. Sie sollten die API in der Dokumentation des Anbieters finden können.
6. So zeigen Sie die Skripteinbindung für eine CAPI-Methodenzuordnung an:
   1. Klicken Sie auf das Zahnradsymbol ( ![Zahnradsymbol]()) Auf CAPI-Methodenzuordnungen Zugehörige Liste, fügen Sie hinzu Anforderungsskript Feld für Ausgewählt Und klicken Sie dann auf OK .  
      Die MID-ServerSkripteinbindungen werden jetzt in der Liste der Methodenzuordnungen angezeigt.
   2. Klicken Sie auf den Namen eines Skripts, um die Skripteinbindung anzuzeigen.  
      In diesem Beispiel ist Knoten erstellen Vorgang verwendet azure-compute-1.0-CreateNodeSkripteinbindung.  
      Diese Skripteinbindung enthält den folgenden Code:


          createNode();
          function createNode(){
             var acp = new AzureComputeVirtualMachine(this.parameters, this.headers);
              //this passes the parameters and headers into the AzureComputeVirtualMachine script include.
             var vm = acp.createVirtualMachine();

             return vm;
          }

      Beachten Sie, dass der Code aufruft AzureComputeVirtualMachineSkripteinbindung, die standardmäßig mit verfügbar ist Cloud Provisioning and GovernanceAnwendung. Enthält alle API-Aufrufe für Azure für virtuelle Computer.
7. Erstellen Sie eine API-Konfigurationsüberschreibung, um die erforderlichen Anmeldeinformationen an den Cloud-Anbieter zu übergeben.  
   Sie müssen auch Header-Informationen übergeben, die von der REST-API des Cloud-Providers erforderlich sind. Überschreibungen der API-Konfiguration sind erforderlich, da Anmeldeinformationsdaten nicht enthalten sind, wenn Ihre Instanz den REST-Aufruf an die Cloud-Provider-API durchführt.  
   Tipp:  
   Wenn Sie nicht wissen, welche API-Konfigurationsüberschreibungen erstellt werden sollen, sehen Sie sich eine ähnliche API an, die in CAPI vorhanden ist, und verwenden Sie dieselben Überschreibungen. Wenn Sie beispielsweise eine API für AWS-Speicher erstellen, sehen Sie sich andere AWS-APIs wie AWS-Blockspeicher oder AWS-Compute an.
   1. Klicken Sie in der zugehörigen Liste API-Konfigurationsüberschreibung auf Neu .
   2. Klicken Sie auf das Suchsymbol, und wählen Sie einen vorhandenen Konfigurationsparameter aus.  
      Viele nützliche Parameter werden standardmäßig bereitgestellt, z. B. Identität , Anmeldeinformationen , Und so weiter.
   3. Geben Sie ein Wert überschreiben .  
      Sie können einen statischen Wert festlegen oder einen Wert aus dem System in Form von abrufen `$(CloudAnmeldeinformationen.Attribute_Name) `. Die `CloudAnmeldeinformationen `Teil entsperrt sie aus dem Anmeldeinformationsspeicher. Die `Attributname `Teil ist ein Attribut, das von den jeweiligen Anmeldeinformationen, Alias oder Endpunkt-URL abhängt, die Sie abrufen möchten.  
      Wenn Sie zu navigieren Verbindungen und AnmeldeinformationenAnmeldeinformationen Und öffnen Sie Ihre AWS-Anmeldeinformationen. Sie können mit der rechten Maustaste auf klicken Zugriffsschlüssel-ID Und zeigen Sie den Namen der Spalte in der Tabelle „Anmeldeinformationen" an, in der der Zugriffsschlüssel gespeichert ist. In diesem Fall wird der Zugriffsschlüssel in gespeichert `Access_key `Spalte. Daher sollte Ihr Überschreibungswert sein <kbd class="ph userinput">$(CloudCredential.Access_key) </kbd>.
8. Wenn Sie einen Konfigurationsparameter erstellen müssen, der in der API-Konfigurationsüberschreibung verwendet werden soll, gehen Sie wie folgt vor:
   1. Klicken Sie im Formular „API-Konfigurationsüberschreibung" auf das Suchsymbol in Konfigurationsparameter Feld.
   2. Klicken Sie Auf Neu Im Fenster Konfigurationsparameter, und füllen Sie dann das Formular aus.  
      {#create-api__table_fbs_y4b_n2b__entry__2}

      | Feld | Beschreibung |
      |-|-|
      | Konfigurationsparametername | Geben Sie einen beschreibenden Namen ein. |
      | Standardwert | Legen Sie einen optionalen Standardwert fest. |
      | Endpunkt | Dieses Feld ist schreibgeschützt. |
      | Beschreibung | Geben Sie eine hilfreiche Beschreibung ein. |
      | Konfigurationsdatentypen | Wählen Sie den Datentyp aus: * Zeichenfolge * DateTime * Datum * Lang * Passwort * Boolean {#create-api__ul_x3g_f5b_n2b} |
      | Konfigurationstyp | Wählen Sie den Typ der Konfiguration aus: * Header: Verwenden Sie diesen Wert, um die Überschreibungswerte als Header zu übergeben. Wenn Sie einen haben MID-ServerSkripteinbindung als Teil Ihrer API und wird verwendet `This.Header `Als Parameter werden die Überschreibungswerte an die Provider-API übergeben. * Konfiguration * URI-Konfiguration {#create-api__ul_i53_35b_n2b} |
      [ ]

      {#create-api__table_fbs_y4b_n2b}
9. Ändern Sie bei Bedarf die Skripteinbindungen, die die Vorgänge für die Cloud-Provider-API ausführen:
   1. Klicken Sie im Formular Cloud-API in der zugehörigen Liste CAPI-Methodenzuordnungen auf das Informationssymbol ( ![Informationssymbol]()) Neben dem CAPI-Schnittstellenvorgang.  
      Klicken Sie nicht selbst auf den Namen des CAPI-Schnittstellenvorgangs.
   2. Klicken Sie auf Datensatz öffnen.
   3. Im Vorgangsformular können Sie die folgenden Feldwerte ändern:  
      {#create-api__table_y4k_xyb_n2b__entry__2}

      | Feld | Beschreibung |
      |-|-|
      | Endpunktvorgang | Behalten Sie den Standard bei Skript Ausführen Endpunktvorgang. |
      | Unterstützt in Version | Sie müssen diesen Wert normalerweise nicht ändern. Ändern Sie Unterstützt in Version zur Verwendung der Methodenzuordnung in einer anderen Version der API. Standardmäßig sind die Methodenzuordnungen auf dieselbe Versionsnummer festgelegt wie die API, zu der sie gehören. |
      |   |   |
      [ ]

      {#create-api__table_y4k_xyb_n2b}
   4. In Anforderungsskript Klicken Sie auf das Informationssymbol ( ![Infosymbol]()) Neben dem Platzhalter MID-ServerSkripteinbindung zum Ändern.
   5. Erstellen Sie im Formular „Skripteinbindung" Ihr Skript.  
      Das folgende Beispiel für JavaScript listet Azure-Lastenausgleichsmodule auf. Beachten Sie die hilfreichen Kommentare:  


          getResourceInfo();

          function getResourceInfo() {
          	var anpi = new AzureLoadBalancer(this.parameters, this.headers);
                 
                 //this calls the 'AzureLoadBalancer' MID-Server script include, which in turn
                 //calls the 'AzureCloudAPIBase' script include, both of which 
                 //are already in your instance by default. 
                 //The 'AzureCloudBase' script include runs a query for resources of a given type in a
          	//specified region.

          	var items = anpi.listResourcesByRegionOrIDs();
                 //This function is in the 'AzureCloudAPIBase' script include. It calls the Azure API.

          	return items;
          }

      Die für diesen Vorgang bereitgestellten Überschreibungen sind das, was Azure benötigt, um die Lastenausgleichsmodule zu finden: Client-ID, Mandanten-ID, geheimer Schlüssel und Endpunkt-URL:

      Für das Google Cloud-Integrationsbeispiel: MID-ServerJAR-Datei ist ebenfalls erforderlich.
   6. Klicken Sie auf Absenden.
   7. Ändern Sie die Skripteinbindung für jeden Vorgang.