Method: regionHealthCheckServices.list

Lists all theHealthCheckService resources that have been configured for the specified project in the given region.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/healthCheckServices

The URL usesgRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to theservice error catalog

Path parameters

Parameters
project

string

Project ID for this request.

region

string

Name of the region scoping this request.

Query parameters

Parameters
maxResults

integer (uint32 format)

The maximum number of results per page that should be returned. If the number of available results is larger thanmaxResults, Compute Engine returns anextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are0 to500, inclusive. (Default:500)

pageToken

string

Specifies a page token to use. SetpageToken to thenextPageToken returned by a previous list request to get the next page of results.

filter

string

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 proposalAIP-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=,!=,>,<,<=,>= or:.

For example, if you are filtering Compute Engine instances, you can exclude instances namedexample-instance by specifyingname != example-instance.

The:* comparison can be used to test whether a key has been defined. For example, to find all objects withowner label use:

labels.owner:*

You can also filter nested fields. For example, you could specifyscheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based onresource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example:

(scheduling.automaticRestart = true)(cpuPlatform = "Intel Skylake")

By default, each expression is anAND expression. However, you can includeAND andOR expressions explicitly. For example:

(cpuPlatform = "Intel Skylake") OR(cpuPlatform = "Intel Broadwell") AND(scheduling.automaticRestart = true)

If you want to use a regular expression, use theeq (equal) orne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:

fieldname eq unquoted literalfieldname eq 'single quoted literal'fieldname eq "double quoted literal"(fieldname1 eq literal) (fieldname2 ne "literal")

The literal value is interpreted as a regular expression using GoogleRE2 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 usename ne .*instance.

You cannot combine constraints on multiple fields using regular expressions.

orderBy

string

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 usingorderBy="creationTimestamp desc". This sorts results based on thecreationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting byname orcreationTimestamp desc is supported.

returnPartialSuccess

boolean

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

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

JSON representation
{"kind":string,"id":string,"items":[{"kind":string,"id":string,"creationTimestamp":string,"selfLink":string,"name":string,"description":string,"region":string,"healthStatusAggregationStrategy":enum,"healthStatusAggregationPolicy":enum,"healthChecks":[string],"networkEndpointGroups":[string],"notificationEndpoints":[string],"fingerprint":string}],"nextPageToken":string,"selfLink":string,"warning":{"code":enum,"message":string,"data":[{"key":string,"value":string}]}}
Fields
kind

string

[Output Only] Type of the resource. Alwayscompute#healthCheckServicesList for lists of HealthCheckServices.

id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object

A list ofHealthCheckService resources.

items[].kind

string

[Output only] Type of the resource. Alwayscompute#healthCheckServicefor health check services.

items[].id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items[].creationTimestamp

string

[Output Only] Creation timestamp inRFC3339 text format.

items[].selfLink

string

[Output Only] Server-defined URL for the resource.

items[].name

string

Name of the resource. The name must be 1-63 characters long, and comply withRFC1035. 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.

items[].description

string

An optional description of this resource. Provide this property when you create the resource.

items[].region

string

[Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

items[].healthStatusAggregationStrategy
(deprecated)

enum

This field is deprecated. Use healthStatusAggregationPolicy instead.

Policy for how the results from multiple health checks for the same endpoint are aggregated.

  • NO_AGGREGATION. AnEndpointHealth message is returned for each backend in the health check service.
  • AND. If any backend's health check reportsUNHEALTHY, thenUNHEALTHY is theHealthState of the entire health check service. If all backend's are healthy, theHealthState of the health check service isHEALTHY.
.

items[].healthStatusAggregationPolicy

enum

Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified.

  • NO_AGGREGATION. AnEndpointHealth message is returned for each <endpoint, health check> pair in the health check service.
  • AND. If any health check of an endpoint reportsUNHEALTHY, thenUNHEALTHY is theHealthState of the endpoint. If all health checks reportHEALTHY, theHealthState of the endpoint isHEALTHY.
. This is only allowed with regionalHealthCheckService.

items[].healthChecks[]

string

A list of URLs to theHealthCheck resources. Must have at least oneHealthCheck, and not more than 10 for regionalHealthCheckService, and not more than 1 for globalHealthCheckService.HealthCheck resources must haveportSpecification=USE_SERVING_PORT orportSpecification=USE_FIXED_PORT. For regionalHealthCheckService, theHealthCheck must be regional and in the same region. For globalHealthCheckService,HealthCheck must be global. Mix of regional and globalHealthChecks is not supported. Multiple regionalHealthChecks must belong to the same region. RegionalHealthChecks must belong to the same region as zones ofNetworkEndpointGroups. For globalHealthCheckService using globalINTERNET_IP_PORTNetworkEndpointGroups, the globalHealthChecks must specifysourceRegions, andHealthChecks that specifysourceRegions can only be used with globalINTERNET_IP_PORTNetworkEndpointGroups.

items[].networkEndpointGroups[]

string

A list of URLs to theNetworkEndpointGroup resources. Must not have more than 100. For regionalHealthCheckService,NEGs must be in zones in the region of theHealthCheckService. For globalHealthCheckServices, theNetworkEndpointGroups must be globalINTERNET_IP_PORT.

items[].notificationEndpoints[]

string

A list of URLs to theNotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regionalHealthCheckService,NotificationEndpoint must be regional and in the same region. For globalHealthCheckService,NotificationEndpoint must be global.

items[].fingerprint

string (bytes format)

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting aHealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error412 conditionNotMet. To see the latest fingerprint, make aget() request to retrieve the HealthCheckService.

A base64-encoded string.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, use thenextPageToken as a value for the query parameterpageToken in the next list request. Subsequent list requests will have their ownnextPageToken to continue paging through the results.

selfLink

string

[Output Only] Server-defined URL for this resource.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returnsNO_RESULTS_ON_PAGE if there are no results in the response.

warning.message

string

[Output Only] A human-readable description of the warning code.

warning.data[]

object

[Output Only] Metadata about this warning inkey: value format. For example:

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }

warning.data[].key

string

[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 bescope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

warning.data[].value

string

[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 theAuthentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the followingIAM permissions:

  • compute.regionHealthCheckServices.list

To find predefined roles that contain those permissions, seeCompute Engine IAM Roles.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-09-18 UTC.