- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/aggregated/healthChecks
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Name of the project 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. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either For example, if you are filtering Compute Engine instances, you can exclude instances named You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example, |
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 |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation | |
---|---|
{ "id": string, "items": [ { "scopeName": string, "healthChecks": [ { "id": string, "creationTimestamp": string, "name": string, "description": string, "checkIntervalSec": number, "timeoutSec": number, "unhealthyThreshold": number, "healthyThreshold": number, "type": enum, "tcpHealthCheck": { "port": number, "portName": string, "portSpecification": enum, "request": string, "response": string, "proxyHeader": enum }, "sslHealthCheck": { "port": number, "portName": string, "portSpecification": enum, "request": string, "response": string, "proxyHeader": enum }, "httpHealthCheck": { "port": number, "portName": string, "portSpecification": enum, "host": string, "requestPath": string, "proxyHeader": enum, "response": string }, "httpsHealthCheck": { "port": number, "portName": string, "portSpecification": enum, "host": string, "requestPath": string, "proxyHeader": enum, "response": string }, "http2HealthCheck": { "port": number, "portName": string, "portSpecification": enum, "host": string, "requestPath": string, "proxyHeader": enum, "response": string }, "selfLink": string, "region": string, "kind": string } ], "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] }, "kind": string } |
Fields | |
---|---|
id |
[Output Only] Unique identifier for the resource; defined by the server. |
items[] |
A list of HealthChecksScopedList resources. |
items[].scopeName |
Name of the scope containing this set of HealthChecks. |
items[].healthChecks[] |
A list of HealthChecks contained in this scope. |
items[].healthChecks[].id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items[].healthChecks[].creationTimestamp |
[Output Only] Creation timestamp in 3339 text format. |
items[].healthChecks[].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 |
items[].healthChecks[].description |
An optional description of this resource. Provide this property when you create the resource. |
items[].healthChecks[].checkIntervalSec |
How often (in seconds) to send a health check. The default value is 5 seconds. |
items[].healthChecks[].timeoutSec |
How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for |
items[].healthChecks[].unhealthyThreshold |
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. |
items[].healthChecks[].healthyThreshold |
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. |
items[].healthChecks[].type |
Specifies the type of the healthCheck, either |
items[].healthChecks[].tcpHealthCheck |
|
items[].healthChecks[].tcpHealthCheck.port |
The TCP port number for the health check request. The default value is |
items[].healthChecks[].tcpHealthCheck.portName |
Port name as defined in |
items[].healthChecks[].tcpHealthCheck.portSpecification |
Specifies how port is selected for health checking, can be one of following values: portis used for health checking. USE_NAMED_PORT : The portNameis used for health checking. USE_SERVING_PORT : For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, TCP health check follows behavior specified in portand portNamefields. |
items[].healthChecks[].tcpHealthCheck.request |
The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. |
items[].healthChecks[].tcpHealthCheck.response |
The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. |
items[].healthChecks[].tcpHealthCheck.proxyHeader |
Specifies the type of proxy header to append before sending data to the backend, either |
items[].healthChecks[].sslHealthCheck |
|
items[].healthChecks[].sslHealthCheck.port |
The TCP port number for the health check request. The default value is |
items[].healthChecks[].sslHealthCheck.portName |
Port name as defined in |
items[].healthChecks[].sslHealthCheck.portSpecification |
Specifies how port is selected for health checking, can be one of following values: portis used for health checking. USE_NAMED_PORT : The portNameis used for health checking. USE_SERVING_PORT : For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, SSL health check follows behavior specified in portand portNamefields. |
items[].healthChecks[].sslHealthCheck.request |
The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. |
items[].healthChecks[].sslHealthCheck.response |
The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. |
items[].healthChecks[].sslHealthCheck.proxyHeader |
Specifies the type of proxy header to append before sending data to the backend, either |
items[].healthChecks[].httpHealthCheck |
|
items[].healthChecks[].httpHealthCheck.port |
The TCP port number for the health check request. The default value is |
items[].healthChecks[].httpHealthCheck.portName |
Port name as defined in |
items[].healthChecks[].httpHealthCheck.portSpecification |
Specifies how port is selected for health checking, can be one of following values: portis used for health checking. USE_NAMED_PORT : The portNameis used for health checking. USE_SERVING_PORT : For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP health check follows behavior specified in portand portNamefields. |
items[].healthChecks[].httpHealthCheck.host |
The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. |
items[].healthChecks[].httpHealthCheck.requestPath |
The request path of the HTTP health check request. The default value is |
items[].healthChecks[].httpHealthCheck.proxyHeader |
Specifies the type of proxy header to append before sending data to the backend, either |
items[].healthChecks[].httpHealthCheck.response |
The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. |
items[].healthChecks[].httpsHealthCheck |
|
items[].healthChecks[].httpsHealthCheck.port |
The TCP port number for the health check request. The default value is |
items[].healthChecks[].httpsHealthCheck.portName |
Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence. |
items[].healthChecks[].httpsHealthCheck.portSpecification |
Specifies how port is selected for health checking, can be one of following values: portis used for health checking. USE_NAMED_PORT : The portNameis used for health checking. USE_SERVING_PORT : For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTPS health check follows behavior specified in portand portNamefields. |
items[].healthChecks[].httpsHealthCheck.host |
The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. |
items[].healthChecks[].httpsHealthCheck.requestPath |
The request path of the HTTPS health check request. The default value is |
items[].healthChecks[].httpsHealthCheck.proxyHeader |
Specifies the type of proxy header to append before sending data to the backend, either |
items[].healthChecks[].httpsHealthCheck.response |
The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. |
items[].healthChecks[].http2HealthCheck |
|
items[].healthChecks[].http2HealthCheck.port |
The TCP port number for the health check request. The default value is |
items[].healthChecks[].http2HealthCheck.portName |
Port name as defined in |
items[].healthChecks[].http2HealthCheck.portSpecification |
Specifies how port is selected for health checking, can be one of following values: portis used for health checking. USE_NAMED_PORT : The portNameis used for health checking. USE_SERVING_PORT : For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in portand portNamefields. |
items[].healthChecks[].http2HealthCheck.host |
The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. |
items[].healthChecks[].http2HealthCheck.requestPath |
The request path of the HTTP/2 health check request. The default value is |
items[].healthChecks[].http2HealthCheck.proxyHeader |
Specifies the type of proxy header to append before sending data to the backend, either |
items[].healthChecks[].http2HealthCheck.response |
The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. |
items[].healthChecks[].selfLink |
[Output Only] Server-defined URL for the resource. |
items[].healthChecks[].region |
[Output Only] Region where the health check resides. Not applicable to global health checks. |
items[].healthChecks[].kind |
Type of the resource. |
items[].warning |
Informational warning which replaces the list of backend services when the list is empty. |
items[].warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
items[].warning.message |
[Output Only] A human-readable description of the warning code. |
items[].warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
items[].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 |
items[].warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
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. |
kind |
Type of 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.healthChecks.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.