Method: projects.locations.realms.gameServerClusters.list

Lists game server clusters in a given project and location.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource name, in the following form: "projects/{project}/locations/{location}/realms/{realm}".

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response's nextPageToken to determine if there are more GameServerClusters left to be queried.

pageToken

string

Optional. The nextPageToken value returned from a previous List request, if any.

filter

string

Optional. The filter to apply to list results.

orderBy

string

Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

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 data with the following structure:

Response message for GameServerClustersService.ListGameServerClusters.

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

object (GameServerCluster)

The list of game server clusters.

nextPageToken

string

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

unreachable[]

string

List of 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.