Method: projects.locations.realms.gameServerClusters.get

Gets details of a single game server cluster.

HTTP request

GET https://gameservices.googleapis.com/v1/{name=projects/*/locations/*/realms/*/gameServerClusters/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the game server cluster to retrieve, in the following form: projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}.

Query parameters

Parameters
view

enum (GameServerClusterView)

Optional. View for the returned GameServerCluster objects. When FULL is specified, the clusterState field is also returned in the GameServerCluster object, which includes the state of the referenced Kubernetes cluster such as versions and provider info. The default/unset value is GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED, same as BASIC, which does not return the clusterState field.

Request body

The request body must be empty.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.