Method: httpsHealthChecks.get

Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request.

HTTP request

GET https://www.googleapis.com/compute/beta/projects/{project}/global/httpsHealthChecks/{resourceId}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
project

string

Project ID for this request.

resourceId

string

Name of the HttpsHealthCheck resource to return.

Request body

The request body must be empty.

Response body

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

An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.

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

string (fixed64 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 HTTPS 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 HTTPS health check request. The default value is "/".

port

number

The TCP port number for the HTTPS health check request. The default value is 443.

checkIntervalSec

number

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

timeoutSec

number

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

unhealthyThreshold

number

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

healthyThreshold

number

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

kind

string

Type of the resource.

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.httpsHealthChecks.get
Was this page helpful? Let us know how we did:

Send feedback about...

Compute Engine