Method: projects.locations.clusters.get

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization scopes
• IAM Permissions
• ClusterView
• Try it!

Returns the properties of a single cluster.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name	string Required. The name of the cluster whose configuration to return.

Query parameters

Parameters
view	enum (ClusterView) Optional. Specifies the view of the Cluster resource to be returned. Defaults to CLUSTER_VIEW_BASIC. See the ClusterView enum for possible values.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Cluster.

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 name resource:

• managedkafka.clusters.get

For more information, see the IAM documentation.

ClusterView

View of Cluster object fields to be returned by clusters.get and clusters.list.

Enums
CLUSTER_VIEW_UNSPECIFIED	The default / unset value. The API will default to the BASIC view.
CLUSTER_VIEW_BASIC	Include the basic metadata of the Cluster. This is the default value (for both clusters.list and clusters.get).
CLUSTER_VIEW_FULL	Include everything, including data fetched from the Kafka cluster source of truth.