Method: projects.locations.privateClouds.clusters.list

Lists Cluster resources in a given private cloud.

HTTP request

GET https://vmwareengine.googleapis.com/v1/{parent=projects/*/locations/*/privateClouds/*}/clusters

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the private cloud to query for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

Authorization requires the following IAM permission on the specified resource parent:

  • vmwareengine.clusters.list

Query parameters

Parameters
pageSize

integer

The maximum number of clusters to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
pageToken

string

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

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

string

To filter on multiple expressions, provide each separate expression within parentheses. For example:

(name = "example-cluster")
(nodeCount = "3")

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example:

(name = "example-cluster-1") AND
(createTime > "2021-04-12T08:15:10.40Z") OR
(name = "example-cluster-2")
orderBy

string

Sorts list results by a certain order. By default, returned results are ordered by name in ascending order. You can also sort results in descending order based on the name value using orderBy="name desc". Currently, only ordering by name is supported.

Request body

The request body must be empty.

Response body

Response message for VmwareEngine.ListClusters

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

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

object (Cluster)

A list of private cloud clusters.
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 when making an aggregated query using wildcards.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.