REST Resource: regionInstanceGroups

Resource: InstanceGroup

Represents an Instance Group resource.

Instance Groups can be used to configure a target forload balancing.

Instance groups can either be managed or unmanaged.

To create managed instance groups, use theinstanceGroupManager orregionInstanceGroupManager resource instead.

Use zonal unmanaged instance groups if you need to applyload balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups.

For more information, readInstance groups.

JSON representation
{"kind":string,"id":string,"creationTimestamp":string,"name":string,"description":string,"namedPorts":[{"name":string,"port":integer}],"network":string,"fingerprint":string,"zone":string,"selfLink":string,"size":integer,"region":string,"subnetwork":string}
Fields
kind

string

[Output Only] The resource type, which is alwayscompute#instanceGroup for instance groups.

id

string (uint64 format)

[Output Only] A unique identifier for this instance group, generated by the server.

creationTimestamp

string

[Output Only] The creation timestamp for this instance group inRFC3339 text format.

name

string

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

description

string

An optional description of this resource. Provide this property when you create the resource.

namedPorts[]

object

Optional. Assigns a name to a port number. For example:{name: "http", port: 80}

This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example:[{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}]

Named ports apply to all instances in this instance group.

namedPorts[].name

string

The name for this named port. The name must be 1-63 characters long, and comply withRFC1035.

namedPorts[].port

integer

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

network

string

[Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).

fingerprint

string (bytes format)

[Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.

A base64-encoded string.

zone

string

[Output Only] The URL of thezone where the instance group is located (for zonal resources).

selfLink

string

[Output Only] The URL for this instance group. The server generates this URL.

size

integer

[Output Only] The total number of instances in the instance group.

region

string

[Output Only] The URL of theregion where the instance group is located (for regional resources).

subnetwork

string

[Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).

Methods

get

 Returns the specified instance group resource.

list

 Retrieves the list of instance group resources contained within the specified region.

listInstances

 Lists the instances in the specified instance group and displays information about the named ports.

setNamedPorts

 Sets the named ports for the specified regional instance group.

testIamPermissions

 Returns permissions that a caller has on the specified resource.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-09-18 UTC.