Resource: TargetPool
Represents a Target Pool resource.
Target pools are used with external passthrough Network Load Balancers. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools .
JSON representation |
---|
{ "kind" : string , "id" : string , "creationTimestamp" : string , "name" : string , "description" : string , "region" : string , "healthChecks" : [ string ] , "instances" : [ string ] , "sessionAffinity" : enum , "failoverRatio" : number , "backupPool" : string , "selfLink" : string , "securityPolicy" : string } |
Fields | |
---|---|
kind
|
[Output Only] Type of the resource. Always |
id
|
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp
|
[Output Only] Creation timestamp in RFC3339 text format. |
name
|
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 |
description
|
An optional description of this resource. Provide this property when you create the resource. |
region
|
[Output Only] URL of the region where the target pool resides. |
healthChecks[]
|
The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified. |
instances[]
|
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. |
sessionAffinity
|
Session affinity option, must be one of the following values: |
failoverRatio
|
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, In case where |
backupPool
|
The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its In case where |
selfLink
|
[Output Only] Server-defined URL for the resource. |
securityPolicy
|
[Output Only] The resource URL for the security policy associated with this target pool. |
Methods |
|
---|---|
|
Adds health check URLs to a target pool. |
|
Adds an instance to a target pool. |
|
Retrieves an aggregated list of target pools. |
|
Deletes the specified target pool. |
|
Returns the specified target pool. |
|
Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. |
|
Creates a target pool in the specified project and region using the data included in the request. |
|
Retrieves a list of target pools available to the specified project and region. |
|
Removes health check URL from a target pool. |
|
Removes instance URL from a target pool. |
|
Changes a backup target pool's configurations. |
|
Sets the Google Cloud Armor security policy for the specified target pool. |