Method: projects.locations.bareMetalAdminClusters.list

Lists bare metal admin clusters in a given project and location.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}"

Query parameters

Parameters
pageSize

integer

Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

A token identifying a page of results the server should return.
view

enum (ClusterView)

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

Request body

The request body must be empty.

Response body

Response message for listing bare metal admin clusters.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "bareMetalAdminClusters": [
    {
      object (BareMetalAdminCluster)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
bareMetalAdminClusters[]

object (BareMetalAdminCluster)

The list of bare metal admin cluster.
nextPageToken

string

A token identifying a page of results the server should return. If the token is not empty this means that more results are available and should be retrieved by repeating the request with the provided page token.
unreachable[]

string

Locations that could not be reached.

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 admin cluster resources.

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