Method: projects.locations.awsClusters.awsNodePools.list

Lists all AwsNodePool resources on a given AwsCluster.

HTTP request

GET https://{endpoint}/v1/{parent=projects/*/locations/*/awsClusters/*}/awsNodePools

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent AwsCluster which owns this collection of AwsNodePool resources.

AwsCluster names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>.

See Resource Names for more details on Google Cloud resource names.

Query parameters

Parameters
pageSize

integer

The maximum number of items to return.

If not specified, a default value of 50 will be used by the service. Regardless of the pageSize value, the response can include a partial list and a caller should only rely on response's nextPageToken to determine if there are more instances left to be queried.
pageToken

string

The nextPageToken value returned from a previous awsNodePools.list request, if any.

Request body

The request body must be empty.

Response body

Response message for AwsClusters.ListAwsNodePools method.

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

JSON representation 
{
  "awsNodePools": [
    {
      object (AwsNodePool)
    }
  ],
  "nextPageToken": string
}
Fields
awsNodePools[]

object (AwsNodePool)

A list of AwsNodePool resources in the specified AwsCluster.
nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • gkemulticloud.awsNodePools.list

For more information, see the IAM documentation.