Method: backendServices.getHealth

Gets the most recent health check results for this BackendService.

HTTP request

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

The URL uses Google API HTTP annotation 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
{
  "resourceGroup": {
    "group": string
  },
}
Fields
resourceGroup

object

URL of the group whose health status is queried.

resourceGroup.group

string

A URI referencing one of the instance 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": number,
      "instance": string,
      "healthState": enum
    }
  ],
  "kind": string,
}
Fields
healthStatus[]

object

healthStatus[].ipAddress

string

The IP address represented by this resource.

healthStatus[].port

number

The port on the instance.

healthStatus[].instance

string

URL of the instance resource.

healthStatus[].healthState

enum

Health state of the instance.

kind

string

[Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Auth Guide.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following Google IAM permissions:

  • compute.backendServices.get

Send feedback about...

Compute Engine