Method: projects.locations.bareMetalClusters.enroll

Registra um cluster de usuário bare metal e os pools de nós na API Anthos On-Prem em um projeto e local especificados. Com o registro, um cluster se torna gerenciado pela API Anthos On-Prem. Os recursos correspondentes do GCP serão criados, e todas as modificações futuras no cluster e/ou nos pools de nós precisarão ser feitas pela API.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O pai do projeto e do local em que o cluster está registrado. Formato: "projects/{project}/locations/{location}"

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "bareMetalClusterId": string,
  "localName": string,
  "adminClusterMembership": string,
  "localNamespace": string
}
Campos
bareMetalClusterId

string

Identificador do OnePlatform fornecido pelo usuário que é usado como parte do nome do recurso. Ele precisa ser exclusivo entre todos os clusters bare metal em um projeto e local e retornará um erro 409 se o cluster já existir.

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

localName

string

Opcional. O nome do objeto do recurso personalizado do cluster bare metal no cluster de administrador associado. Esse campo é usado para oferecer suporte a nomes de recursos conflitantes ao registrar clusters na API. Quando não fornecido, esse campo será resolvido para bareMetalClusterId. Caso contrário, ele precisará corresponder ao nome do objeto do recurso personalizado do cluster bare metal. Não é possível modificá-lo fora / além da operação de registro.

adminClusterMembership

string

Obrigatório. O cluster de administrador a que esse cluster de usuário bare metal pertence. Esse é o nome completo do recurso da assinatura da frota do cluster de administrador. No futuro, referências a outros tipos de recursos poderão ser permitidas se os clusters de administrador forem modelados como recursos próprios.

localNamespace

string

Opcional. O namespace do cluster.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.