Method: targetPools.getHealth

• HTTP request
• Path parameters
• Request body
  • JSON representation
• Response body
  • JSON representation
• Authorization Scopes
• IAM Permissions

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/{resourceId}/getHealth

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project	string Project ID for this request.
region	string Name of the region scoping this request.
resourceId	string 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	string 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
{ "healthStatus": [ { "ipAddress": string, "port": number, "instance": string, "healthState": enum } ], "kind": string }

Fields
healthStatus[]	object
healthStatus[].ipAddress	string The IP address represented by this resource.
healthStatus[].port	number The port on the instance.
healthStatus[].instance	string URL of the instance resource.
healthStatus[].healthState	enum Health state of the instance.
kind	string [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.

Authorization Scopes

Requires one of the following OAuth scopes:

• 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 Google IAM permissions:

• compute.targetPools.get