Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.
This method waits—the workflow execution is paused—until the operation is
complete, fails, or times out. The default timeout value is 1800 seconds (30
minutes) and can be changed to a maximum value of 31536000 seconds (one year)
for long-running operations using the connector_params field. See the
Connectors reference.
The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors.
The polling policy for the long-running operation can be configured. To set the
connector-specific parameters (connector_params), refer to
Invoke a connector call.
Arguments
| Parameters | |
|---|---|
instance |
Required. Name of the instance resource to update.
|
project |
Required. Project ID for this request.
|
zone |
Required. The name of the zone for this request.
|
minimalAction |
Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require.
|
| Enum type. Can be one of the following: | |
INVALID |
(No description provided) |
NO_EFFECT |
No changes can be made to the instance. |
REFRESH |
The instance will not restart. |
RESTART |
The instance will restart. |
mostDisruptiveAllowedAction |
Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART.
|
| Enum type. Can be one of the following: | |
INVALID |
(No description provided) |
NO_EFFECT |
No changes can be made to the instance. |
REFRESH |
The instance will not restart. |
RESTART |
The instance will restart. |
requestId |
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).
|
body |
Required.
|
Raised exceptions
| Exceptions | |
|---|---|
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
OperationError |
If the long-running operation finished unsuccessfully. |
ResponseTypeError |
If the long-running operation returned a response of the wrong type. |
Response
If successful, the response contains an instance of Operation.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- update:
call: googleapis.compute.v1.instances.update
args:
instance: ...
project: ...
zone: ...
minimalAction: ...
mostDisruptiveAllowedAction: ...
requestId: ...
body:
advancedMachineFeatures:
enableNestedVirtualization: ...
enableUefiNetworking: ...
threadsPerCore: ...
visibleCoreCount: ...
canIpForward: ...
confidentialInstanceConfig:
enableConfidentialCompute: ...
deletionProtection: ...
description: ...
disks: ...
displayDevice:
enableDisplay: ...
fingerprint: ...
guestAccelerators: ...
hostname: ...
instanceEncryptionKey:
kmsKeyName: ...
kmsKeyServiceAccount: ...
rawKey: ...
rsaEncryptedKey: ...
keyRevocationActionType: ...
labelFingerprint: ...
labels: ...
machineType: ...
metadata:
fingerprint: ...
items:
key: ...
value: ...
minCpuPlatform: ...
name: ...
networkInterfaces: ...
networkPerformanceConfig:
totalEgressBandwidthTier: ...
params:
resourceManagerTags: ...
privateIpv6GoogleAccess: ...
reservationAffinity:
consumeReservationType: ...
key: ...
values: ...
resourcePolicies: ...
scheduling:
automaticRestart: ...
instanceTerminationAction: ...
localSsdRecoveryTimeout:
nanos: ...
seconds: ...
locationHint: ...
minNodeCpus: ...
nodeAffinities: ...
onHostMaintenance: ...
preemptible: ...
provisioningModel: ...
serviceAccounts: ...
shieldedInstanceConfig:
enableIntegrityMonitoring: ...
enableSecureBoot: ...
enableVtpm: ...
shieldedInstanceIntegrityPolicy:
updateAutoLearnPolicy: ...
sourceMachineImage: ...
sourceMachineImageEncryptionKey: ...
tags:
fingerprint: ...
items: ...
result: updateResult
JSON
[
{
"update": {
"call": "googleapis.compute.v1.instances.update",
"args": {
"instance": "...",
"project": "...",
"zone": "...",
"minimalAction": "...",
"mostDisruptiveAllowedAction": "...",
"requestId": "...",
"body": {
"advancedMachineFeatures": {
"enableNestedVirtualization": "...",
"enableUefiNetworking": "...",
"threadsPerCore": "...",
"visibleCoreCount": "..."
},
"canIpForward": "...",
"confidentialInstanceConfig": {
"enableConfidentialCompute": "..."
},
"deletionProtection": "...",
"description": "...",
"disks": "...",
"displayDevice": {
"enableDisplay": "..."
},
"fingerprint": "...",
"guestAccelerators": "...",
"hostname": "...",
"instanceEncryptionKey": {
"kmsKeyName": "...",
"kmsKeyServiceAccount": "...",
"rawKey": "...",
"rsaEncryptedKey": "..."
},
"keyRevocationActionType": "...",
"labelFingerprint": "...",
"labels": "...",
"machineType": "...",
"metadata": {
"fingerprint": "...",
"items": {
"key": "...",
"value": "..."
}
},
"minCpuPlatform": "...",
"name": "...",
"networkInterfaces": "...",
"networkPerformanceConfig": {
"totalEgressBandwidthTier": "..."
},
"params": {
"resourceManagerTags": "..."
},
"privateIpv6GoogleAccess": "...",
"reservationAffinity": {
"consumeReservationType": "...",
"key": "...",
"values": "..."
},
"resourcePolicies": "...",
"scheduling": {
"automaticRestart": "...",
"instanceTerminationAction": "...",
"localSsdRecoveryTimeout": {
"nanos": "...",
"seconds": "..."
},
"locationHint": "...",
"minNodeCpus": "...",
"nodeAffinities": "...",
"onHostMaintenance": "...",
"preemptible": "...",
"provisioningModel": "..."
},
"serviceAccounts": "...",
"shieldedInstanceConfig": {
"enableIntegrityMonitoring": "...",
"enableSecureBoot": "...",
"enableVtpm": "..."
},
"shieldedInstanceIntegrityPolicy": {
"updateAutoLearnPolicy": "..."
},
"sourceMachineImage": "...",
"sourceMachineImageEncryptionKey": "...",
"tags": {
"fingerprint": "...",
"items": "..."
}
}
},
"result": "updateResult"
}
}
]