REST Resource: regionInstanceGroupManagers

Resource: InstanceGroupManager

An Instance Group Manager resource.

JSON representation
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "zone": string,
  "region": string,
  "instanceTemplate": string,
  "instanceGroup": string,
  "targetPools": [
    string
  ],
  "baseInstanceName": string,
  "fingerprint": string,
  "currentActions": {
    "none": number,
    "creating": number,
    "creatingWithoutRetries": number,
    "recreating": number,
    "deleting": number,
    "abandoning": number,
    "restarting": number,
    "refreshing": number
  },
  "targetSize": number,
  "selfLink": string,
  "namedPorts": [
    {
      "name": string,
      "port": number
    }
  ],
  "kind": string,
}
Fields
id

string (fixed64 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. Provide this property when you create the resource.

zone

string

[Output Only] The URL of the 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).

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.

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

fingerprint

string (bytes format)

[Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.

A base64-encoded string.

currentActions

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

number

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

currentActions.creating

number

[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

number

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

number

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

number

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

currentActions.abandoning

number

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

number

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

currentActions.refreshing

number

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

targetSize

number

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

namedPorts[]

object

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

number

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

kind

string

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

Methods

abandonInstances

Schedules a group action to remove the specified instances from the managed instance group.

delete

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

deleteInstances

Schedules a group action to delete the specified instances in 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.

listManagedInstances

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

patch

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

recreateInstances

Schedules a group action to recreate the specified instances in the managed instance group.

resize

Changes the intended size for the managed instance group.

setAutoHealingPolicies

Modifies the autohealing policy for the instances in this 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.

testIamPermissions

Returns permissions that a caller has on the specified resource.

update

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

Send feedback about...

Compute Engine