Method: regionBackendServices.getHealth

• HTTP request
• Path parameters
• Request body
  • JSON representation
• Response body
  • JSON representation
• Authorization Scopes
• IAM Permissions

Gets the most recent health check results for this regional BackendService.

HTTP request

POST https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/backendServices/{resourceId}/getHealth

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project	string
region	string Name of the region scoping this request.
resourceId	string Name of the BackendService resource for which to get health.

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": number, "instance": string, "healthState": enum } ], "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 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 Authentication Overview.

IAM Permissions

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

• compute.regionBackendServices.get

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.