Method: instanceGroupManagers.patch

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

HTTP request

PATCH https://www.googleapis.com/compute/beta/projects/{project}/zones/{zone}/instanceGroupManagers/{resourceId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

zone

string

The name of the zone where you want to create the managed instance group.

resourceId

string

The name of the instance group manager.

Authorization requires one or more of the following Google IAM permissions on the specified resource instanceGroupManager:

  • compute.instanceGroupManagers.get
  • compute.instanceGroupManagers.update

Query parameters

Parameters
requestId

string

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

The request body contains data with the following structure:

JSON representation
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "zone": string,
  "region": string,
  "distributionPolicy": {
    "zones": [
      
    ]
  },
  "instanceTemplate": string,
  "versions": [
    {
      "name": string,
      "instanceTemplate": string,
      "targetSize": 
    }
  ],
  "instanceGroup": string,
  "targetPools": [
    string
  ],
  "baseInstanceName": string,
  "fingerprint": string,
  "currentActions": {
    "none": number,
    "creating": number,
    "creatingWithoutRetries": number,
    "verifying": number,
    "recreating": number,
    "deleting": number,
    "abandoning": number,
    "restarting": number,
    "refreshing": number
  },
  "pendingActions": {
    "creating": number,
    "deleting": number,
    "recreating": number,
    "restarting": number
  },
  "status": {
    "isStable": boolean
  },
  "targetSize": number,
  "selfLink": string,
  "autoHealingPolicies": [
    {
      "healthCheck": string,
      "initialDelaySec": number
    }
  ],
  "updatePolicy": {
    "type": enum,
    "minimalAction": enum,
    "maxSurge": ,
    "maxUnavailable": ,
    "minReadySec": number
  },
  "namedPorts": [
    {
      "name": string,
      "port": number
    }
  ],
  "serviceAccount": string,
  "failoverAction": enum,
  "kind": string
}
Fields
id

string (fixed64 format)

[Output Only] A unique identifier for this resource type. The server generates this identifier.

creationTimestamp

string

