instances

Creates, updates, deletes, gets or lists an instances resource.

Overview

Name	instances
Type	Resource
Id	google.appengine.instances

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
id	string	Output only. Relative name of the instance within the version. Example: instance-1.
name	string	Output only. Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
appEngineRelease	string	Output only. App Engine release this instance is running on.
availability	string	Output only. Availability of the instance.
averageLatency	integer (int32)	Output only. Average latency (ms) over the last minute.
errors	integer (int32)	Output only. Number of errors since this instance was started.
memoryUsage	string (int64)	Output only. Total memory in use (bytes).
qps	number (float)	Output only. Average queries per second (QPS) over the last minute.
requests	integer (int32)	Output only. Number of requests since this instance was started.
startTime	string (google-datetime)	Output only. Time that this instance was started.@OutputOnly
vmDebugEnabled	boolean	Output only. Whether this instance is in debug mode. 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.
vmIp	string	Output only. The IP address of this instance. Only applicable for instances in App Engine flexible environment.
vmLiveness	string	Output only. The liveness health check of this instance. Only applicable for instances in App Engine flexible environment.
vmName	string	Output only. Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.
vmStatus	string	Output only. Status 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.

list

Successful response

Name	Datatype	Description
id	string	Output only. Relative name of the instance within the version. Example: instance-1.
name	string	Output only. Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
appEngineRelease	string	Output only. App Engine release this instance is running on.
availability	string	Output only. Availability of the instance.
averageLatency	integer (int32)	Output only. Average latency (ms) over the last minute.
errors	integer (int32)	Output only. Number of errors since this instance was started.
memoryUsage	string (int64)	Output only. Total memory in use (bytes).
qps	number (float)	Output only. Average queries per second (QPS) over the last minute.
requests	integer (int32)	Output only. Number of requests since this instance was started.
startTime	string (google-datetime)	Output only. Time that this instance was started.@OutputOnly
vmDebugEnabled	boolean	Output only. Whether this instance is in debug mode. 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.
vmIp	string	Output only. The IP address of this instance. Only applicable for instances in App Engine flexible environment.
vmLiveness	string	Output only. The liveness health check of this instance. Only applicable for instances in App Engine flexible environment.
vmName	string	Output only. Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.
vmStatus	string	Output only. Status 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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	appsId, servicesId, versionsId, instancesId		Gets instance information.
list	select	appsId, servicesId, versionsId	pageSize, pageToken	Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
delete	delete	appsId, servicesId, versionsId, instancesId		Stops a running instance.The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" (standard environment (https://cloud.google.com/appengine/docs/standard/python/how-instances-are-managed) | flexible environment (https://cloud.google.com/appengine/docs/flexible/python/how-instances-are-managed)).To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to STOPPED with the apps.services.versions.patch (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions/patch) method.
debug	exec	appsId, servicesId, versionsId, instancesId		Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
appsId	string
instancesId	string
servicesId	string
versionsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets instance information.

SELECT
id,
name,
appEngineRelease,
availability,
averageLatency,
errors,
memoryUsage,
qps,
requests,
startTime,
vmDebugEnabled,
vmId,
vmIp,
vmLiveness,
vmName,
vmStatus,
vmZoneName
FROM google.appengine.instances
WHERE appsId = '{{ appsId }}' -- required
AND servicesId = '{{ servicesId }}' -- required
AND versionsId = '{{ versionsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required;

list

Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).

SELECT
id,
name,
appEngineRelease,
availability,
averageLatency,
errors,
memoryUsage,
qps,
requests,
startTime,
vmDebugEnabled,
vmId,
vmIp,
vmLiveness,
vmName,
vmStatus,
vmZoneName
FROM google.appengine.instances
WHERE appsId = '{{ appsId }}' -- required
AND servicesId = '{{ servicesId }}' -- required
AND versionsId = '{{ versionsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

DELETE examples

delete

Stops a running instance.The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" (standard environment (https://cloud.google.com/appengine/docs/standard/python/how-instances-are-managed) | flexible environment (https://cloud.google.com/appengine/docs/flexible/python/how-instances-are-managed)).To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to STOPPED with the apps.services.versions.patch (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions/patch) method.

DELETE FROM google.appengine.instances
WHERE appsId = '{{ appsId }}' --required
AND servicesId = '{{ servicesId }}' --required
AND versionsId = '{{ versionsId }}' --required
AND instancesId = '{{ instancesId }}' --required;

Lifecycle Methods

debug

Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.

EXEC google.appengine.instances.debug 
@appsId='{{ appsId }}' --required, 
@servicesId='{{ servicesId }}' --required, 
@versionsId='{{ versionsId }}' --required, 
@instancesId='{{ instancesId }}' --required 
@@json=
'{
"sshKey": "{{ sshKey }}"
}';