REST Resource: apps.services.versions.instances

Resource: Instance

An Instance resource is the computing unit that App Engine uses to automatically scale an application.

JSON representation 
{
  "name": string,
  "id": string,
  "appEngineRelease": string,
  "availability": enum (Availability),
  "vmName": string,
  "vmZoneName": string,
  "vmId": string,
  "startTime": string,
  "requests": integer,
  "errors": integer,
  "qps": number,
  "averageLatency": integer,
  "memoryUsage": string,
  "vmStatus": string,
  "vmDebugEnabled": boolean,
  "vmIp": string,
  "vmLiveness": enum (LivenessState)
}
Fields
name

string

Output only. Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
id

string

Output only. Relative name of the instance within the version. Example: instance-1.
appEngineRelease

string

Output only. App Engine release this instance is running on.
availability

enum (Availability)

Output only. Availability of the instance.
vmName

string

Output only. Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.
vmZoneName

string

Output only. Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.
vmId

string

Output only. Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.
startTime

string (Timestamp format)

Output only. Time that this instance was started.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Note: This field is used in responses only. Any value specified here in a request is ignored.
requests

integer

Output only. Number of requests since this instance was started.
errors

integer

Output only. Number of errors since this instance was started.
qps

number

Output only. Average queries per second (QPS) over the last minute.
averageLatency

integer

Output only. Average latency (ms) over the last minute.
memoryUsage

string (int64 format)

Output only. Total memory in use (bytes).
vmStatus

string

Output only. Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.
vmDebugEnabled

boolean

Output only. Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.
vmIp

string

Output only. The IP address of this instance. Only applicable for instances in App Engine flexible environment.
vmLiveness

enum (LivenessState)

Output only. The liveness health check of this instance. Only applicable for instances in App Engine flexible environment.

Availability

Availability of the instance.

Enums
UNSPECIFIED
RESIDENT
DYNAMIC

LivenessState

Liveness health check status for Flex instances.

Enums
LIVENESS_STATE_UNSPECIFIED There is no liveness health check for the instance. Only applicable for instances in App Engine standard environment.
UNKNOWN The health checking system is aware of the instance but its health is not known at the moment.
HEALTHY The instance is reachable i.e. a connection to the application health checking endpoint can be established, and conforms to the requirements defined by the health check.
UNHEALTHY The instance is reachable, but does not conform to the requirements defined by the health check.
DRAINING The instance is being drained. The existing connections to the instance have time to complete, but the new ones are being refused.
TIMEOUT The instance is unreachable i.e. a connection to the application health checking endpoint cannot be established, or the server does not respond within the specified timeout.

Methods

debug

 Enables debugging on a VM instance.

delete

 Stops a running instance.

get

 Gets instance information.

list

 Lists the instances of a version.