TargetPools

A TargetPool resource. This resource defines a pool of VMs, associated HttpHealthCheck resources, and the fallback TargetPool. For more information, see Target Pools.

For a list of methods for this resource, see the end of this page.

Resource representations

A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool.

{
  "kind": "compute#targetPool",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "region": string,
  "healthChecks": [
    string
  ],
  "instances": [
    string
  ],
  "sessionAffinity": string,
  "failoverRatio": float,
  "backupPool": string,
  "selfLink": string
}
Property name Value Description Notes
backupPool string This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].

backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.

In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
creationTimestamp string [Output Only] Creation timestamp in RFC3339 text format.
description string An optional description of this resource. Provide this property when you create the resource.
failoverRatio float This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].

If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.

In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
healthChecks[] list The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified.
id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server.
instances[] list A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
kind string [Output Only] Type of the resource. Always compute#targetPool for target pools.
name string Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
region string [Output Only] URL of the region where the target pool resides.
sessionAffinity string Sesssion affinity option, must be one of the following values:
NONE: Connections from the same client IP may go to any instance in the pool.
CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.

Methods

The following are valid TargetPool resource methods:

addHealthCheck
Adds health check URLs to a target pool.
addInstance
Adds an instance to a target pool.
aggregatedList
Retrieves an aggregated list of target pools.
delete
Deletes the specified target pool.
get
Returns the specified target pool. Get a list of available target pools by making a list() request.
getHealth
Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.
insert
Creates a target pool in the specified project and region using the data included in the request.
list
Retrieves a list of target pools available to the specified project and region.
removeHealthCheck
Removes health check URL from a target pool.
removeInstance
Removes instance URL from a target pool.
setBackup
Changes a backup target pool's configurations.
testIamPermissions
Returns permissions that a caller has on the specified resource.

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

Compute Engine