Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)



TargetPools: getHealth

Requires authorization

Gets the most recent health check results for each IP for the given instance that is referenced by given TargetPool. Try it now .

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

Request body

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

{
  "instance": string
}
Property name Value Description Notes
instance string URL of the instance whose health statues is queried. For example:
http://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance

Response

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

{
  "kind": "compute#targetPoolInstanceHealth",
  "healthStatus": [
    {
      "ipAddress": string,
      "instance": string,
      "healthState": string
    }
  ]
}
Property name Value Description Notes
kind string [Output Only] Type of resource. Always compute#targetPoolInstanceHealth .
healthStatus[] list [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.

Acceptable values are:
  • " HEALTHY ":
  • " UNHEALTHY ":

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.