- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
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/beta/projects/{project}/global/backendServices/{backendService}/getHealth
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
project
|
|
backendService
|
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 |
|---|
{ "kind" : string , "healthStatus" : [ { "weight" : string , "weightError" : enum , "ipAddress" : string , "ipv6Address" : string , "port" : integer , "instance" : string , "healthState" : enum , "ipv6HealthState" : enum , "annotations" : { string : string , ... } , "forwardingRuleIp" : string , "forwardingRule" : string } ] , "annotations" : { string : string , ... } } |
| Fields | |
|---|---|
kind
|
[Output Only] Type of resource. Always |
healthStatus[]
|
Health state of the backend instances or endpoints in requested instance or network endpoint group, determined based on configured health checks. |
healthStatus[].weight
|
|
healthStatus[].weightError
|
|
healthStatus[].ipAddress
|
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[].ipv6Address
|
|
healthStatus[].port
|
The named port of the instance group, not necessarily the port that is health-checked. |
healthStatus[].instance
|
URL of the instance resource. |
healthStatus[].healthState
|
Health state of the IPv4 address of the instance. |
healthStatus[].ipv6HealthState
|
Health state of the IPv6 address of the instance. |
healthStatus[].annotations
|
Metadata defined as annotations for network endpoint. |
healthStatus[].forwardingRuleIp
|
A forwarding rule IP address assigned to this instance. |
healthStatus[].forwardingRule
|
URL of the forwarding rule associated with the health status of the instance. |
annotations
|
Metadata defined as annotations on the network endpoint group. |
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/compute.readonly -
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 IAM permissions:
-
compute.backendServices.get
To find predefined roles that contain those permissions, see Compute Engine IAM Roles .
