Method: projects.locations.clusters.list

Lists the clusters in a given project and location.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent location whose clusters are to be listed. Structured like projects/{project}/locations/{location}.

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of clusters to return. The service may return fewer than this value. If unspecified, server will pick an appropriate default.
pageToken

string

Optional. 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

Optional. Filter expression for the result.
orderBy

string

Optional. Order by fields for the result.

Request body

The request body must be empty.

Response body

Response for clusters.list.

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

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

object (Cluster)

The list of Clusters in the requested parent.
nextPageToken

string

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

IAM Permissions

Requires the following IAM permission on the parent resource:

  • managedkafka.clusters.list

For more information, see the IAM documentation.