[Output Only] Type of resource. Alwayscompute#backendServiceGroupHealthfor the health of backend services.
healthStatus[]
object
Health state of the backend instances or endpoints in requested instance or network endpoint group, determined based on configured health checks.
healthStatus[].weight
string
healthStatus[].weightError
enum
healthStatus[].ipAddress
string
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
string
healthStatus[].port
integer
The named port of the instance group, not necessarily the port that is health-checked.
healthStatus[].instance
string
URL of the instance resource.
healthStatus[].healthState
enum
Health state of the IPv4 address of the instance.
healthStatus[].ipv6HealthState
enum
Health state of the IPv6 address of the instance.
healthStatus[].annotations
map (key: string, value: string)
Metadata defined as annotations for network endpoint.
healthStatus[].forwardingRuleIp
string
A forwarding rule IP address assigned to this instance.
healthStatus[].forwardingRule
string
URL of the forwarding rule associated with the health status of the instance.
annotations
map (key: string, value: string)
Metadata defined as annotations on the network endpoint group.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-28 UTC."],[[["\u003cp\u003eThis endpoint retrieves the most recent health check results for a specified regional BackendService.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003ePOST\u003c/code\u003e method with a URL that follows gRPC Transcoding syntax and includes path parameters for \u003ccode\u003eproject\u003c/code\u003e, \u003ccode\u003eregion\u003c/code\u003e, and \u003ccode\u003ebackendService\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request body expects a JSON object with a \u003ccode\u003egroup\u003c/code\u003e field, which should be a URI referencing an instance group or network endpoint group in the backend service.\u003c/p\u003e\n"],["\u003cp\u003eThe successful response will include detailed health status information, such as the \u003ccode\u003ekind\u003c/code\u003e of resource, and an array of \u003ccode\u003ehealthStatus\u003c/code\u003e objects, that provide the health states of the backend instances or endpoints.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this request requires specific OAuth scopes or IAM permissions, such as \u003ccode\u003ecompute.regionBackendServices.get\u003c/code\u003e, along with some of the following OAuth scopes \u003ccode\u003ehttps://www.googleapis.com/auth/compute.readonly\u003c/code\u003e, \u003ccode\u003ehttps://www.googleapis.com/auth/compute\u003c/code\u003e, \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: regionBackendServices.getHealth\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.BackendServiceGroupHealth.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\nGets the most recent health check results for this regional BackendService.\n\n### HTTP request\n\n`POST https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}/getHealth`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/compute.readonly`\n- `\n https://www.googleapis.com/auth/compute`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nIn addition to any permissions specified on the fields above, authorization requires one or more of the following [IAM](https://cloud.google.com/iam/docs/) permissions:\n\n- `compute.regionBackendServices.get`\n\nTo find predefined roles that contain those permissions, see [Compute Engine IAM Roles](/compute/docs/access/iam)."]]
