Method: projects.locations.bareMetalClusters.bareMetalNodePools.list

Lists bare metal node pools in a given project, location and bare metal cluster.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of node pools. Format: projects/{project}/locations/{location}/bareMetalClusters/{bareMetalCluster}

Query parameters

Parameters
pageSize

integer

The maximum number of node pools to return. The service may return fewer than this value. If unspecified, at most 50 node pools will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

A page token, received from a previous bareMetalNodePools.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to bareMetalNodePools.list must match the call that provided the page token.
view

enum (NodePoolView)

View for bare metal node pools. When BASIC is specified, only the node pool resource name is returned. The default/unset value NODE_POOL_VIEW_UNSPECIFIED is the same as `FULL', which returns the complete node pool configuration details.

Request body

The request body must be empty.

Response body

Response message for listing bare metal node pools.

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

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

object (BareMetalNodePool)

The node pools from the specified parent resource.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
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.

NodePoolView

A view for bare metal node pool resource.

Enums
NODE_POOL_VIEW_UNSPECIFIED If the value is not set, the default FULL view is used.
BASIC Includes basic information of a node pool resource including node pool resource name.
FULL Includes the complete configuration for bare metal node pool resource. This is the default value for ListBareMetalNodePoolsRequest method.