--- 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 --- # Cloud-API (CAPI) # Cloud-API (CAPI) {#ariaid-title1} * Freigeben Version: Yokohama * * Aktualisiert 30. Januar 2025 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 6 Minuten Lesedauer Die Cloud-API (CAPI) ermöglicht die Integration Cloud Provisioning and GovernanceMit Cloud-Anbietern, die REST-APIs verwenden. ## CAPI-Komponenten {#cloud-management-api__section_phl_yt4_x2b} Die Integration mit Cloud-Anbietern erfolgt über REST-Aufrufe, z. B. PUT, GET, POST und DELETE. CAPI bietet das Framework für Sie zur Integration einer REST-API von Cloud-Anbietern, damit Ihre Instanz mit dem Cloud-Anbieter kommunizieren kann, um Cloud-Ressourcen zu verwalten. Siehe Um mehr zu erfahren. CAPI enthält diese Komponenten: Abbildung : 1. CAPI-Übersicht Provider : Cloud-Anbieter sind die Clouds, mit denen Sie eine Verbindung herstellen können. Standardmäßig Cloud Provisioning and GovernanceEnthält die am häufigsten verwendeten Anbieter, z. B. AWS, Azure und VMware. Jeder Anbieter verfügt über viele Produkte, von denen jedes Ressourcentypen bereitstellt. Jeder Ressourcentyp ist einem einzelnen CI-Typ zugeordnet. Beispiel: AWS providerEnthält AWS Elastic Compute CloudProdukt, das enthält AWS::EC2::InstanceRessourcentyp. Dieser Ressourcentyp ist eine der häufigsten Cloud-Ressourcen, die Sie erstellen können. Es wird direkt dem CI-Typ der VM-Instanz \[cmdb_ci_vm_instance\] zugeordnet, in der virtuelle Computer in der CMDB gespeichert werden. Schnittstellen : Schnittstellen definieren das Framework, das das System benötigt, um die REST-Aufrufe zu strukturieren, die die Cloud-Provider-APIs erwarten. Schnittstellen definieren Vorgänge , Auch aufgerufen Methoden , Und Parameter Die jede Methode erfordert. Schnittstellen sind wiederverwendbar. Wenn Sie CAPI erweitern, um neue Produkte und APIs einzubeziehen, können Sie vorhandene Schnittstellen verwenden, um dieselben REST-Aufrufe durchzuführen. APIs : CAPI-APIs sind die Kernkomponente von CAPI, die ein Produkt und eine Schnittstelle miteinander verbindet. Die APIs enthalten den tatsächlichen Code, den das System ausführt. Jede CAPI-API enthält diese Komponenten: * CAPI-Methodenzuordnungen Geben Sie die Methoden an, die den in der Schnittstelle definierten Vorgängen zugeordnet sind. Aus CAPI-Methodenzuordnungen erstellen Sie MID-ServerSkript enthält JavaScript, um dem Cloud-Anbieter genau mitzuteilen, was er tun soll. Über die Skripteinbindungen erfolgt die Verbindung zum Cloud-Anbieter. Hinweis: Wenn Sie anwenderdefinierte CAPI-APIs erstellen, stellt das System eine leere Skripteinbindung bereit, die Sie anpassen können. Sie können bei Bedarf auch vorhandene Skripteinbindungen in Methodenzuordnungen ändern. Viele der Standard-APIs, die im Lieferumfang enthalten sind Cloud Provisioning and GovernanceAnwendung verwendet keine änderbaren Skripteinbindungen. Die Verbindungen sind in Java hartcodiert. Sie können diese APIs weiterhin in neuen Ressourcenblöcken verwenden, die Sie erstellen, aber Sie können die APIs nicht ändern. * API-Konfigurationsüberschreibungen Enthalten die Identität, z. B. einen Schlüssel, und Anmeldeinformationen, z. B. den geheimen Schlüssel, und andere wichtige Parameter, die vom Cloud-Anbieter benötigt werden. Diese Parameter helfen dem Cloud-Anbieter, die Vorgänge in der zugehörigen Liste „CAPI-Methodenzuordnungen" auszuführen. Überschreibungen der API-Konfiguration sind erforderlich, da Anmeldeinformationsdaten nicht enthalten sind, wenn das System die Cloud-Provider-API über REST aufruft. Ressourcenblöcke verwenden die Parameter und Werte, die Sie in den API-Konfigurationsüberschreibungen definieren, um den Anmeldeinformationsspeicher abzufragen. Wenn Ihre API ausgeführt wird, werden die Attribute für alle Methodenaufrufe in Ihren Skripteinbindungen verfügbar gemacht. Der Umfang der Überschreibungen ist nur für diese API festgelegt. Die Überschreibungen überschreiben nichts in anderen APIs. {#cloud-management-api__ul_ynn_zbp_x2b} Da Sie mehrere Versionen einer CAPI-API mit leichten Variationen definieren können, können Sie eine vorhandene API erweitern (ohne Überschreiben), während Sie die gewünschte Funktionalität beibehalten. Dieses Bild veranschaulicht die Komponenten von CAPI, die verwendet werden, wenn Sie eine virtuelle Azure-Maschine mithilfe der standardmäßigen CAPI-Einstellungen bereitstellen, die mit bereitgestellt werden Cloud Provisioning and Governance:Abbildung : 2. CAPI Azure In diesem Beispiel ist Microsoft.ComputeProdukt ist in enthalten AzureAnbieter. Azure verwendet Microsoft.ComputeProdukt für virtuelle Computer. In Ihrer Instanz die Microsoft.ComputeDas Produkt ist zu zugeordnet Microsoft.Compute/virtualMachinesRessourcentyp, der zugeordnet ist Virtual Machine InstanceCI-Typ in der CMDB. Die ComputeDie Schnittstelle enthält Definitionen für Methoden wie CreateNode, Der definiert, wie die tatsächliche virtuelle Maschine erstellt wird. Von den vielen Parametern, die CreateNodeVerwendet, LocationErfasst das Rechenzentrum, in dem sich die virtuelle Maschine befindet. Die Azure Compute APIRuft zusammen Microsoft.ComputeProdukt und die in definierte Struktur ComputeSchnittstelle. Die Implementierung von CreateNodeMethode ruft auf azure-compute-1.0-CreateNode MID-ServerSkripteinbindung, die aufruft AzureComputeVirtualMachine MID-ServerSkripteinbindung. Das Skript enthält die Durchführung der tatsächlichen Aufrufe der Azure-API. Um auf den Azure-Account zuzugreifen, die SecretKey, ClientID, TenantID, Und andere Methoden werden in Konfigurationsüberschreibungen übergeben. ## Wie CAPI in die Instanz integriert wird {#cloud-management-api__section_oj2_dw4_x2b} CAPI integriert diese Komponenten in Ihre Instanz: Cloud Provisioning and Governance Ressourcenblöcke : Ein Ressourcenblock stellt eine einzelne Cloud-Ressource dar, z. B. einen virtuellen Server, einen virtuellen Serverspeicher oder ein Rechenzentrum. Sie können es auch als CI-Typ in der CMDB betrachten. Sie fügen viele Ressourcenblöcke in einem Blueprint zusammen, der Ihren Anwendern im Cloud-Katalog als Katalogelement (auch als Stapel bezeichnet) angezeigt wird. Im System ist jeder Ressourcenblock wie ein Container, der auf CAPI verweist und Antworten des Cloud-Providers mit einem bestimmten CI verknüpft. Verwendung von Ressourcenblöcken: * Operative Schritte Die CAPI für jeden Vorgang aufrufen, z. B. den Bereitstellungsvorgang, und die erforderlichen Parameterwerte übergeben, die der Cloud-Anbieter zum Ausführen des Vorgangs benötigt. * Antwortprozessoren Diese verarbeiten und analysieren die REST-Antwort des Providers und aktualisieren Datensätze in der CMDB. {#cloud-management-api__ul_gfn_frq_x2b} Die CMDB : Jeder Ressourcenblock basiert auf einem CI-Typ aus der CMDB. Für Cloud Provisioning and Governance, Alle Cloud-bezogenen CI-Typen basieren auf Virtual Machine Object CIKlasse, die alle Attribute bereitstellt, die Sie für alle standardmäßig unterstützten Cloud-Ressourcen benötigen. Wenn in kein CI-Typ für eine Cloud-Ressource vorhanden ist Basissystem, Sie müssen eine neue CI-Klasse erstellen und die erforderlichen Attribute hinzufügen. Wenn Sie eine neue CI-Klasse erstellen, müssen Sie auch Folgendes erstellen: * A CI-Klasse Für jede der Ressourcen, die Ihren Anwendern zur Verfügung stehen. Alle CI-Klassen basieren auf der Objektklasse der virtuellen Maschine. * Ein Identifizierungsregel Gibt eine Objekt-ID an. Wann immer Komponenten von Cloud-ManagementBeziehen Sie sich auf eine bestimmte Cloud-Ressource in der CMDB. Sie benötigen die Objekt-ID, um die richtige Cloud-Ressource zu finden. * A Beziehungsregel Gibt an, wie die CI-Klasse für die Ressource mit anderen CI-Klassen verknüpft ist. Beispiel: A virtual serverCI muss einen haben Hosted on::HostsBeziehung zu datacenterCI. Diese Beziehungsregeln sind für erforderlich CI-Eindeutigkeit Bei Verarbeitung durch die Identifizierungs- und Abgleichsmodul (Ire). Die Kombination aus dem Service-Account, der Objekt-ID der Ressource und dem Rechenzentrum (oder Standort), in dem sich die Ressource befindet, bestimmt die Eindeutigkeit. {#cloud-management-api__ul_vll_zgq_x2b} MID-Server Skripteinbindung : Jeder Vorgang in der CAPI-API hat einen MID-ServerSkripteinbindung, die Sie konfigurieren. Die Skripteinbindung ruft die JavaScript-Klassen auf, die sich bereits in anderen Skripteinbindungen im System befinden, oder JavaScript-Klassen, die Sie erstellen. Schließlich wird die Aufruferklasse aufgerufen, um den REST-Aufruf auszulösen. MID-ServerSkripteinbindungen sind auf konfiguriert ServiceNowInstanz, aber wird auf ausgeführt MID-Server. Dieses Bild zeigt, wie die Komponenten zusammenarbeiten, wenn ein Anwender eine Ressource aus bereitstellt Cloud-Anwenderportal: ## REST-Aufrufe an den Cloud-Anbieter {#cloud-management-api__section_sys_p4j_hfb} REST-Aufrufe an den Cloud-Anbieter werden von ausgelöst MID-ServerSkripteinbindungen, auf die von geskripteten CAPI-Methodenzuordnungen in CAPI-API-Datensätzen verwiesen wird. Zum Erstellen eigener CAPI-APIs oder zum Erstellen anwenderdefinierter APIs MID-ServerSkripteinbindungen (die Teil der CAPI-Methodenzuordnungen sind), Sie müssen Folgendes verstehen: * Die Klassen, die für Sie verfügbar sind MID-ServerSkripteinbindungen. Weitere Informationen finden Sie unter [CAPI-Klassen in MID-ServerSkripteinbindungen](https://servicenow-prod.fluidtopics.net/YHAGBrFyZqdzm9IAL1iY~A "Cloud Provisioning and Governance Stellt mehrere JavaScript-Klassen bereit, die REST-Aufrufe an Cloud-Anbieter durchführen. Diese Klassen werden von aufgerufen MID-ServerSkripteinbindungen (standardmäßig für Azure) oder aus Java-Aufrufen im System (standardmäßig für AWS). Wenn Sie anwenderdefinierte Anbieter, Schnittstellen oder CAPI-APIs (für jeden Cloud-Anbieter) erstellen, können Sie verwenden MID-ServerSkripteinbindungen zum Aufrufen der Klassen."). * Wie der Cloud-Anbieter REST implementiert. Siehe: * [Azure-REST-API-Referenz](https://docs.microsoft.com/en-us/rest/api/azure/) * [AWS-Leitfäden und API-Referenzen](https://docs.aws.amazon.com/index.html#lang/en_us) {#cloud-management-api__ul_ax3_fsj_hfb} {#cloud-management-api__ul_ysk_trj_hfb} Um beispielsweise zu erfahren, wie Sie Azure zum Erstellen einer Ressourcengruppe einen REST-Aufruf durchführen, lesen Sie dieses Azure-Thema: [Ressourcengruppen -- Erstellen Oder Aktualisieren](https://docs.microsoft.com/en-us/rest/api/resources/resourcegroups/createorupdate). Sie können den Endpunkt, die Parameter und den Anforderungstext finden, den Azure erfordert, und die bereitgestellten Antworten. Sie können Folgendes sehen: * Der Endpunkt ist `management.azure.com ` * Die Methode, die mit einem PUT-Vorgang aufgerufen werden soll, ist `Abonnements/{subscriptionId}/resourcegroups/{resourceGroupName}?api-Version=2018-02-01 `, Wobei Sie die Abonnement-ID, den Ressourcengruppennamen und die API-Version angeben. {#cloud-management-api__ul_y12_kwj_hfb} Denken Sie daran, dass die REST-API-Aufrufe innerhalb von stattfinden MID-ServerSkripteinbindungen, die CAPI-API-Methodenzuordnungen zugeordnet sind. Rufen Sie die Methoden auf, die CAPI bereits für Sie verfügbar macht, indem Sie die Klassen verwenden, die von erweitert wurden CloudAPIBaseUnd CloudRESTAPIInvoker. Sie können auch weitere Skripteinbindungen erstellen, um diese Basisklassen zu erweitern und eigene Klassen zu erstellen. Machen Sie sich mit diesen Basisklassen und den darin verfügbaren Methoden vertraut. ## Beginnen Sie hier {#cloud-management-api__section_odh_vlh_n2b} 1. [Überprüfen Sie CAPI-APIs, die mit bereitgestellt werden Cloud Provisioning and Governance Standardmäßig](https://servicenow-prod.fluidtopics.net/doYCZUVe4VLip9CtfDxBaw "Mehrere CAPI-APIs werden standardmäßig mit bereitgestellt Cloud Provisioning and GovernanceAnwendung.")an. 2. [Überprüfen Sie die standardmäßig bereitgestellten CAPI-Klassen](https://servicenow-prod.fluidtopics.net/YHAGBrFyZqdzm9IAL1iY~A "Cloud Provisioning and Governance Stellt mehrere JavaScript-Klassen bereit, die REST-Aufrufe an Cloud-Anbieter durchführen. Diese Klassen werden von aufgerufen MID-ServerSkripteinbindungen (standardmäßig für Azure) oder aus Java-Aufrufen im System (standardmäßig für AWS). Wenn Sie anwenderdefinierte Anbieter, Schnittstellen oder CAPI-APIs (für jeden Cloud-Anbieter) erstellen, können Sie verwenden MID-ServerSkripteinbindungen zum Aufrufen der Klassen."). Diese Klassen können über aufgerufen werden MID-ServerSkripteinbindungen in Ihren CAPI-API-Vorgängen. 3. Gehen Sie die Bereitstellung von durch [Azure-VM](https://servicenow-prod.fluidtopics.net/orcUtMXGuY5UTELT1xlq6w "Dieses Beispiel führt Sie durch die Komponenten von Cloud Provisioning and GovernanceDiese Funktion während der Bereitstellung einer virtuellen Maschine in einem Azure-Rechenzentrum. Zu den behandelten Themen gehören Blueprints, Ressourcenblöcke, die Cloud-API (CAPI) und MID-ServerSkripteinbindungen.")Und [Virtueller AWS-Computer](https://servicenow-prod.fluidtopics.net/kBfzriFksatAKgB~Dqd_Kw "Dieses Beispiel führt Sie durch die Komponenten von Cloud Provisioning and GovernanceDiese Funktion während der Bereitstellung einer virtuellen Maschine in einem AWS-Rechenzentrum. Zu den behandelten Themen gehören Blueprints, Ressourcenblöcke, die Cloud-API (CAPI) und MID-ServerSkripteinbindungen.")Um zu sehen, wie die Komponenten zusammenarbeiten. Die Azure-Walkthrough verwendet einen MID-ServerSkripteinbindung, damit Sie die verschiedenen CAPI-Klassen anzeigen können, die im Bereitstellungsvorgang verwendet werden. Die AWS-Walkthrough verwendet keine MID-ServerSkripteinbindung. 4. [Fügen Sie einem vorhandenen Anbieter in CAPI ein Produkt hinzu](https://servicenow-prod.fluidtopics.net/4po6chPsLiOmkMZ8jdG5Pg "Die Cloud Provisioning and GovernanceCloud-API (CAPI) bietet viele Anbieter, z. B. AWS und Azure, und Produkte wie EC2-Instanzen. Sie können jedoch Produkte zu vorhandenen Anbietern für neue Arten von Cloud-Ressourcen hinzufügen."). 5. [Erstellen Sie eine CI-Klasse für eine virtuelle Cloud-Ressource](https://servicenow-prod.fluidtopics.net/RgMBtFeIc1dV0XdUUp~0kw "Wenn BasissystemStellt keinen CI-Typ für cloudbasierte virtuelle Ressourcen bereit. Sie können eine CI-Klasse basierend auf der Objektklasse der virtuellen Maschine erstellen."). 6. [Erstellen oder erweitern Sie eine CAPI-Schnittstelle](https://servicenow-prod.fluidtopics.net/w_B0jzZecelQXUXHP3~1aA "Sie können eine neue CAPI-Schnittstelle erstellen oder eine vorhandene erweitern, indem Sie neue Vorgänge hinzufügen."). 7. [Erstellen Sie eine CAPI-API](https://servicenow-prod.fluidtopics.net/fY3SSJwAN70mAjRR7hG7Zw "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."), Und eine anwenderdefinierte MID-ServerSkripteinbindung, die die REST-Aufrufe an den Cloud-Anbieter vornimmt. Ein leerer MID-ServerSkripteinbindung wird für neue CAPI-APIs immer generiert. Ändern Sie sie mit den Aufrufen anderer JavaScript-Klassen und -Methoden, z. B. die Methoden in der Aufruferklasse. {#cloud-management-api__ol_zdd_yby_2fb}