Creates an instance resource in the specified project using the data included in the request.
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 | |
|---|---|
project |
Required. Project ID for this request.
|
zone |
Required. The name of the zone for this request.
|
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).
|
sourceInstanceTemplate |
Specifies instance template to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate
|
sourceMachineImage |
Specifies the machine image to use to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to a machine image: - https://www.googleapis.com/compute/v1/projects/project/global/global /machineImages/machineImage - projects/project/global/global/machineImages/machineImage - global/machineImages/machineImage
|
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
- insert:
call: googleapis.compute.beta.instances.insert
args:
project: ...
zone: ...
requestId: ...
sourceInstanceTemplate: ...
sourceMachineImage: ...
body:
advancedMachineFeatures:
enableNestedVirtualization: ...
enableUefiNetworking: ...
threadsPerCore: ...
visibleCoreCount: ...
canIpForward: ...
confidentialInstanceConfig:
enableConfidentialCompute: ...
deletionProtection: ...
description: ...
disks: ...
displayDevice:
enableDisplay: ...
eraseWindowsVssSignature: ...
fingerprint: ...
guestAccelerators: ...
hostname: ...
instanceEncryptionKey:
kmsKeyName: ...
kmsKeyServiceAccount: ...
rawKey: ...
rsaEncryptedKey: ...
keyRevocationActionType: ...
labelFingerprint: ...
labels: ...
machineType: ...
metadata:
fingerprint: ...
items:
key: ...
value: ...
minCpuPlatform: ...
name: ...
networkInterfaces: ...
networkPerformanceConfig:
totalEgressBandwidthTier: ...
params:
resourceManagerTags: ...
postKeyRevocationActionType: ...
privateIpv6GoogleAccess: ...
reservationAffinity:
consumeReservationType: ...
key: ...
values: ...
resourcePolicies: ...
scheduling:
automaticRestart: ...
hostErrorTimeoutSeconds: ...
instanceTerminationAction: ...
localSsdRecoveryTimeout:
nanos: ...
seconds: ...
locationHint: ...
maintenanceFreezeDurationHours: ...
maintenanceInterval: ...
maxRunDuration: ...
minNodeCpus: ...
nodeAffinities: ...
onHostMaintenance: ...
preemptible: ...
provisioningModel: ...
terminationTime: ...
serviceAccounts: ...
shieldedInstanceConfig:
enableIntegrityMonitoring: ...
enableSecureBoot: ...
enableVtpm: ...
shieldedInstanceIntegrityPolicy:
updateAutoLearnPolicy: ...
shieldedVmConfig:
enableIntegrityMonitoring: ...
enableSecureBoot: ...
enableVtpm: ...
shieldedVmIntegrityPolicy:
updateAutoLearnPolicy: ...
sourceMachineImage: ...
sourceMachineImageEncryptionKey: ...
tags:
fingerprint: ...
items: ...
result: insertResult
JSON
[
{
"insert": {
"call": "googleapis.compute.beta.instances.insert",
"args": {
"project": "...",
"zone": "...",
"requestId": "...",
"sourceInstanceTemplate": "...",
"sourceMachineImage": "...",
"body": {
"advancedMachineFeatures": {
"enableNestedVirtualization": "...",
"enableUefiNetworking": "...",
"threadsPerCore": "...",
"visibleCoreCount": "..."
},
"canIpForward": "...",
"confidentialInstanceConfig": {
"enableConfidentialCompute": "..."
},
"deletionProtection": "...",
"description": "...",
"disks": "...",
"displayDevice": {
"enableDisplay": "..."
},
"eraseWindowsVssSignature": "...",
"fingerprint": "...",
"guestAccelerators": "...",
"hostname": "...",
"instanceEncryptionKey": {
"kmsKeyName": "...",
"kmsKeyServiceAccount": "...",
"rawKey": "...",
"rsaEncryptedKey": "..."
},
"keyRevocationActionType": "...",
"labelFingerprint": "...",
"labels": "...",
"machineType": "...",
"metadata": {
"fingerprint": "...",
"items": {
"key": "...",
"value": "..."
}
},
"minCpuPlatform": "...",
"name": "...",
"networkInterfaces": "...",
"networkPerformanceConfig": {
"totalEgressBandwidthTier": "..."
},
"params": {
"resourceManagerTags": "..."
},
"postKeyRevocationActionType": "...",
"privateIpv6GoogleAccess": "...",
"reservationAffinity": {
"consumeReservationType": "...",
"key": "...",
"values": "..."
},
"resourcePolicies": "...",
"scheduling": {
"automaticRestart": "...",
"hostErrorTimeoutSeconds": "...",
"instanceTerminationAction": "...",
"localSsdRecoveryTimeout": {
"nanos": "...",
"seconds": "..."
},
"locationHint": "...",
"maintenanceFreezeDurationHours": "...",
"maintenanceInterval": "...",
"maxRunDuration": "...",
"minNodeCpus": "...",
"nodeAffinities": "...",
"onHostMaintenance": "...",
"preemptible": "...",
"provisioningModel": "...",
"terminationTime": "..."
},
"serviceAccounts": "...",
"shieldedInstanceConfig": {
"enableIntegrityMonitoring": "...",
"enableSecureBoot": "...",
"enableVtpm": "..."
},
"shieldedInstanceIntegrityPolicy": {
"updateAutoLearnPolicy": "..."
},
"shieldedVmConfig": {
"enableIntegrityMonitoring": "...",
"enableSecureBoot": "...",
"enableVtpm": "..."
},
"shieldedVmIntegrityPolicy": {
"updateAutoLearnPolicy": "..."
},
"sourceMachineImage": "...",
"sourceMachineImageEncryptionKey": "...",
"tags": {
"fingerprint": "...",
"items": "..."
}
}
},
"result": "insertResult"
}
}
]