REST Resource: instanceGroups

• Resource: InstanceGroup
  • JSON representation
• Methods

Resource: InstanceGroup

InstanceGroups

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

Fields
id	string (fixed64 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 in RFC3339 text format.
name	string The name of the 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.
namedPorts[]	object 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: "http", port: 80},{name: "http", port: 8080}] 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 with RFC1035.
namedPorts[].port	number The port number, which can be a value between 1 and 65535.
network	string The URL of the network to which all instances in the instance group belong.
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 the zone 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	number [Output Only] The total number of instances in the instance group.
region	string [Output Only] The URL of the region 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.
kind	string [Output Only] The resource type, which is always compute#instanceGroup for instance groups.

Methods
addInstances	Adds a list of instances to the specified instance group.
aggregatedList	Retrieves the list of instance groups and sorts them by zone.
delete	Deletes the specified instance group.
get	Returns the specified instance group.
insert	Creates an instance group in the specified project using the parameters that are included in the request.
list	Retrieves the list of instance groups that are located in the specified project and zone.
listInstances	Lists the instances in the specified instance group.
removeInstances	Removes one or more instances from the specified instance group, but does not delete those instances.
setNamedPorts	Sets the named ports for the specified instance group.
testIamPermissions	Returns permissions that a caller has on the specified resource.