Method: instanceGroupManagers.createInstances

Creates instances with per-instance configs in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

zone

string

The name of the zone where the managed instance group is located. It should conform to RFC1035.

resourceId

string

The name of the managed instance group. It should conform to RFC1035.

Authorization requires the following IAM permission on the specified resource instanceGroupManager:

  • 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.

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
{
  "instances": [
    {
      "name": string,
      "preservedState": {
        "disks": {
          string: {
            "source": string,
            "mode": enum,
            "autoDelete": enum
          },
          ...
        },
        "metadata": {
          string: string,
          ...
        }
      },
      "status": enum,
      "fingerprint": string
    }
  ]
}
Fields
instances[].name

string

The name of a per-instance config and its corresponding instance. Serves as a merge key during instanceGroupManagers.updatePerInstanceConfigs operations, that is, if a per-instance config with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance config for a VM instance that either doesn't exist or is not part of the group will result in an error.

instances[].preservedState.disks[]

map (key: string, value: object)

Preserved disks defined for this instance. This map is keyed with the device names of the disks.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

instances[].preservedState.disks[].source

string

The URL of the disk resource that is stateful and should be attached to the VM instance.

instances[].preservedState.disks[].mode

enum

The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

instances[].preservedState.disks[].autoDelete

enum

These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.

instances[].preservedState.metadata

map (key: string, value: string)

Preserved metadata defined for this instance.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

instances[].status

enum

The status of applying this per-instance config on the corresponding managed instance.