Method: projects.locations.gameServerDeployments.fetchDeploymentState

Retrieves information about the current state of the game server deployment. Gathers all the Agones fleets and Agones autoscalers, including fleets running an older version of the game server deployment.

HTTP request

POST https://gameservices.googleapis.com/v1/{name=projects/*/locations/*/gameServerDeployments/*}:fetchDeploymentState

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the game server delpoyment, in the following form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}.

Request body

The request body must be empty.

Response body

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

Response message for GameServerDeploymentsService.FetchDeploymentState.

JSON representation
{
  "clusterState": [
    {
      object (DeployedClusterState)
    }
  ],
  "unavailable": [
    string
  ]
}
Fields
clusterState[]

object (DeployedClusterState)

The state of the game server deployment in each game server cluster.

unavailable[]

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.

DeployedClusterState

The game server cluster changes made by the game server deployment.

JSON representation
{
  "cluster": string,
  "fleetDetails": [
    {
      object (DeployedFleetDetails)
    }
  ]
}
Fields
cluster

string

The name of the cluster.

fleetDetails[]

object (DeployedFleetDetails)

The details about the Agones fleets and autoscalers created in the game server cluster.

DeployedFleetDetails

Details of the deployed Agones fleet.

JSON representation
{
  "deployedFleet": {
    object (DeployedFleet)
  },
  "deployedAutoscaler": {
    object (DeployedFleetAutoscaler)
  }
}
Fields
deployedFleet

object (DeployedFleet)

Information about the Agones fleet.

deployedAutoscaler

object (DeployedFleetAutoscaler)

Information about the Agones autoscaler for that fleet.

DeployedFleet

Agones fleet specification and details.

JSON representation
{
  "fleet": string,
  "fleetSpec": string,
  "specSource": {
    object (SpecSource)
  },
  "status": {
    object (DeployedFleetStatus)
  }
}
Fields
fleet

string

The name of the Agones fleet.

fleetSpec

string

The fleet spec retrieved from the Agones fleet.

specSource

object (SpecSource)

The source spec that is used to create the Agones fleet. The GameServerConfig resource may no longer exist in the system.

status

object (DeployedFleetStatus)

The current status of the Agones fleet. Includes count of game servers in various states.

DeployedFleetStatus

DeployedFleetStatus has details about the Agones fleets such as how many are running, how many allocated, and so on.

JSON representation
{
  "readyReplicas": string,
  "allocatedReplicas": string,
  "reservedReplicas": string,
  "replicas": string
}
Fields
readyReplicas

string (int64 format)

The number of GameServer replicas in the READY state in this fleet.

allocatedReplicas

string (int64 format)

The number of GameServer replicas in the ALLOCATED state in this fleet.

reservedReplicas

string (int64 format)

The number of GameServer replicas in the RESERVED state in this fleet. Reserved instances won't be deleted on scale down, but won't cause an autoscaler to scale up.

replicas

string (int64 format)

The total number of current GameServer replicas in this fleet.

DeployedFleetAutoscaler

Details about the Agones autoscaler.

JSON representation
{
  "autoscaler": string,
  "specSource": {
    object (SpecSource)
  },
  "fleetAutoscalerSpec": string
}
Fields
autoscaler

string

The name of the Agones autoscaler.

specSource

object (SpecSource)

The source spec that is used to create the autoscaler. The GameServerConfig resource may no longer exist in the system.

fleetAutoscalerSpec

string

The autoscaler spec retrieved from Agones.