- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.
HTTP request
POST https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
region |
Name of the region scoping this request. |
targetPool |
Name of the TargetPool resource to which the queried instance belongs. |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "instance": string } |
Fields | |
---|---|
instance |
The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances |
Response body
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind": string, "healthStatus": [ { "ipAddress": string, "ipv6Address": string, "port": integer, "instance": string, "healthState": enum, "ipv6HealthState": enum, "annotations": { string: string, ... }, "weight": string, "weightError": enum, "forwardingRuleIp": string, "forwardingRule": string } ] } |
Fields | |
---|---|
kind |
[Output Only] Type of resource. Always |
healthStatus[] |
|
healthStatus[].ipAddress |
For target pool based Network Load Balancing, it indicates the forwarding rule's IP address assigned to this instance. For other types of load balancing, the field indicates VM internal ip. |
healthStatus[].ipv6Address |
|
healthStatus[].port |
The named port of the instance group, not necessarily the port that is health-checked. |
healthStatus[].instance |
URL of the instance resource. |
healthStatus[].healthState |
Health state of the IPv4 address of the instance. |
healthStatus[].ipv6HealthState |
Health state of the IPv6 address of the instance. |
healthStatus[].annotations |
Metadata defined as annotations for network endpoint. |
healthStatus[].weight |
|
healthStatus[].weightError |
|
healthStatus[].forwardingRuleIp |
A forwarding rule IP address assigned to this instance. |
healthStatus[].forwardingRule |
URL of the forwarding rule associated with the health status of the instance. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute.readonly
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
compute.targetPools.get
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.