Method: projects.locations.bareMetalClusters.enroll

Enregistre un cluster d'utilisateur Bare Metal existant et ses pools de nœuds auprès de l'API Anthos On-Prem dans un projet et un emplacement donnés. L'enregistrement permet de faire en sorte qu'un cluster existant soit géré par l'API Anthos On-Prem. Les ressources GCP correspondantes seront créées, et toutes les modifications futures apportées au cluster et/ou à ses pools de nœuds devront être effectuées via l'API.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Parent du projet et de l'emplacement dans lesquels le cluster est enregistré. Format : "projects/{project}/locations/{location}"

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "bareMetalClusterId": string,
  "localName": string,
  "adminClusterMembership": string,
  "localNamespace": string
}
Champs
bareMetalClusterId

string

Identifiant OnePlatform fourni par l'utilisateur et utilisé dans le nom de la ressource. Il doit être unique parmi tous les clusters Bare Metal d'un projet et d'un emplacement. Si le cluster existe déjà, le code 409 est renvoyé.

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

string

Facultatif. Nom d'objet de la ressource personnalisée du cluster Bare Metal sur le cluster d'administrateur associé. Ce champ permet de gérer les noms de ressources conflictuels lors de l'enregistrement de clusters existants auprès de l'API. Si ce champ n'est pas fourni, il est résolu en bareMetalClusterId. Sinon, il doit correspondre au nom d'objet de la ressource personnalisée du cluster Bare Metal. Il n'est pas modifiable en dehors de l'opération d'enregistrement.
adminClusterMembership

string

Obligatoire. Cluster d'administrateur auquel appartient ce cluster d'utilisateur Bare Metal. Nom complet de la ressource de l'appartenance au parc du cluster d'administrateur. À l'avenir, les références à d'autres types de ressources pourront être autorisées si les clusters d'administrateur sont modélisés en tant que ressources propres.
localNamespace

string

Facultatif. Espace de noms du cluster.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.