Skip to main content

region_instance_group_managers

Creates, updates, deletes, gets or lists a region_instance_group_managers resource.

Overview​

Nameregion_instance_group_managers
TypeResource
Idgoogle.compute.region_instance_group_managers

Fields​

NameDatatypeDescription
idstring[Output Only] A unique identifier for this resource type. The server generates this identifier.
namestringThe name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
descriptionstringAn optional description of this resource.
allInstancesConfigobject
autoHealingPoliciesarrayThe autohealing policy for this managed instance group. You can specify only one value.
baseInstanceNamestringThe 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})
creationTimestampstring[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
currentActionsobject
distributionPolicyobject
fingerprintstringFingerprint 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.
instanceGroupstring[Output Only] The URL of the Instance Group resource.
instanceLifecyclePolicyobject
instanceTemplatestringThe 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.
kindstring[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
listManagedInstancesResultsstringPagination behavior of the listManagedInstances API method for this managed instance group.
namedPortsarrayNamed ports configured for the Instance Groups complementary to this Instance Group Manager.
regionstring[Output Only] The URL of the region where the managed instance group resides (for regional resources).
satisfiesPziboolean[Output Only] Reserved for future use.
satisfiesPzsboolean[Output Only] Reserved for future use.
selfLinkstring[Output Only] The URL for this managed instance group. The server defines this URL.
statefulPolicyobject
statusobject
targetPoolsarrayThe 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.
targetSizeintegerThe 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.
updatePolicyobject
versionsarraySpecifies 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.
zonestring[Output Only] The URL of a zone where the managed instance group is located (for zonal resources).

Methods​

NameAccessible byRequired ParamsDescription
getSELECTinstanceGroupManager, project, regionReturns all of the details about the specified managed instance group.
listSELECTproject, regionRetrieves the list of managed instance groups that are contained within the specified region.
insertINSERTproject, regionCreates 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 regional managed instance group can contain up to 2000 instances.
deleteDELETEinstanceGroupManager, project, regionDeletes the specified managed instance group and all of the instances in that group.
patchUPDATEinstanceGroupManager, project, regionUpdates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.
patch_per_instance_configsUPDATEinstanceGroupManager, project, regionInserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.
abandon_instancesEXECinstanceGroupManager, project, regionFlags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.
apply_updates_to_instancesEXECinstanceGroupManager, project, regionApply updates to selected instances the managed instance group.
recreate_instancesEXECinstanceGroupManager, project, regionFlags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.
resizeEXECinstanceGroupManager, project, region, sizeChanges the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.
set_instance_templateEXECinstanceGroupManager, project, regionSets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.
set_target_poolsEXECinstanceGroupManager, project, regionModifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

SELECT examples​

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

SELECT
id,
name,
description,
allInstancesConfig,
autoHealingPolicies,
baseInstanceName,
creationTimestamp,
currentActions,
distributionPolicy,
fingerprint,
instanceGroup,
instanceLifecyclePolicy,
instanceTemplate,
kind,
listManagedInstancesResults,
namedPorts,
region,
satisfiesPzi,
satisfiesPzs,
selfLink,
statefulPolicy,
status,
targetPools,
targetSize,
updatePolicy,
versions,
zone
FROM google.compute.region_instance_group_managers
WHERE project = '{{ project }}'
AND region = '{{ region }}';

INSERT example​

Use the following StackQL query and manifest file to create a new region_instance_group_managers resource.

/*+ create */
INSERT INTO google.compute.region_instance_group_managers (
project,
region,
name,
description,
zone,
region,
distributionPolicy,
instanceTemplate,
versions,
allInstancesConfig,
instanceGroup,
targetPools,
baseInstanceName,
fingerprint,
currentActions,
status,
targetSize,
listManagedInstancesResults,
autoHealingPolicies,
updatePolicy,
namedPorts,
statefulPolicy,
instanceLifecyclePolicy,
satisfiesPzi,
satisfiesPzs
)
SELECT 
'{{ project }}',
'{{ region }}',
'{{ name }}',
'{{ description }}',
'{{ zone }}',
'{{ region }}',
'{{ distributionPolicy }}',
'{{ instanceTemplate }}',
'{{ versions }}',
'{{ allInstancesConfig }}',
'{{ instanceGroup }}',
'{{ targetPools }}',
'{{ baseInstanceName }}',
'{{ fingerprint }}',
'{{ currentActions }}',
'{{ status }}',
'{{ targetSize }}',
'{{ listManagedInstancesResults }}',
'{{ autoHealingPolicies }}',
'{{ updatePolicy }}',
'{{ namedPorts }}',
'{{ statefulPolicy }}',
'{{ instanceLifecyclePolicy }}',
{{ satisfiesPzi }},
{{ satisfiesPzs }}
;

UPDATE example​

Updates a region_instance_group_managers resource.

/*+ update */
UPDATE google.compute.region_instance_group_managers
SET 
name = '{{ name }}',
description = '{{ description }}',
zone = '{{ zone }}',
region = '{{ region }}',
distributionPolicy = '{{ distributionPolicy }}',
instanceTemplate = '{{ instanceTemplate }}',
versions = '{{ versions }}',
allInstancesConfig = '{{ allInstancesConfig }}',
instanceGroup = '{{ instanceGroup }}',
targetPools = '{{ targetPools }}',
baseInstanceName = '{{ baseInstanceName }}',
fingerprint = '{{ fingerprint }}',
currentActions = '{{ currentActions }}',
status = '{{ status }}',
targetSize = '{{ targetSize }}',
listManagedInstancesResults = '{{ listManagedInstancesResults }}',
autoHealingPolicies = '{{ autoHealingPolicies }}',
updatePolicy = '{{ updatePolicy }}',
namedPorts = '{{ namedPorts }}',
statefulPolicy = '{{ statefulPolicy }}',
instanceLifecyclePolicy = '{{ instanceLifecyclePolicy }}',
satisfiesPzi = true|false,
satisfiesPzs = true|false
WHERE 
instanceGroupManager = '{{ instanceGroupManager }}'
AND project = '{{ project }}'
AND region = '{{ region }}';

DELETE example​

Deletes the specified region_instance_group_managers resource.

/*+ delete */
DELETE FROM google.compute.region_instance_group_managers
WHERE instanceGroupManager = '{{ instanceGroupManager }}'
AND project = '{{ project }}'
AND region = '{{ region }}';