RollingUpdates: pause

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

Requires authorization

Pauses the update in state from ROLLING_FORWARD or ROLLING_BACK. Has no effect if invoked when the state of the update is PAUSED. Try it now.

Request

HTTP request

POST https://www.googleapis.com/replicapoolupdater/v1beta1/projects/project/zones/zone/rollingUpdates/rollingUpdate/pause

Parameters

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.

Authorization

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

Scope
https://www.googleapis.com/auth/replicapool
https://www.googleapis.com/auth/cloud-platform

Request body

Do not supply a request body with this method.

Response

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

{
  "kind": "replicapoolupdater#operation",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "zone": string,
  "clientOperationId": string,
  "operationType": string,
  "targetLink": string,
  "targetId": unsigned long,
  "status": string,
  "statusMessage": string,
  "user": string,
  "progress": integer,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    "errors": [
      {
        "code": string,
        "location": string,
        "message": string
      }
    ]
  },
  "warnings": [
    {
      "code": string,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "httpErrorStatusCode": integer,
  "httpErrorMessage": string,
  "selfLink": string,
  "region": string
}

Property name	Value	Description	Notes
kind	string	[Output Only] Type of the resource. Always kind#operation for Operation resources.
id	unsigned long	[Output Only] Unique identifier for the resource; defined by the server.
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
name	string	[Output Only] Name of the resource.
zone	string	[Output Only] URL of the zone where the operation resides.
clientOperationId	string
operationType	string
targetLink	string	[Output Only] URL of the resource the operation is mutating.
targetId	unsigned long	[Output Only] Unique target id which identifies a particular incarnation of the target.
status	string	[Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE". Acceptable values are: "DONE" "PENDING" "RUNNING"
statusMessage	string	[Output Only] An optional textual description of the current status of the operation.
user	string
progress	integer
insertTime	string	[Output Only] The time that this operation was requested. This is in RFC3339 format.
startTime	string	[Output Only] The time that this operation was started by the server. This is in RFC3339 format.
endTime	string
error	object	[Output Only] If errors occurred during processing of this operation, this field will be populated.
error.errors[]	list	[Output Only] The array of errors encountered while processing this operation.
error.errors[].code	string	[Output Only] The error type identifier for this error.
error.errors[].location	string	[Output Only] Indicates the field in the request which caused the error. This property is optional.
error.errors[].message	string	[Output Only] An optional, human-readable error message.
warnings[]	list
warnings[].code	string	[Output only] The warning type identifier for this warning. Acceptable values are: "DEPRECATED_RESOURCE_USED" "DISK_SIZE_LARGER_THAN_IMAGE_SIZE" "INJECTED_KERNELS_DEPRECATED" "NEXT_HOP_ADDRESS_NOT_ASSIGNED" "NEXT_HOP_CANNOT_IP_FORWARD" "NEXT_HOP_INSTANCE_NOT_FOUND" "NEXT_HOP_INSTANCE_NOT_ON_NETWORK" "NEXT_HOP_NOT_RUNNING" "NO_RESULTS_ON_PAGE" "REQUIRED_TOS_AGREEMENT" "RESOURCE_NOT_DELETED" "UNREACHABLE"
warnings[].message	string	[Output only] Optional human-readable details for this warning.
warnings[].data[]	list	[Output only] Metadata for this warning in key:value format.
warnings[].data[].key	string	[Output Only] Metadata key for this warning.
warnings[].data[].value	string	[Output Only] Metadata value for this warning.
httpErrorStatusCode	integer
httpErrorMessage	string
selfLink	string	[Output Only] Server defined URL for the resource.
region	string	[Output Only] URL of the region where the operation resides.

Try it!

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