GOgoogle
instanceGroupManagers

GET /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}

Changed on

Returns all of the details about the specified managed instance group.

Request

  • Base URL
    https://compute.googleapis.com/compute/v1
  • URL
    https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/cloud-platform
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/compute
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/compute
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/compute.readonly
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/compute.readonly

Path parameters

projectstring required

Project ID for this request.

zonestring required

The name of thezone where the managed instance group is located.

instanceGroupManagerstring required

The name of the managed instance group.

Response

Successful response

baseInstanceNamestring

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

creationTimestampstring

Output only. The creation timestamp for this managed instance group inRFC3339 text format.

descriptionstring

An optional description of this resource.

fingerprintstring byte

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

To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

idstring uint64

Output only. A unique identifier for this resource type. The server generates this identifier.

instanceGroupstring

Output only. The URL of the Instance Group resource.

instanceTemplatestring

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 recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE.

kindstring

Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups.

listManagedInstancesResults'PAGELESS' | 'PAGINATED'

Pagination behavior of the listManagedInstances API method for this managed instance group.

namestring

The name of the managed instance group. The name must be 1-63 characters long, and comply withRFC1035.

regionstring

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

targetPoolsstring[]

The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

targetSizeinteger

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.

targetStoppedSizeinteger

The target number of stopped instances for this managed instance group. This number changes when you:

  • Stop instance using the stopInstances method or start instances using the startInstances method.
  • Manually change the targetStoppedSize using the update method.
targetSuspendedSizeinteger

The target number of suspended instances for this managed instance group. This number changes when you:

  • Suspend instance using the suspendInstances method or resume instances using the resumeInstances method.
  • Manually change the targetSuspendedSize using the update method.
zonestring

Output only. The URL of azone where the managed instance group is located (for zonal resources).

Changes

  • 8b85e897d3dcRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2c

  • 48929bf89eebRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2c