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 ( |
Fields | |
---|---|
kind |
[Output Only] The resource type, which is always
for managed instance groups. |
id |
[Output Only] A unique identifier for this resource type. The server generates this identifier. |
creationTimestamp |
[Output Only] The creation timestamp for this managed instance group in RFC3339 text format. |
name |
The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. |
description |
An optional description of this resource. |
zone |
[Output Only] The URL of a zone where the managed instance group is located (for zonal resources). |
region |
[Output Only] The URL of the region where the managed instance group resides (for regional resources). |
distributionPolicy |
Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. |
instanceTemplate |
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
, run
, or set the group's
to
. |
versions[] |
Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an
and a
. Every version can appear at most once per instance group. This field overrides the top-level
field. Read more about the relationships between these fields. Exactly one
must leave the
field unset. That version will be applied to all remaining instances. For more information, read about canary updates. |
allInstancesConfig |
Specifies configuration that overrides the instance template configuration for the group. |
instanceGroup |
[Output Only] The URL of the Instance Group resource. |
targetPools[] |
The URLs for all TargetPool resources to which instances in the
field are added. The target pools automatically apply to all of the instances in the managed instance group. |
baseInstanceName |
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 |
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
. To see the latest fingerprint, make a
request to retrieve an InstanceGroupManager. A base64-encoded string. |
currentActions |
[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 |
[Output Only] The status of this managed instance group. |
targetSize |
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. |
targetSizePolicy |
The policy that specifies how the MIG creates its VMs to achieve the target size. |
instanceFlexibilityPolicy |
Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration. |
targetStoppedSize |
The target number of stopped instances for this managed instance group. This number changes when you:
|
targetSuspendedSize |
The target number of suspended instances for this managed instance group. This number changes when you:
|
listManagedInstancesResults |
Pagination behavior of the
API method for this managed instance group. |
standbyPolicy |
Standby policy for stopped and suspended instances. |
selfLink |
[Output Only] The URL for this managed instance group. The server defines this URL. |
autoHealingPolicies[] |
The autohealing policy for this managed instance group. You can specify only one value. |
updatePolicy |
The update policy for this managed instance group. |
namedPorts[] |
[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. |
serviceAccount |
The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used. |
failoverAction |
The action to perform in case of zone failure. Only one value is supported,
. The default is
. |
statefulPolicy |
Stateful configuration for this Instanced Group Manager |
instanceLifecyclePolicy |
The repair policy for this managed instance group. |
params |
Input only. Additional params passed with the request, but not persisted as part of resource payload. |
satisfiesPzi |
[Output Only] Reserved for future use. |
satisfiesPzs |
[Output Only] Reserved for future use. |
resourcePolicies |
Resource policies for this managed instance group. |
multiMig |
URL to the multi-MIG that this Managed Instance Group belongs to. |
Methods |
|
---|---|
|
The method compute.beta.RegionInstanceGroupManagersService.AbandonInstances is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.ApplyUpdatesToInstances is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.CreateInstances is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.Delete is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.DeleteInstances is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.DeletePerInstanceConfigs is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.Get is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.Insert is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.List is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.ListErrors is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.ListManagedInstances is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.ListPerInstanceConfigs is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.Patch is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.PatchPerInstanceConfigs is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.RecreateInstances is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.Resize is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.ResizeAdvanced is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.ResumeInstances is not available in Trusted Cloud by S3NS. |
(deprecated) |
The method compute.beta.RegionInstanceGroupManagersService.SetAutoHealingPolicies is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.SetInstanceTemplate is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.SetTargetPools is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.StartInstances is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.StopInstances is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.SuspendInstances is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.TestPermissions is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.Update is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.RegionInstanceGroupManagersService.UpdatePerInstanceConfigs is not available in Trusted Cloud by S3NS. |