Notice: Over the next few months, we're reorganizing the App Engine documentation site to make it easier to find content and better align with the rest of Google Cloud products. The same content will be available, but the navigation will now match the rest of the Cloud products. If you have feedback or questions as you navigate the site, click Send Feedback.

Method: apps.services.versions.instances.list

Lists the instances of a version.

Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API.

HTTP request

GET https://appengine.googleapis.com/v1/{parent=apps/*/services/*/versions/*}/instances

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.

Authorization requires the following IAM permission on the specified resource parent:

  • appengine.instances.list

Query parameters

Parameters
pageSize

integer

Maximum results to return per page.
pageToken

string

Continuation token for fetching the next page of results.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for Instances.ListInstances.

JSON representation 
{
  "instances": [
    {
      object (Instance)
    }
  ],
  "nextPageToken": string
}
Fields
instances[]

object (Instance)

The instances belonging to the requested version.
nextPageToken

string

Continuation token for fetching the next page of results.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/appengine.admin
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.