Legacy HTTP health checks are now only required by target pool-based network load balancers. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks.
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression[a-z]([-a-z0-9]*[a-z0-9])?which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
description
string
An optional description of this resource. Provide this property when you create the resource.
host
string
The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
requestPath
string
The request path of the HTTP health check request. The default value is/. This field does not support query parameters. Must comply withRFC3986.
port
integer
The TCP port number for the HTTP health check request. The default value is80.
checkIntervalSec
integer
How often (in seconds) to send a health check. The default value is5seconds.
timeoutSec
integer
How long (in seconds) to wait before claiming failure. The default value is5seconds. It is invalid fortimeoutSecto have greater value thancheckIntervalSec.
unhealthyThreshold
integer
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is2.
healthyThreshold
integer
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is2.
selfLink
string
[Output Only] Server-defined URL for the resource.
[[["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 page details how to retrieve a specific HttpHealthCheck resource using a GET request, targeting a specified project and health check name.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request URL follows gRPC Transcoding syntax and requires a project ID and the name of the HttpHealthCheck resource as path parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty for this GET operation, and the response body will include the HttpHealthCheck resource data, represented in JSON format.\u003c/p\u003e\n"],["\u003cp\u003eLegacy HTTP health checks are only for target pool-based network load balancers, and modern health checks should be used for all other types of load balancers.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires specific OAuth scopes or IAM permissions, including \u003ccode\u003ecompute.httpHealthChecks.get\u003c/code\u003e, and various OAuth scopes like \u003ccode\u003ehttps://www.googleapis.com/auth/compute.readonly\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: httpHealthChecks.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.HttpHealthCheck.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\nReturns the specified HttpHealthCheck resource.\n\n### HTTP request\n\n`GET https://compute.googleapis.com/compute/v1/projects/{project}/global/httpHealthChecks/{httpHealthCheck}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nRepresents a legacy HTTP Health Check resource.\n\nLegacy HTTP health checks are now only required by target pool-based network load balancers. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks.\n\nFor more information, see [Health checks overview](/load-balancing/docs/health-check-concepts).\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.httpHealthChecks.get`\n\nTo find predefined roles that contain those permissions, see [Compute Engine IAM Roles](/compute/docs/access/iam)."]]
