Method: projects.locations.bareMetalAdminClusters.get

Gets details of a single bare metal admin cluster.

HTTP request

GET https://gkeonprem.googleapis.com/v1/{name=projects/*/locations/*/bareMetalAdminClusters/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the bare metal admin cluster to get. Format: "projects/{project}/locations/{location}/bareMetalAdminClusters/{bareMetalAdminCluster}"

Query parameters

Parameters
view

enum (ClusterView)

View for bare metal admin cluster. When BASIC is specified, only the cluster resource name and membership are returned. The default/unset value CLUSTER_VIEW_UNSPECIFIED is the same as `FULL', which returns the complete cluster configuration details.

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ClusterView

A view for bare metal admin cluster resource.

Enums
CLUSTER_VIEW_UNSPECIFIED If the value is not set, the default FULL view is used.
BASIC Includes basic information of a cluster resource including cluster resource name and membership.
FULL Includes the complete configuration for bare metal admin cluster resource. This is the default value for GetBareMetalAdminClusterRequest method.