TargetPools: getHealth

Requires authorization

Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.

Request

HTTP request

POST https://www.googleapis.com/compute/v1/projects/project/regions/region/targetPools/targetPool/getHealth

Parameters

Parameter name Value Description
Path parameters
project string Project ID for this request.
region string Name of the region scoping this request.
targetPool string Name of the TargetPool resource to which the queried instance belongs.

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/compute.readonly
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform

Request body

In the request body, supply data with the following structure:

{
  "instance": string
}
Property name Value Description Notes
instance string The URL for a specific instance.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "compute#targetPoolInstanceHealth",
  "healthStatus": [
    {
      "ipAddress": string,
      "port": integer,
      "instance": string,
      "healthState": string
    }
  ]
}
Property name Value Description Notes
kind string [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.
healthStatus[] list ; style="color: rgb(34, 34, 34); background-color: rgb(255, 255, 255);">[Output Only] The list of health check statuses.
healthStatus[].ipAddress string [Output Only] The IP address represented by this resource.
healthStatus[].instance string [Output Only] URL of the instance resource.
healthStatus[].healthState string [Output Only] Health state of the instance.
healthStatus[].port integer The port on the instance.

Monitor your resources on the go

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

Send feedback about...

Compute Engine