Method: regionHealthChecks.get

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

HTTP request

GET https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/healthChecks/{resourceId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

region

string

Name of the region scoping this request.

resourceId

string

Name of the HealthCheck resource to return.

Request body

The request body must be empty.

Response body

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

Represents a Health Check resource.

Google Compute Engine has two Health Check resources:

Internal HTTP(S) load balancers must use regional health checks (compute.v1.regionHealthChecks).

Traffic Director must use global health checks (compute.v1.HealthChecks).

Internal TCP/UDP load balancers can use either regional or global health checks (compute.v1.regionHealthChecks or compute.v1.HealthChecks).

External HTTP(S), TCP proxy, and SSL proxy load balancers as well as managed instance group auto-healing must use global health checks (compute.v1.HealthChecks).

Backend service-based network load balancers must use regional health checks (compute.v1.regionHealthChecks).

Target pool-based network load balancers must use legacy HTTP health checks (compute.v1.httpHealthChecks).

For more information, see Health checks overview.

JSON representation
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "checkIntervalSec": integer,
  "timeoutSec": integer,
  "unhealthyThreshold": integer,
  "healthyThreshold": integer,
  "type": enum,
  "tcpHealthCheck": {
    "port": integer,
    "portName": string,
    "portSpecification": enum,
    "request": string,
    "response": string,
    "proxyHeader": enum
  },
  "sslHealthCheck": {
    "port": integer,
    "portName": string,
    "portSpecification": enum,
    "request": string,
    "response": string,
    "proxyHeader": enum
  },
  "httpHealthCheck": {
    "port": integer,
    "portName": string,
    "portSpecification": enum,
    "host": string,
    "requestPath"