GOgoogle
apps

GET /v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}

Changed on

Gets instance information.

Request

  • Base URL
    https://appengine.googleapis.com
  • Auth
    • OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/appengine.admin
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/appengine.admin
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/cloud-platform
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/cloud-platform.read-only
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/cloud-platform.read-only
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

appsIdstring required

Part of name. Required. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.

servicesIdstring required

Part of name. See documentation of appsId.

versionsIdstring required

Part of name. See documentation of appsId.

instancesIdstring required

Part of name. See documentation of appsId.

Response

Successful response

appEngineReleasestring

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

availability'UNSPECIFIED' | 'RESIDENT' | 'DYNAMIC'

Output only. Availability of the instance.

averageLatencyinteger

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

errorsinteger

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

idstring

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

memoryUsagestring int64

Output only. Total memory in use (bytes).

namestring

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

qpsnumber float

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

requestsinteger

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

startTimestring google-datetime

Output only. Time that this instance was started.@OutputOnly

vmDebugEnabledboolean

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

vmIdstring

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

vmIpstring

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

vmLiveness'LIVENESS_STATE_UNSPECIFIED' | 'UNKNOWN' | 'HEALTHY' | 'UNHEALTHY' | 'DRAINING' | 'TIMEOUT'

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

vmNamestring

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

vmStatusstring

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

vmZoneNamestring

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

Changes

  • 26594fa2c248Revision changes
    • info

      the security scope https://www.googleapis.com/auth/appengine.admin was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/appengine.admin was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform.read-only was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform.read-only was removed from the endpoint's security scheme Oauth2c

  • 6e6d92024789Revision changes
    • breaking

      removed the media type */* for the response with the status

    • info

      the security scope https://www.googleapis.com/auth/appengine.admin was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/appengine.admin was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform.read-only was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform.read-only was removed from the endpoint's security scheme Oauth2c