InstanceGroups
class InstanceGroups extends Resource (View source)
The "instanceGroups" collection of methods.
Typical usage is:
$computeService = new Google\Service\Compute(...);
$instanceGroups = $computeService->instanceGroups;
Methods
Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. (instanceGroups.addInstances)
Retrieves the list of instance groups and sorts them by zone. To prevent
failure, Google recommends that you set the returnPartialSuccess
parameter
to true
. (instanceGroups.aggregatedList)
Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. (instanceGroups.delete)
Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
Creates an instance group in the specified project using the parameters that are included in the request. (instanceGroups.insert)
Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
Lists the instances in the specified instance group. The orderBy query
parameter is not supported. The filter query parameter is supported, but only
for expressions that use eq
(equal) or ne
(not equal) operators.
Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.
Sets the named ports for the specified instance group.
Details
Operation
addInstances(string $project, string $zone, string $instanceGroup, InstanceGroupsAddInstancesRequest $postBody, array $optParams = [])
Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. (instanceGroups.addInstances)
InstanceGroupAggregatedList
aggregatedList(string $project, array $optParams = [])
Retrieves the list of instance groups and sorts them by zone. To prevent
failure, Google recommends that you set the returnPartialSuccess
parameter
to true
. (instanceGroups.aggregatedList)
Operation
delete(string $project, string $zone, string $instanceGroup, array $optParams = [])
Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. (instanceGroups.delete)
InstanceGroup
get(string $project, string $zone, string $instanceGroup, array $optParams = [])
Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
(instanceGroups.get)
Operation
insert(string $project, string $zone, InstanceGroup $postBody, array $optParams = [])
Creates an instance group in the specified project using the parameters that are included in the request. (instanceGroups.insert)
InstanceGroupList
listInstanceGroups(string $project, string $zone, array $optParams = [])
Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
(instanceGroups.listInstanceGroups)
InstanceGroupsListInstances
listInstances(string $project, string $zone, string $instanceGroup, InstanceGroupsListInstancesRequest $postBody, array $optParams = [])
Lists the instances in the specified instance group. The orderBy query
parameter is not supported. The filter query parameter is supported, but only
for expressions that use eq
(equal) or ne
(not equal) operators.
(instanceGroups.listInstances)
Operation
removeInstances(string $project, string $zone, string $instanceGroup, InstanceGroupsRemoveInstancesRequest $postBody, array $optParams = [])
Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.
(instanceGroups.removeInstances)
Operation
setNamedPorts(string $project, string $zone, string $instanceGroup, InstanceGroupsSetNamedPortsRequest $postBody, array $optParams = [])
Sets the named ports for the specified instance group.
(instanceGroups.setNamedPorts)