Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list()
request.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{resourceId}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
zone |
The name of the zone where the managed instance group is located. |
resourceId |
The name of the managed instance group. Authorization requires the following IAM permission on the specified resource
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation | |
---|---|
{ "id": string, "creationTimestamp": string, "name": string, "description": string, "zone": string, "region": string, "distributionPolicy": { "zones": [ { "zone": string } ], "targetShape": enum }, "instanceTemplate": string, "versions": [ { "name": string, "instanceTemplate": string, "targetSize": { "fixed": integer, "percent": integer, "calculated": integer } } ], "instanceGroup": string, "targetPools": [ string ], "baseInstanceName": string, "fingerprint": string, "currentActions": { "none": integer, "creating": integer, "creatingWithoutRetries": integer, "verifying": integer, "recreating": integer, "deleting": integer, "abandoning": integer, "restarting": integer, "refreshing": integer }, "status": { "isStable": boolean, "versionTarget": { "isReached": boolean }, "stateful": { "hasStatefulConfig": boolean, "perInstanceConfigs": { "allEffective": boolean } }, "autoscaler": string }, "targetSize": integer, "selfLink": string, "autoHealingPolicies": [ { "healthCheck": string, "initialDelaySec": integer } ], "updatePolicy": { "type": enum, "instanceRedistributionType": enum, "minimalAction": enum, "maxSurge": { "fixed": integer, "percent": integer, "calculated": integer }, "maxUnavailable": { "fixed": integer, "percent": integer, "calculated": integer }, "replacementMethod": enum }, "namedPorts": [ { "name": string, "port": integer } ], "statefulPolicy": { "preservedState": { "disks": { string: { "autoDelete": enum }, ... } } }, "kind": string } |
Fields | |
---|---|
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. Provide this property when you create the 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. |
distributionPolicy.zones[] |
Zones where the regional managed instance group will create and manage its instances. |
distributionPolicy.zones[].zone |
The URL of the zone. The zone must exist in the region where the managed instance group is located. |
distributionPolicy.targetShape |
The distribution shape to which the group converges either proactively or on resize events (depending on the value set in |
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 |
versions[] |
Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an |
versions[].name |
Name of the version. Unique among all versions in the scope of this managed instance group. |
versions[].instanceTemplate |
The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the |
versions[].targetSize |
Specifies the intended number of instances to be created from the
version . Read Starting a canary update for more information.
|
versions[].targetSize.fixed |
Specifies a fixed number of VM instances. This must be a positive integer. |
versions[].targetSize.percent |
Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify |
versions[].targetSize.calculated |
[Output Only] Absolute value of VM instances calculated based on the specific mode.
|
instanceGroup |
[Output Only] The URL of the Instance Group resource. |
targetPools[] |
The URLs for all TargetPool resources to which instances in the |
baseInstanceName |
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 |
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 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. |
currentActions.none |
[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. |
currentActions.creating |
[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 |
currentActions.creatingWithoutRetries |
[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 |
currentActions.verifying |
[Output Only] The number of instances in the managed instance group that are being verified. See the |
currentActions.recreating |
[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 |
[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. |
currentActions.abandoning |
[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 |
[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. |
currentActions.refreshing |
[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. |
status |
[Output Only] The status of this managed instance group. |
status.isStable |
[Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified. |
status.versionTarget |
[Output Only] A status of consistency of Instances' versions with their target version specified by |
status.versionTarget.isReached |
[Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by |
status.stateful |
[Output Only] Stateful status of the given Instance Group Manager. |
status.stateful.hasStatefulConfig |
[Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. |
status.stateful.perInstanceConfigs |
[Output Only] Status of per-instance configs on the instance. |
status.stateful.perInstanceConfigs.allEffective |
A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status |
status.autoscaler |
[Output Only] The URL of the Autoscaler that targets this instance group manager. |
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. |
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. |
autoHealingPolicies[].healthCheck |
The URL for the health check that signals autohealing. |
autoHealingPolicies[].initialDelaySec |
The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600]. |
updatePolicy |
The update policy for this managed instance group. |
updatePolicy.type |
The type of update process. You can specify either |
updatePolicy.instanceRedistributionType |
The instance redistribution policy for regional managed instance groups. Valid values are:
|
updatePolicy.minimalAction |
Minimal action to be taken on an instance. You can specify either |
updatePolicy.maxSurge |
The maximum number of instances that can be created above the specified At least one of either |
updatePolicy.maxSurge.fixed |
Specifies a fixed number of VM instances. This must be a positive integer. |
updatePolicy.maxSurge.percent |
Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify |
updatePolicy.maxSurge.calculated |
[Output Only] Absolute value of VM instances calculated based on the specific mode.
|
updatePolicy.maxUnavailable |
The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied:
This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded up if necessary. The default value for At least one of either |
updatePolicy.maxUnavailable.fixed |
Specifies a fixed number of VM instances. This must be a positive integer. |
updatePolicy.maxUnavailable.percent |
Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify |
updatePolicy.maxUnavailable.calculated |
[Output Only] Absolute value of VM instances calculated based on the specific mode.
|
updatePolicy.replacementMethod |
What action should be used to replace instances. See minimalAction.REPLACE |
namedPorts[] |
Named ports configured for the Instance Groups complementary to this Instance Group Manager. |
namedPorts[].name |
The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. |
namedPorts[].port |
The port number, which can be a value between 1 and 65535. |
statefulPolicy |
Stateful configuration for this Instanced Group Manager |
statefulPolicy.preservedState |
|
statefulPolicy.preservedState.disks[] |
Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks. An object containing a list of |
statefulPolicy.preservedState.disks[].autoDelete |
These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in |
kind |
[Output Only] The resource type, which is always |
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.