REST Resource: regionCompositeHealthChecks

Resource: CompositeHealthCheck

Represents a composite health check.

A composite health check resource specifies the health source resources and the health destination resource to which the aggregated health result from the health source resources is delivered.

JSON representation
{"kind":string,"id":string,"creationTimestamp":string,"name":string,"description":string,"selfLink":string,"selfLinkWithId":string,"region":string,"healthSources":[string],"healthDestination":string,"fingerprint":string}
Fields
kind

string

[Output Only] Type of the resource. Alwayscompute#compositeHealthCheck for composite health checks.

id

string (uint64 format)

[Output Only] A unique identifier for this resource type. The server generates this identifier.

creationTimestamp

string

[Output Only] Creation timestamp inRFC3339 text format.

name

string

Name of the resource. Provided by the client when the resource is created. 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.

selfLink

string

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

selfLinkWithId

string

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

region

string

[Output Only] URL of the region where the composite health check resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

healthSources[]

string

URLs to theHealthSource resources whose results are AND'ed. I.e. he aggregated result is isHEALTHY only if all sources areHEALTHY. Must have at least 1. Must not have more than 10. Must be regional and in the same region as theCompositeHealthCheck. Can be mutated.

healthDestination

string

URL to the destination resource. Must be set. Must be aForwardingRule. TheForwardingRule must have load balancing schemeINTERNAL orINTERNAL_MANAGED and must be regional and in the same region as theCompositeHealthCheck (cross-region deployment forINTERNAL_MANAGED is not supported). Can be mutated.

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 aCompositeHealthCheck. An up-to-date fingerprint must be provided in order to patch the CompositeHealthCheck; Otherwise, the request will fail with error412 conditionNotMet. To see the latest fingerprint, make aget() request to retrieve the CompositeHealthCheck.

A base64-encoded string.

Methods

aggregatedList

 Retrieves the list of allCompositeHealthCheck resources (all regional) available to the specified project.

delete

 Deletes the specified CompositeHealthCheck in the given region

get

 Returns the specified CompositeHealthCheck resource in the given region.

insert

 Create a CompositeHealthCheck in the specified project in the given region using the parameters that are included in the request.

list

 Lists the CompositeHealthChecks for a project in the given region.

patch

 Updates the specified regionalCompositeHealthCheck resource with the data included in the request.

testIamPermissions

 Returns permissions that a caller has on the specified resource.

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-10-30 UTC.