InstanceGroupManagers

For a list of methods for this resource, see the end of this page.

Resource representations

An Instance Group Manager resource.

{
  "kind": "compute#instanceGroupManager",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "zone": string,
  "region": string,
  "instanceTemplate": string,
  "instanceGroup": string,
  "targetPools": [
    string
  ],
  "baseInstanceName": string,
  "fingerprint": bytes,
  "currentActions": {
    "none": integer,
    "creating": integer,
    "creatingWithoutRetries": integer,
    "recreating": integer,
    "deleting": integer,
    "abandoning": integer,
    "restarting": integer,
    "refreshing": integer
  },
  "targetSize": integer,
  "selfLink": string,
  "namedPorts": [
    {
      "name": string,
      "port": integer
    }
  ]
}
Property name Value Description Notes
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 nested object [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.
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.
description string An optional description of this resource. Provide this property when you create the resource.
fingerprint bytes [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
id unsigned long [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[] list Named ports configured for the Instance Groups complementary to this Instance Group Manager.
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).
targetPools[] list 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.
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.
zone string [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).

Methods

abandonInstances
Schedules a group action to remove the specified instances 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.
aggregatedList
Retrieves the list of managed instance groups and groups them by zone.
delete
Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.
deleteInstances
Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.
get
Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.
insert
Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group 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.
list
Retrieves a list of managed instance groups that are contained within the specified project and zone.
listManagedInstances
Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.
recreateInstances
Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.
resize
Resizes 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 instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.
setInstanceTemplate
Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.
setTargetPools
Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.

Send feedback about...

Compute Engine