BackendServices: getHealth

Requires authorization

Gets the most recent health check results for this BackendService.

Request

HTTP request

POST https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService/getHealth

Parameters

Parameter name Value Description
Path parameters
backendService string Name of the Backend Service resource to which the specified instance belongs.
project string The project ID for this request.

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:

{
  "group": string
}
Property name Value Description Notes
group string A URI referencing one of the instance groups listed in the backend service.

Response

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

{
  "kind": "compute#backendServiceGroupHealth",
  "healthStatus": [
    {
      "ipAddress": string,
      "port": integer,
      "instance": string,
      "healthState": string
    }
  ]
}
Property name Value Description Notes
kind string [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.
healthStatus[] list A list of health checks and their corresponding status for this backend service.
healthStatus[].ipAddress string The IP address represented by this resource.
healthStatus[].instance string URL of the instance resource.
healthStatus[].healthState string Health state of the instance.
healthStatus[].port integer The port on the instance.

Send feedback about...

Compute Engine