Skip to main content

instances

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

Overview

Nameinstances
TypeResource
Idgoogle.appengine.instances

Fields

NameDatatypeDescription
idstringOutput only. Relative name of the instance within the version. Example: instance-1.
namestringOutput only. Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
appEngineReleasestringOutput only. App Engine release this instance is running on.
availabilitystringOutput only. Availability of the instance.
averageLatencyintegerOutput only. Average latency (ms) over the last minute.
errorsintegerOutput only. Number of errors since this instance was started.
memoryUsagestringOutput only. Total memory in use (bytes).
qpsnumberOutput only. Average queries per second (QPS) over the last minute.
requestsintegerOutput only. Number of requests since this instance was started.
startTimestringOutput only. Time that this instance was started.@OutputOnly
vmDebugEnabledbooleanOutput only. Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.
vmIdstringOutput only. Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.
vmIpstringOutput only. The IP address of this instance. Only applicable for instances in App Engine flexible environment.
vmLivenessstringOutput only. The liveness health check of this instance. Only applicable for instances in App Engine flexible environment.
vmNamestringOutput only. Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.
vmStatusstringOutput only. Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.
vmZoneNamestringOutput only. Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.

Methods

NameAccessible byRequired ParamsDescription
getSELECTappsId, instancesId, servicesId, versionsIdGets instance information.
listSELECTappsId, servicesId, versionsIdLists 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).
deleteDELETEappsId, instancesId, servicesId, versionsIdStops 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)
debugEXECappsId, instancesId, servicesId, versionsIdEnables 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.

SELECT examples

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 }}'
AND servicesId = '{{ servicesId }}'
AND versionsId = '{{ versionsId }}';

DELETE example

Deletes the specified instances resource.

/*+ delete */
DELETE FROM google.appengine.instances
WHERE appsId = '{{ appsId }}'
AND instancesId = '{{ instancesId }}'
AND servicesId = '{{ servicesId }}'
AND versionsId = '{{ versionsId }}';