REST Resource: apps.services.versions.instances

• Resource: Instance
  • JSON representation
• Availability
• Methods

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": number, "errors": number, "qps": number, "averageLatency": number, "memoryUsage": string, "vmStatus": string, "vmDebugEnabled": boolean, "vmIp": string }

Fields
name	string Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1. Note: This field is used in responses only. Any value specified here in a request is ignored.
id	string Relative name of the instance within the version. Example: instance-1. Note: This field is used in responses only. Any value specified here in a request is ignored.
appEngineRelease	string App Engine release this instance is running on. Note: This field is used in responses only. Any value specified here in a request is ignored.
availability	enum(Availability) Availability of the instance. Note: This field is used in responses only. Any value specified here in a request is ignored.
vmName	string Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. Note: This field is used in responses only. Any value specified here in a request is ignored.
vmZoneName	string Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. Note: This field is used in responses only. Any value specified here in a request is ignored.
vmId	string Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. Note: This field is used in responses only. Any value specified here in a request is ignored.
startTime	string (Timestamp format) Time that this instance was started. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". Note: This field is used in responses only. Any value specified here in a request is ignored.
requests	number Number of requests since this instance was started. Note: This field is used in responses only. Any value specified here in a request is ignored.
errors	number Number of errors since this instance was started. Note: This field is used in responses only. Any value specified here in a request is ignored.
qps	number Average queries per second (QPS) over the last minute. Note: This field is used in responses only. Any value specified here in a request is ignored.
averageLatency	number Average latency (ms) over the last minute. Note: This field is used in responses only. Any value specified here in a request is ignored.
memoryUsage	string (int64 format) Total memory in use (bytes). Note: This field is used in responses only. Any value specified here in a request is ignored.
vmStatus	string Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. Note: This field is used in responses only. Any value specified here in a request is ignored.
vmDebugEnabled	boolean Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. Note: This field is used in responses only. Any value specified here in a request is ignored.
vmIp	string The IP address of this instance. Only applicable for instances in App Engine flexible environment. Note: This field is used in responses only. Any value specified here in a request is ignored.

Availability

Availability of the instance.

Enums
UNSPECIFIED
RESIDENT
DYNAMIC

Methods
debug	Enables debugging on a VM instance.
delete	Stops a running instance.
get	Gets instance information.
list	Lists the instances of a version.