RollingUpdates: listInstanceUpdates

Caution: This is a deprecated version of the Instance Group Updater API. Please use the latest Instance Group Updater version instead.

Requires authorization

Lists the current status for each instance within a given update. Try it now.


HTTP request



Parameter name Value Description
Path parameters
project string Project ID for this request.
rollingUpdate string The name of the update.
zone string The name of the zone in which the update's target resides.
Optional query parameters
filter string Optional. Filter expression for filtering listed resources.
maxResults unsigned integer Optional. Maximum count of results to be returned. Acceptable values are 0 to 500, inclusive. (Default: 500)
pageToken string Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.


This request requires authorization with at least one of the following scopes (read more about authentication and authorization).


Request body

Do not supply a request body with this method.


If successful, this method returns a response body with the following structure:

  "kind": "replicapoolupdater#instanceUpdateList",
  "selfLink": string,
  "nextPageToken": string,
  "items": [
      "instance": string,
      "status": string,
      "error": {
        "errors": [
            "code": string,
            "location": string,
            "message": string
Property name Value Description Notes
kind string [Output Only] Type of the resource.
nextPageToken string A token used to continue a truncated list request.
items[] list Collection of requested instance updates.
items[].instance string URL of the instance being updated.
items[].status string Status of the instance update. Possible values are:
  • "PENDING": The instance update is pending execution.
  • "ROLLING_FORWARD": The instance update is going forward.
  • "ROLLING_BACK": The instance update is being rolled back.
  • "PAUSED": The instance update is temporarily paused (inactive).
  • "ROLLED_OUT": The instance update is finished, the instance is running the new template.
  • "ROLLED_BACK": The instance update is finished, the instance has been reverted to the previous template.
  • "CANCELLED": The instance update is paused and no longer can be resumed, undefined in which template the instance is running.
items[].error object Errors that occurred during the instance update.
items[].error.errors[] list [Output Only] The array of errors encountered while processing this operation.
items[].error.errors[].code string [Output Only] The error type identifier for this error.
items[].error.errors[].location string [Output Only] Indicates the field in the request that caused the error. This property is optional.
items[].error.errors[].message string [Output Only] An optional, human-readable error message.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Was this page helpful? Let us know how we did:

Send feedback about...

Compute Engine Documentation