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 gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
|
resourceId |
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 |
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[] |
Health state of the backend instances or endpoints in requested instance or network endpoint group, determined based on configured health checks. |
healthStatus[].ipAddress |
The IP address represented by this resource. |
healthStatus[].port |
The port on the instance. |
healthStatus[].instance |
URL of the instance resource. |
healthStatus[].healthState |
Health state of the instance. |
kind |
[Output Only] Type of resource. Always |
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.backendServices.get