[Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp
string
[Output Only] Creation timestamp in RFC3339 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 with RFC1035. 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 field is deprecated. Use healthStatusAggregationPolicy instead.
Policy for how the results from multiple health checks for the same endpoint are aggregated.
NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service.
AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY.
.
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. An EndpointHealth message is returned for each <endpoint, health check> pair in the health check service.
AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY.
. This is only allowed with regional HealthCheckService.
healthChecks[]
string
A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORTNetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORTNetworkEndpointGroups.
networkEndpointGroups[]
string
A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT.
notificationEndpoints[]
string
A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
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 a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-28 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eHealthCheckService\u003c/code\u003e resource represents a health check service, defining how health checks are performed and results aggregated.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eHealthCheckService\u003c/code\u003e resource includes details such as name, description, region, health status aggregation policy, and lists of associated health checks, network endpoint groups, and notification endpoints.\u003c/p\u003e\n"],["\u003cp\u003eHealth check results can be aggregated using either \u003ccode\u003eNO_AGGREGATION\u003c/code\u003e or \u003ccode\u003eAND\u003c/code\u003e policies, defining how the health status of multiple endpoints or checks are combined.\u003c/p\u003e\n"],["\u003cp\u003eThe resource supports operations like creating, retrieving, updating, deleting, and listing \u003ccode\u003eHealthCheckService\u003c/code\u003e instances within a specified region, as well as testing permissions.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eHealthCheckService\u003c/code\u003e can be associated with up to 10 \u003ccode\u003eHealthCheck\u003c/code\u003e resources and 100 \u003ccode\u003eNetworkEndpointGroup\u003c/code\u003e resources.\u003c/p\u003e\n"]]],[],null,["# REST Resource: regionHealthCheckServices\n\n- [Resource: HealthCheckService](#HealthCheckService)\n - [JSON representation](#HealthCheckService.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: HealthCheckService\n----------------------------\n\nRepresents a Health-Check as a Service resource."]]
