Satellite-API einrichten

Nutzen Sie die IBM Cloud Satellite-API, um die Bereitstellung und Verwaltung Ihrer Standorte, Hosts und Cluster in Hybrid- und Multi-Cloud-Umgebungen zu automatisieren.

IBM Cloud Satellite nutzt dieselbe Anwendungsprogrammierschnittstelle (API) wie IBM Cloud Kubernetes Service und Red Hat OpenShift on IBM Cloud, sodass Sie dieselben Methoden für die konsistente Erstellung und Verwaltung Ihrer Satellite-Ressourcen verwenden können.

Informationen zur API

Die Satellite-API automatisiert die Bereitstellung und Verwaltung von IBM Cloud-Infrastrukturressourcen für Ihre Cluster, sodass Ihre Apps über die entsprechenden Datenverarbeitungs-, Netz- und Speicherressourcen verfügen, um Ihren Benutzern dienlich sein zu können.

Die API unterstützt die verschiedenen Infrastrukturprovider, die Ihnen zur Erstellung von Clustern und Ressourcen zur Verfügung stehen. Version 2 (v2) der API wurde dazu konzipiert, um nach Möglichkeit eine Beeinträchtigung der bestehenden Funktionalität zu vermeiden. Stellen Sie jedoch sicher, dass Sie sich mit den folgenden Unterschieden zwischen der API v1 und der API v2 vertraut machen.

Präfix für API-Endpunkt
v1-API: https://containers.cloud.ibm.com/global/v1
v2-API: https://containers.cloud.ibm.com/global/v2
API-Referenzdokumente
v1-API: https://cloud.ibm.com/apidocs/kubernetes/containers-v1-v2
v2-API: https://cloud.ibm.com/apidocs/kubernetes/containers-v1-v2
Stil der API-Architektur
v1-API: REST (Representational State Transfer) mit Schwerpunkt auf Ressourcen, mit denen Sie über HTTP-Methoden wie GET, POST, PUT, PATCHund DELETE interagieren.
v2-API: RPCs (Remote Procedure Calls) mit Schwerpunkt auf Aktionen, die ausschließlich über GET- und POST-HTTP-Methoden erfolgen.
GET-Antworten
v1-API: Die GET-Methode für eine Sammlung von Ressourcen (z. B. GET v1/clusters) gibt für jede Ressource in der Liste die gleichen Details zurück wie eine GET-Methode für eine einzelne Ressource (z. B. GET v1/clusters/{idOrName}).
v2-API: Um die Rückgabe von Antworten zu beschleunigen, gibt die v2 GET-Methode für eine Sammlung von Ressourcen (z. B. GET v2/clusters) nur eine Untergruppe der Informationen zurück, die in einer GET-Methode für eine einzelne Ressource (z. B. GET v2/clusters/{idOrName}) angegeben sind. Manche Listenantworten enthalten eine Providereigenschaft, die angibt, ob das zurückgegebene Element für die klassische Infrastruktur oder für eine VPC-Infrastruktur gilt. Die Liste GET zones gibt zum Beispiel einige Ergebnisse wie mon01 zurück, die nur beim Provider der klassischen Infrastruktur verfügbar sind, während andere Ergebnisse wie us-south-01 nur bei einem Provider der VPC-Infrastruktur verfügbar sind.
Cluster-, Workerknoten- und Worker-Pool-Antworten
v1-API: Die Antworten enthalten nur spezifische Informationen für den Provider der klassischen Infrastruktur (z. B. die VLANs in GET-Cluster- und -Workerantworten.
v2-API: Die zurückgegebenen Informationen variieren je nach Infrastrukturprovider. Für derartige providerspezifische Antworten können Sie den Provider in Ihrer Anforderung angeben. Für VPC-Cluster werden beispielsweise keine VLAN-Informationen zurückgegeben, da sie keine VLANs enthalten. Stattdessen geben sie Teilnetz- und CIDR-Netzinformationen zurück.

{{../iam/iam-apikeys.md#work-with-apikeys}}

{{../iam/iam-apikey_iamtoken.md#iamtoken}}

{{../iam/iam-apikeys_services.md#token_auth}}

{{../iam/iam-apikeys_services.md#apikey_auth}}