- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Returns the specified HttpsHealthCheck resource.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
httpsHealthCheck |
Name of the HttpsHealthCheck resource to return. |
Request body
The request body must be empty.
Response body
Represents a legacy HTTPS Health Check resource.
Legacy HTTPS health checks have been deprecated. If you are using a target pool-based network load balancer, you must use a legacy HTTP (not HTTPS) health check. 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 |
Type of the resource. |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
name |
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 |
description |
An optional description of this resource. Provide this property when you create the resource. |
host |
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 |
The request path of the HTTPS health check request. The default value is "/". Must comply with RFC3986. |
port |
The TCP port number for the HTTPS health check request. The default value is 443. |
checkIntervalSec |
How often (in seconds) to send a health check. The default value is 5 seconds. |
timeoutSec |
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 |
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. |
healthyThreshold |
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. |
selfLink |
[Output Only] Server-defined URL for the resource. |
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.httpsHealthChecks.get
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.