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

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 Projekt und der Standort, 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

string

Vom Nutzer angegebene OnePlatform-ID, die als Teil des Ressourcennamens verwendet wird. Diese ID muss für alle Bare-Metal-Cluster in einem Projekt und an einem Standort eindeutig sein. Wenn der Cluster bereits vorhanden ist, wird ein 409-Fehler zurückgegeben.

Format: 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 bei der Registrierung vorhandener Cluster in der API in Konflikt stehende Ressourcennamen zu unterstützen. Wenn kein Wert angegeben ist, wird dieses Feld in „bareMetalClusterId“ aufgelöst. Andernfalls muss es mit dem Objektnamen der benutzerdefinierten Ressource des Bare-Metal-Clusters übereinstimmen. Es kann außerhalb / nach der Registrierung nicht 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 möglicherweise Verweise auf andere Ressourcentypen zulässig, wenn Administratorcluster als eigene Ressourcen modelliert werden.
localNamespace

string

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.