Method: projects.locations.bareMetalClusters.bareMetalNodePools.enroll

Enrolls an existing bare metal node pool to the Anthos On-Prem API within a given project and location. Through enrollment, an existing node pool will become Anthos On-Prem API managed. The corresponding GCP resources will be created.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource where this node pool will be created. projects/{project}/locations/{location}/bareMetalClusters/{cluster}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "bareMetalNodePoolId": string,
  "validateOnly": boolean
}
Fields
bareMetalNodePoolId

string

User provided OnePlatform identifier that is used as part of the resource name.

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

boolean

If set, only validate the request, but do not actually enroll the node pool.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.