Method: backendServices.getHealth

Gets the most recent health check results for this BackendService.

Example request body:

{ "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" }

HTTP request

POST https://compute.googleapis.com/compute/v1/projects/{project}/global/backendServices/{resourceId}/getHealth

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

resourceId

string

Name of the BackendService resource to which the queried instance belongs.

Request body

The request body contains data with the following structure:

JSON representation
{
  "group": string
}
Fields
group

string

A URI referencing one of the instance groups or network endpoint groups listed in the backend service.

Response body

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

JSON representation
{
  "healthStatus": [
    {
      "ipAddress": string,
      "port": integer,
      "instance": string,
      "healthState": enum,
      "annotations": {
        string: string,
        ...
      },
      "weight": string,
      "weightError": enum,
      "forwardingRuleIp": string,
      "forwardingRule": string
    }
  ],
  "annotations": {
    string: string,
    ...
  },
  "kind": string
}
Fields
healthStatus[]

object

Health state of the backend instances or endpoints in requested instance or network endpoint group, determined based on configured health checks.

healthStatus[].ipAddress

string

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[].port