[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

name

string

The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

description

string

An optional description of this resource. Provide this property when you create the resource.

zone

string

[Output Only] The URL of the zone where the managed instance group is located (for zonal resources).

region

string

[Output Only] The URL of the region where the managed instance group resides (for regional resources).

distributionPolicy

object

Policy specifying intended distribution of instances in regional managed instance group.

distributionPolicy.zones[]

object

Zones where the regional managed instance group will create and manage instances.

distributionPolicy.zones[].zone

string

The URL of the zone. The zone must exist in the region where the managed instance group is located.

instanceTemplate

string

The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.

Authorization requires the following Google IAM permission on the specified resource instanceTemplate:

  • compute.instanceTemplates.useReadOnly

versions[]

object

Specifies the instance templates used by this managed instance group to create instances.

Each version is defined by an instanceTemplate. Every template can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.

versions[].name

string

Name of the version. Unique among all versions in the scope of this managed instance group.

versions[].instanceTemplate

string

Authorization requires the following Google IAM permission on the specified resource instanceTemplate:

  • compute.instanceTemplates.useReadOnly

versions[].targetSize

object

Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to:

  • If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.
  • if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded up.
If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.

versions[].targetSize.fixed

number

Specifies a fixed number of VM instances. This must be a positive integer.

versions[].targetSize.percent

number

Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

versions[].targetSize.calculated

number

[Output Only] Absolute value of VM instances calculated based on the specific mode.

  • If the value is fixed, then the caculated value is equal to the fixed value.
  • If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded up.

instanceGroup

string

[Output Only] The URL of the Instance Group resource.

targetPools[]

string

The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

Authorization requires the following Google IAM permission on the specified resource targetPools:

  • compute.targetPools.get

baseInstanceName

string

The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.

fingerprint

string (bytes format)

Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

A base64-encoded string.

currentActions

object

[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.

currentActions.none

number

[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.

currentActions.creating

number

[Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.

If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.

currentActions.creatingWithoutRetries

number

[Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.

currentActions.verifying

number

[Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation.

currentActions.recreating

number

[Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.

currentActions.deleting

number

[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.

currentActions.abandoning

number

[Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.

currentActions.restarting

number

[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.

currentActions.refreshing

number

[Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.

pendingActions

object

[Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.

pendingActions.creating

number

[Output Only] The number of instances in the managed instance group that are pending to be created.

pendingActions.deleting

number

[Output Only] The number of instances in the managed instance group that are pending to be deleted.

pendingActions.recreating

number

[Output Only] The number of instances in the managed instance group that are pending to be recreated.

pendingActions.restarting

number

[Output Only] The number of instances in the managed instance group that are pending to be restarted.

status

object

[Output Only] The status of this managed instance group.

status.isStable

boolean

[Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.

targetSize

number

The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.

autoHealingPolicies[]

object

The autohealing policy for this managed instance group. You can specify only one value.

autoHealingPolicies[].healthCheck

string

The URL for the health check that signals autohealing.

Authorization requires one or more of the following Google IAM permissions on the specified resource healthCheck:

  • compute.healthChecks.use
  • compute.httpHealthChecks.use
  • compute.httpsHealthChecks.use

autoHealingPolicies[].initialDelaySec

number

The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].

updatePolicy

object

The update policy for this managed instance group.

updatePolicy.type

enum

updatePolicy.minimalAction

enum

Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.

updatePolicy.maxSurge

object

The maximum number of instances that can be created above the specified targetSize during the update process. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.

At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

updatePolicy.maxSurge.fixed

number

Specifies a fixed number of VM instances. This must be a positive integer.

updatePolicy.maxSurge.percent

number

Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

updatePolicy.maxSurge.calculated

number

[Output Only] Absolute value of VM instances calculated based on the specific mode.

  • If the value is fixed, then the caculated value is equal to the fixed value.
  • If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded up.

updatePolicy.maxUnavailable

object

The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied:

  • The instance's status is RUNNING.
  • If there is a health check on the instance group, the instance's liveness health check result must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available.

By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.

At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

updatePolicy.maxUnavailable.fixed

number

Specifies a fixed number of VM instances. This must be a positive integer.

updatePolicy.maxUnavailable.percent

number

Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

updatePolicy.maxUnavailable.calculated

number

[Output Only] Absolute value of VM instances calculated based on the specific mode.

  • If the value is fixed, then the caculated value is equal to the fixed value.
  • If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded up.

updatePolicy.minReadySec

number

Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].

namedPorts[]

object

Named ports configured for the Instance Groups complementary to this Instance Group Manager.

namedPorts[].name

string

The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

namedPorts[].port

number

The port number, which can be a value between 1 and 65535.

serviceAccount

string

The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used.

failoverAction

enum

The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.

kind

string

[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

Response body

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

An Operation resource, used to manage asynchronous API requests.

JSON representation
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "zone": string,
  "clientOperationId": string,
  "operationType": string,
  "targetLink": string,
  "targetId": string,
  "status": enum,
  "statusMessage": string,
  "user": string,
  "progress": number,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    "errors": [
      {
        "code": string,
        "location": string,
        "message": string
      }
    ]
  },
  "warnings": [
    {
      "code": enum,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "httpErrorStatusCode": number,
  "httpErrorMessage": string,
  "selfLink": string,
  "region": string,
  "description": string,
  "kind": string
}
Fields
id

string (fixed64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

creationTimestamp

string

[Deprecated] This field is deprecated.

name

string

[Output Only] Name of the resource.

zone

string

[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

clientOperationId

string

[Output Only] The value of requestId if you provided it in the request. Not present otherwise.

operationType

string

[Output Only] The type of operation, such as insert, update, or delete, and so on.

targetId

string (fixed64 format)

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

status

enum

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.

statusMessage

string

[Output Only] An optional textual description of the current status of the operation.

user

string

[Output Only] User who requested the operation, for example: user@example.com.

progress

number

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

insertTime

string

[Output Only] The time that this operation was requested. This value is in RFC3339 text format.

startTime

string

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

endTime

string

[Output Only] The time that this operation was completed. This value is in RFC3339 text format.

error

object

[Output Only] If errors are generated during processing of the operation, this field will be populated.

error.errors[]

object

[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 that caused the error. This property is optional.

error.errors[].message

string

[Output Only] An optional, human-readable error message.

warnings[]

object

[Output Only] If warning messages are generated during processing of the operation, this field will be populated.

warnings[].code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

warnings[].message

string

[Output Only] A human-readable description of the warning code.

warnings[].data[]

object

[Output Only] Metadata about this warning in key: value format. For example:

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }

warnings[].data[].key

string

[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

warnings[].data[].value

string

[Output Only] A warning data value corresponding to the key.

httpErrorStatusCode

number

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.

httpErrorMessage

string

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.

region

string

[Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

description

string

[Output Only] A textual description of the operation, which is set when the operation is created.

kind

string

[Output Only] Type of the resource. Always compute#operation for Operation resources.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following Google IAM permissions:

  • compute.disks.create
  • compute.images.useReadOnly
  • compute.instances.create
  • compute.instances.setMetadata
  • compute.subnetworks.use
Was this page helpful? Let us know how we did:

Send feedback about...

Compute Engine