Registriert einen vorhandenen Bare Metal-Nutzercluster und seine Knotenpools in der Anthos On-Prem API in einem bestimmten Projekt und an einem bestimmten Standort. Durch die Registrierung wird ein vorhandener Cluster von der Anthos On-Prem API verwaltet. Die entsprechenden GCP-Ressourcen werden erstellt und alle zukünftigen Änderungen am Cluster und/oder seinen Knotenpools müssen über die API erfolgen.
HTTP-Anfrage
POST https://gkeonprem.googleapis.com/v1/{parent=projects/*/locations/*}/bareMetalClusters:enroll
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter | |
---|---|
parent |
Erforderlich. Das übergeordnete Element des Projekts und des Standorts, in dem der Cluster registriert ist. Format: „projects/{project}/locations/{location}“ |
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
JSON-Darstellung |
---|
{ "bareMetalClusterId": string, "localName": string, "adminClusterMembership": string, "localNamespace": string } |
Felder | |
---|---|
bareMetalClusterId |
Vom Nutzer bereitgestellte OnePlatform-Kennung, die als Teil des Ressourcennamens verwendet wird. Dieser Name muss für alle Bare-Metal-Cluster in einem Projekt und an einem Standort eindeutig sein. Wenn der Cluster bereits vorhanden ist, wird der Fehlercode 409 zurückgegeben. (https://tools.ietf.org/html/rfc1123) format. |
localName |
Optional. Der Objektname der benutzerdefinierten Ressource des Bare-Metal-Clusters im zugehörigen Administratorcluster. Dieses Feld wird verwendet, um in Konflikt stehende Ressourcennamen zu unterstützen, wenn vorhandene Cluster in der API registriert werden. Wenn dieses Feld nicht angegeben wird, wird es in „bareMetalClusterId“ aufgelöst. Andernfalls muss er mit dem Objektnamen der benutzerdefinierten Ressource des Bare-Metal-Clusters übereinstimmen. Sie kann nicht außerhalb oder nach der Registrierung geändert werden. |
adminClusterMembership |
Erforderlich. Der Administratorcluster, zu dem dieser Bare-Metal-Nutzercluster gehört. Dies ist der vollständige Ressourcenname der Flottenmitgliedschaft des Administratorclusters. In Zukunft sind möglicherweise Verweise auf andere Ressourcentypen zulässig, wenn Administratorcluster als eigene Ressourcen modelliert werden. |
localNamespace |
Optional. Der Namespace des Clusters. |
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation
.
Autorisierungsbereiche
Erfordert den folgenden OAuth-Bereich:
https://www.googleapis.com/auth/cloud-platform
Weitere Informationen finden Sie unter Authentication Overview.