Method: regionHealthCheckServices.get

Returns the specified regionalHealthCheckService resource.

HTTP request

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

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.

healthCheckService

string

Name of theHealthCheckService to update. The name must be 1-63 characters long, and comply withRFC1035.

Request body

The request body must be empty.

Response body

Represents a Health-Check as a Service resource.

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

JSON representation
{"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}
Fields
kind

string

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

id

string (uint64 format)

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

creationTimestamp

string

[Output Only] Creation timestamp inRFC3339 text format.

selfLink

string

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

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.

description

string

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

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.

healthStatusAggregationStrategy
(deprecated)

enum

This item is deprecated!

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.
.

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.

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.

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.

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.

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.

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.get

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.