REST Resource: regionHealthCheckServices

Resource: HealthCheckService

Represents a Health-Check as a Service resource.

JSON representation 
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "selfLink": string,
  "name": string,
  "description": string,
  "region": string,
  "healthStatusAggregationPolicy": enum (HealthStatusAggregationPolicy),
  "healthChecks": [
    string
  ],
  "networkEndpointGroups": [
    string
  ],
  "notificationEndpoints": [
    string
  ],
  "fingerprint": string
}
Fields
kind

string

[Output only] Type of the resource. Always

compute#healthCheckService

for 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 in RFC3339 text format.
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.
healthStatusAggregationPolicy

enum (HealthStatusAggregationPolicy)

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_PORT

NetworkEndpointGroups

, the global

HealthChecks

must specify

sourceRegions

, and

HealthChecks

that specify

sourceRegions

can only be used with global

INTERNET_IP_PORT

NetworkEndpointGroups

.
networkEndpointGroups[]

string

A list of URLs to the

NetworkEndpointGroup

resources. Must not have more than 100. For regional

HealthCheckService

,

NEG

s 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

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

A base64-encoded string.

HealthStatusAggregationPolicy

Enums
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

.

Methods

delete

 The method compute.v1.RegionHealthCheckServicesService.Delete is not available in Trusted Cloud by S3NS.

get

 The method compute.v1.RegionHealthCheckServicesService.Get is not available in Trusted Cloud by S3NS.

insert

 The method compute.v1.RegionHealthCheckServicesService.Insert is not available in Trusted Cloud by S3NS.

list

 The method compute.v1.RegionHealthCheckServicesService.List is not available in Trusted Cloud by S3NS.

patch

 The method compute.v1.RegionHealthCheckServicesService.Patch is not available in Trusted Cloud by S3NS.