Method: httpHealthChecks.get

Returns the specified HttpHealthCheck resource.

HTTP request

GET https://compute.googleapis.com/compute/v1/projects/{project}/global/httpHealthChecks/{httpHealthCheck}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.
httpHealthCheck

string

Name of the HttpHealthCheck resource to return.

Request body

The request body must be empty.

Response body

Represents a legacy HTTP Health Check resource.

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.

For more information, see Health checks overview.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "host": string,
  "requestPath": string,
  "port": integer,
  "checkIntervalSec": integer,
  "timeoutSec": integer,
  "unhealthyThreshold": integer,
  "healthyThreshold": integer,
  "selfLink": string
}
Fields
kind

string

[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.
name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. 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 with RFC3986.
port

integer

The TCP port number for the HTTP health check request. The default value is 80.
checkIntervalSec

integer

How often (in seconds) to send a health check. The default value is 5 seconds.
timeoutSec

integer

How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
unhealthyThreshold

integer

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
healthyThreshold

integer

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

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.httpHealthChecks.get

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