Method: targetPools.getHealth

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.s3nsapis.fr/compute/v1/projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth

The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog

Path parameters

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.

Request body

The request body contains an instance of InstanceReference.

Response body

If successful, the response body contains data with the following structure:

JSON representation 
{
  "kind": string,
  "healthStatus": [
    {
      object (HealthStatus)
    }
  ]
}
Fields
kind

string

[Output Only] Type of resource. Always

compute#targetPoolInstanceHealth

when checking the health of an instance.
healthStatus[]

object (HealthStatus)

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.