Insert

Creates a managed instance group using the information that you specify in the request

56 variables
32 variables

Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.

A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your data across Google Cloud Platform services
  • View and manage your Google Compute Engine resources

Input

This building block consumes 56 input parameters

  = Parameter name
  = Format

project STRING Required

Project ID for this request

zone STRING Required

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

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)

autoHealingPolicies[] OBJECT

autoHealingPolicies[].healthCheck STRING

The URL for the health check that signals autohealing

autoHealingPolicies[].initialDelaySec INTEGER

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]

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

creationTimestamp STRING

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

currentActions OBJECT

currentActions.abandoning INTEGER

[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.creating INTEGER

[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 INTEGER

[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.deleting INTEGER

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

currentActions.none INTEGER

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

currentActions.recreating INTEGER

[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.refreshing INTEGER

[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

currentActions.restarting INTEGER

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

currentActions.verifying INTEGER

[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

description STRING

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

distributionPolicy OBJECT

distributionPolicy.zones[] OBJECT

distributionPolicy.zones[].zone STRING

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

fingerprint BINARY

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

id INTEGER

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

instanceGroup STRING

[Output Only] The URL of the Instance Group resource

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

kind STRING

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

name STRING

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

namedPorts[] OBJECT

The named port. For example:

namedPorts[].name STRING

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

namedPorts[].port INTEGER

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

region STRING

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

selfLink STRING

[Output Only] The URL for this managed instance group. The server defines this URL

status OBJECT

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

targetPools[] STRING

targetSize INTEGER

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

updatePolicy OBJECT

updatePolicy.maxSurge OBJECT

Encapsulates numeric value that can be either absolute or relative

updatePolicy.maxSurge.calculated INTEGER

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

  • If the value is fixed, then the calculated 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.maxSurge.fixed INTEGER

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

updatePolicy.maxSurge.percent INTEGER

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

updatePolicy.maxUnavailable OBJECT

Encapsulates numeric value that can be either absolute or relative

updatePolicy.maxUnavailable.calculated INTEGER

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

  • If the value is fixed, then the calculated 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.fixed INTEGER

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

updatePolicy.maxUnavailable.percent INTEGER

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

updatePolicy.minimalAction ENUMERATION

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.type ENUMERATION

The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls)

versions[] OBJECT

versions[].instanceTemplate STRING

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

versions[].name STRING

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

versions[].targetSize OBJECT

Encapsulates numeric value that can be either absolute or relative

versions[].targetSize.calculated INTEGER

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

  • If the value is fixed, then the calculated 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.

versions[].targetSize.fixed INTEGER

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

versions[].targetSize.percent INTEGER

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

zone STRING

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

Output

This building block provides 32 output parameters

  = Parameter name
  = Format

clientOperationId STRING

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

creationTimestamp STRING

[Deprecated] This field is deprecated

description STRING

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

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

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

httpErrorMessage STRING

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

httpErrorStatusCode INTEGER

[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

id INTEGER

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

insertTime STRING

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

kind STRING

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

name STRING

[Output Only] Name of the resource

operationType STRING

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

progress INTEGER

[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

region STRING

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations

selfLink STRING

[Output Only] Server-defined URL for the resource

startTime STRING

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

status ENUMERATION

[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

targetId INTEGER

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

targetLink STRING

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from

user STRING

[Output Only] User who requested the operation, for example: [email protected]

warnings[] OBJECT

warnings[].code ENUMERATION

[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[].data[] OBJECT

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

warnings[].message STRING

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

zone STRING

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations