- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Retrieves the list of HealthCheck resources available to the specified project.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/healthChecks
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
region |
Name of the region scoping this request. |
Query parameters
Parameters | |
---|---|
maxResults |
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken |
Specifies a page token to use. Set |
filter |
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either For example, if you are filtering Compute Engine instances, you can exclude instances named The
You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example:
By default, each expression is an
If you want to use a regular expression, use the
The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use You cannot combine constraints on multiple fields using regular expressions. |
orderBy |
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using Currently, only sorting by |
returnPartialSuccess |
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. |
Request body
The request body must be empty.
Response body
Contains a list of HealthCheck resources.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind": string, "id": string, "items": [ { "kind": string, "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": string, "proxyHeader": enum, "response": string }, "httpsHealthCheck": { "port": integer, "portName": string, "portSpecification": enum, "host": string, "requestPath": string, "proxyHeader": enum, "response": string }, "http2HealthCheck": { "port": integer, "portName": string, "portSpecification": enum, "host": string, "requestPath": string, "proxyHeader": enum, "response": string }, "grpcHealthCheck": { "port": integer, "portName": string, "portSpecification": enum, "grpcServiceName": string }, "sourceRegions": [ string ], "selfLink": string, "region": string, "logConfig": { "enable": boolean } } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } } |
Fields | |
---|---|
kind |
Type of resource. |
id |
[Output Only] Unique identifier for the resource; defined by the server. |
items[] |
A list of HealthCheck resources. |
items[].kind |
Type of the resource. |
items[].id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items[].creationTimestamp |
[Output Only] Creation timestamp in 3339 text format. |
items[].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. For example, a name that is 1-63 characters long, matches the regular expression |
items[].description |
An optional description of this resource. Provide this property when you create the resource. |
items[].checkIntervalSec |
How often (in seconds) to send a health check. The default value is 5 seconds. |
items[].timeoutSec |
How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for |
items[].unhealthyThreshold |
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. |
items[].healthyThreshold |
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. |
items[].type |
Specifies the type of the healthCheck, either |
items[].tcpHealthCheck |
|
items[].tcpHealthCheck.port |
The TCP port number to which the health check prober sends packets. The default value is |
items[].tcpHealthCheck.portName |
Not supported. |
items[].tcpHealthCheck.portSpecification |
Specifies how a port is selected for health checking. Can be one of the following values: |
items[].tcpHealthCheck.request |
Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection. |
items[].tcpHealthCheck.response |
Creates a content-based TCP health check. In addition to establishing a TCP connection, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp |
items[].tcpHealthCheck.proxyHeader |
Specifies the type of proxy header to append before sending data to the backend, either |
items[].sslHealthCheck |
|
items[].sslHealthCheck.port |
The TCP port number to which the health check prober sends packets. The default value is |
items[].sslHealthCheck.portName |
Not supported. |
items[].sslHealthCheck.portSpecification |
Specifies how a port is selected for health checking. Can be one of the following values: |
items[].sslHealthCheck.request |
Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection and SSL handshake. |
items[].sslHealthCheck.response |
Creates a content-based SSL health check. In addition to establishing a TCP connection and the TLS handshake, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp |
items[].sslHealthCheck.proxyHeader |
Specifies the type of proxy header to append before sending data to the backend, either |
items[].httpHealthCheck |
|
items[].httpHealthCheck.port |
The TCP port number to which the health check prober sends packets. The default value is |
items[].httpHealthCheck.portName |
Not supported. |
items[].httpHealthCheck.portSpecification |
Specifies how a port is selected for health checking. Can be one of the following values: |
items[].httpHealthCheck.host |
The value of the host header in the HTTP health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest |
items[].httpHealthCheck.requestPath |
The request path of the HTTP health check request. The default value is |
items[].httpHealthCheck.proxyHeader |
Specifies the type of proxy header to append before sending data to the backend, either |
items[].httpHealthCheck.response |
Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http |
items[].httpsHealthCheck |
|
items[].httpsHealthCheck.port |
The TCP port number to which the health check prober sends packets. The default value is |
items[].httpsHealthCheck.portName |
Not supported. |
items[].httpsHealthCheck.portSpecification |
Specifies how a port is selected for health checking. Can be one of the following values: |
items[].httpsHealthCheck.host |
The value of the host header in the HTTPS health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest |
items[].httpsHealthCheck.requestPath |
The request path of the HTTPS health check request. The default value is |
items[].httpsHealthCheck.proxyHeader |
Specifies the type of proxy header to append before sending data to the backend, either |
items[].httpsHealthCheck.response |
Creates a content-based HTTPS health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http |
items[].http2HealthCheck |
|
items[].http2HealthCheck.port |
The TCP port number to which the health check prober sends packets. The default value is |
items[].http2HealthCheck.portName |
Not supported. |
items[].http2HealthCheck.portSpecification |
Specifies how a port is selected for health checking. Can be one of the following values: |
items[].http2HealthCheck.host |
The value of the host header in the HTTP/2 health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest |
items[].http2HealthCheck.requestPath |
The request path of the HTTP/2 health check request. The default value is |
items[].http2HealthCheck.proxyHeader |
Specifies the type of proxy header to append before sending data to the backend, either |
items[].http2HealthCheck.response |
Creates a content-based HTTP/2 health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http |
items[].grpcHealthCheck |
|
items[].grpcHealthCheck.port |
The TCP port number to which the health check prober sends packets. Valid values are |
items[].grpcHealthCheck.portName |
Not supported. |
items[].grpcHealthCheck.portSpecification |
Specifies how a port is selected for health checking. Can be one of the following values: |
items[].grpcHealthCheck.grpcServiceName |
The gRPC service name for the health check. This field is optional. The value of grpcServiceName has the following meanings by convention: |
items[].sourceRegions[] |
The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of Google Cloud regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check:
|
items[].selfLink |
[Output Only] Server-defined URL for the resource. |
items[].region |
[Output Only] Region where the health check resides. Not applicable to global health checks. |
items[].logConfig |
Configure logging on this health check. |
items[].logConfig.enable |
Indicates whether or not to export logs. This is false by default, which means no health check logging will be done. |
nextPageToken |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
selfLink |
[Output Only] Server-defined URL for this resource. |
warning |
[Output Only] Informational warning message. |
warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning.message |
[Output Only] A human-readable description of the warning code. |
warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning.data[].key |
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be |
warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
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.