REST Resource: regionInstanceGroupManagers

Resource: InstanceGroupManager

Represents a Managed Instance Group resource.

An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.

For zonal Managed Instance Group, use the

instanceGroupManagers

resource.

For regional Managed Instance Group, use the

regionInstanceGroupManagers

resource.

JSON representation
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "zone": string,
  "region": string,
  "distributionPolicy": {
    object (DistributionPolicy)
  },
  "instanceTemplate": string,
  "versions": [
    {
      object (Version)
    }
  ],
  "allInstancesConfig": {
    object (AllInstancesConfig)
  },
  "instanceGroup": string,
  "targetPools": [
    string
  ],
  "baseInstanceName": string,
  "fingerprint": string,
  "currentActions": {
    object (ActionsSummary)
  },
  "status": {
    object (Status)
  },
  "targetSize": integer,
  "instanceFlexibilityPolicy": {
    object (InstanceFlexibilityPolicy)
  },
  "targetStoppedSize": integer,
  "targetSuspendedSize": integer,
  "listManagedInstancesResults": enum (ListManagedInstancesResults),
  "standbyPolicy": {
    object (StandbyPolicy)
  },
  "selfLink": string,
  "autoHealingPolicies": [
    {
      object (AutoHealingPolicy)
    }
  ],
  "updatePolicy": {
    object (UpdatePolicy)
  },
  "namedPorts": [
    {
      object (NamedPort)
    }
  ],
  "statefulPolicy": {
    object (StatefulPolicy)
  },
  "instanceLifecyclePolicy": {
    object (InstanceLifecyclePolicy)
  },
  "satisfiesPzi": boolean,
  "satisfiesPzs": boolean,
  "resourcePolicies": {
    object (ResourcePolicies)
  }
}
Fields
kind

string

[Output Only] The resource type, which is always

compute#instanceGroupManager

for managed instance groups.

id

string (uint64 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.

zone

string

[Output Only] The URL of a 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 (DistributionPolicy)

Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.

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. The templates for existing instances in the group do not change unless you run

recreateInstances

, run

applyUpdatesToInstances

, or set the group's

updatePolicy.type

to

PROACTIVE

.

versions[]

object (Version)

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

Each version is defined by an

instanceTemplate

and a

name

. Every version 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.

allInstancesConfig

object (AllInstancesConfig)

Specifies configuration that overrides the instance template configuration for the group.

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.

baseInstanceName

string

The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format.

When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\[[0-9]{1,10}\])?))

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 (ActionsSummary)

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

status

object (Status)

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

targetSize

integer

The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.

instanceFlexibilityPolicy

object (InstanceFlexibilityPolicy)

Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration.

targetStoppedSize

integer

The target number of stopped instances for this managed instance group. This number changes when you:

targetSuspendedSize

integer

The target number of suspended instances for this managed instance group. This number changes when you:

listManagedInstancesResults

enum (ListManagedInstancesResults)

Pagination behavior of the

listManagedInstances

API method for this managed instance group.

standbyPolicy

object (StandbyPolicy)

Standby policy for stopped and suspended instances.

autoHealingPolicies[]

object (AutoHealingPolicy)

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

updatePolicy

object (UpdatePolicy)

The update policy for this managed instance group.

namedPorts[]

object (NamedPort)

[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.

statefulPolicy

object (StatefulPolicy)

Stateful configuration for this Instanced Group Manager

instanceLifecyclePolicy

object (InstanceLifecyclePolicy)

The repair policy for this managed instance group.

satisfiesPzi

boolean

[Output Only] Reserved for future use.

satisfiesPzs

boolean

[Output Only] Reserved for future use.

resourcePolicies

object (ResourcePolicies)

Resource policies for this managed instance group.

Methods

abandonInstances

Flags the specified instances to be immediately removed from the managed instance group.

applyUpdatesToInstances

Apply updates to selected instances the managed instance group.

createInstances

Creates instances with per-instance configurations in this regional managed instance group.

delete

Deletes the specified managed instance group and all of the instances in that group.

deleteInstances

Flags the specified instances in the managed instance group to be immediately deleted.

deletePerInstanceConfigs

Deletes selected per-instance configurations for the managed instance group.

get

Returns all of the details about the specified managed instance group.

insert

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

list

Retrieves the list of managed instance groups that are contained within the specified region.

listErrors

Lists all errors thrown by actions on instances for a given regional managed instance group.

listManagedInstances

Lists the instances in the managed instance group and instances that are scheduled to be created.

listPerInstanceConfigs

Lists all of the per-instance configurations defined for the managed instance group.

patch

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

patchPerInstanceConfigs

Inserts or patches per-instance configurations for the managed instance group.

recreateInstances

Flags the specified VM instances in the managed instance group to be immediately recreated.

resize

Changes the intended size of the managed instance group.

setInstanceTemplate

Sets the instance template to use when creating new instances or recreating instances in this group.

setTargetPools

Modifies the target pools to which all new instances in this group are assigned.

updatePerInstanceConfigs

Inserts or updates per-instance configurations for the managed instance group.

resumeInstances

The method compute.v1.RegionInstanceGroupManagersService.ResumeInstances is not available in Trusted Cloud by S3NS.

startInstances

The method compute.v1.RegionInstanceGroupManagersService.StartInstances is not available in Trusted Cloud by S3NS.

stopInstances

The method compute.v1.RegionInstanceGroupManagersService.StopInstances is not available in Trusted Cloud by S3NS.

suspendInstances

The method compute.v1.RegionInstanceGroupManagersService.SuspendInstances is not available in Trusted Cloud by S3NS.