Method: projects.locations.bareMetalClusters.enroll

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 werden voraussichtlich über die API vorgenommen.

HTTP-Anfrage

POST https://gkeonprem.googleapis.com/v1/{parent=projects/*/locations/*}/bareMetalClusters:enroll

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Das übergeordnete Element des Projekts und des Standorts, bei 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
}
Felder
bareMetalClusterId

string

Von Nutzern bereitgestellte OnePlatform-ID, die als Teil des Ressourcennamens verwendet wird. Er muss innerhalb aller Bare-Metal-Cluster in einem Projekt und an einem Standort eindeutig sein. Wenn der Cluster bereits vorhanden ist, wird der Fehler 409 zurückgegeben.

(https://tools.ietf.org/html/rfc1123)

localName

string

Optional. Der Objektname der benutzerdefinierten Ressource des Bare-Metal-Clusters im zugehörigen Administratorcluster. Dieses Feld wird verwendet, um Konflikt bei Ressourcennamen zu unterstützen, wenn vorhandene Cluster bei der API registriert werden. Wenn dieses Feld nicht angegeben ist, wird es auf die bareMetalClusterId verweisen. Andernfalls muss er mit dem Objektnamen der benutzerdefinierten Ressource des Bare-Metal-Clusters übereinstimmen. Sie kann nicht außerhalb des Registrierungsvorgangs geändert werden.

adminClusterMembership

string

Erforderlich. Der Administratorcluster, zu dem dieser Bare-Metal-Nutzercluster gehört. Dies ist der vollständige Ressourcenname der Flottenmitgliedschaft des Administratorclusters. In Zukunft sind Verweise auf andere Ressourcentypen möglicherweise zulässig, wenn Administratorcluster als eigene Ressourcen modelliert werden.

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.