Method: regionHealthAggregationPolicies.get

Returns the specified HealthAggregationPolicy resource in the given region.

HTTP request

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

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.

healthAggregationPolicy

string

Name of the HealthAggregationPolicy resource to return.

Request body

The request body must be empty.

Response body

Represents a health aggregation policy.

A health aggregation policy resource defines a policy to aggregate health.

For more information, see Health checks overview.

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

JSON representation
{"kind":string,"id":string,"creationTimestamp":string,"name":string,"description":string,"selfLink":string,"selfLinkWithId":string,"region":string,"policyType":enum,"healthyPercentThreshold":integer,"minHealthyThreshold":integer,"fingerprint":string}
Fields
kind

string

[Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation policies.

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.

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 health aggregation policy 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.

policyType

enum

Specifies the type of the healthAggregationPolicy. The only allowed value for global resources isDNS_PUBLIC_IP_POLICY. The only allowed value for regional resources isBACKEND_SERVICE_POLICY. Must be specified when the healthAggregationPolicy is created, and cannot be mutated.

healthyPercentThreshold

integer (uint32 format)

Can only be set if thepolicyType field isBACKEND_SERVICE_POLICY. Specifies the threshold (as a percentage) of healthy endpoints required in order to consider the aggregated health result HEALTHY. Defaults to60. Must be in range [0, 100]. Not applicable if thepolicyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, and will be set to the default if unspecified. Note that both this threshold andminHealthyThreshold must be satisfied in order for HEALTHY to be the aggregated result. "Endpoints" refers to network endpoints within a Network Endpoint Group or instances within an Instance Group.

minHealthyThreshold

integer (uint32 format)

Can only be set if thepolicyType field isBACKEND_SERVICE_POLICY. Specifies the minimum number of healthy endpoints required in order to consider the aggregated health result HEALTHY. Defaults to1. Must be positive. Not applicable if thepolicyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, and will be set to the default if unspecified. Note that both this threshold andhealthyPercentThreshold must be satisfied in order for HEALTHY to be the aggregated result. "Endpoints" refers to network endpoints within a Network Endpoint Group or instances within an Instance Group.

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

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