Method: regionHealthAggregationPolicies.list

Lists the HealthAggregationPolicies for a project in the given region.

HTTP request

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

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

Parameters
`project`	`string` Project ID for this request.
`region`	`string` Name of the region scoping this request.

project

string

Project ID for this request.

region

string

Name of the region scoping this request.

Query parameters

Parameters
`maxResults`	`integer (uint32 format)` The maximum number of results per page that should be returned. If the number of available results is larger than`maxResults`, Compute Engine returns a`nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are`0` to`500`, inclusive. (Default:`500`)
`pageToken`	`string` Specifies a page token to use. Set`pageToken` to the`nextPageToken` returned by a previous list request to get the next page of results.
`filter`	`string` A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposalAIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either`=`,`!=`,`>`,`<`,`<=`,`>=` or`:`. For example, if you are filtering Compute Engine instances, you can exclude instances named`example-instance` by specifying`name != example-instance`. The`:` comparison can be used to test whether a key has been defined. For example, to find all objects with`owner` label use: `labels.owner:` You can also filter nested fields. For example, you could specify`scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based onresource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: `(scheduling.automaticRestart = true)(cpuPlatform = "Intel Skylake")` By default, each expression is an`AND` expression. However, you can include`AND` and`OR` expressions explicitly. For example: `(cpuPlatform = "Intel Skylake") OR(cpuPlatform = "Intel Broadwell") AND(scheduling.automaticRestart = true)` If you want to use a regular expression, use the`eq` (equal) or`ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literalfieldname eq 'single quoted literal'fieldname eq "double quoted literal"(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using GoogleRE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use`name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
`orderBy`	`string` Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using`orderBy="creationTimestamp desc"`. This sorts results based on the`creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by`name` or`creationTimestamp desc` is supported.
`returnPartialSuccess`	`boolean` Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

Request body

The request body must be empty.

Response body

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

JSON representation
{"kind":string,"id":string,"items":[{"kind":string,"id":string,"creationTimestamp":string,"name":string,"description":string,"selfLink":string,"selfLinkWithId":string,"region":string,"policyType":enum,"healthyPercentThreshold":integer,"minHealthyThreshold":integer,"fingerprint":string}],"nextPageToken":string,"selfLink":string,"warning":{"code":enum,"message":string,"data":[{"key":string,"value":string}]}}

JSON representation

{"kind":string,"id":string,"items":[{"kind":string,"id":string,"creationTimestamp":string,"name":string,"description":string,"selfLink":string,"selfLinkWithId":string,"region":string,"policyType":enum,"healthyPercentThreshold":integer,"minHealthyThreshold":integer,"fingerprint":string}],"nextPageToken":string,"selfLink":string,"warning":{"code":enum,"message":string,"data":[{"key":string,"value":string}]}}

Fields
`kind`	`string` [Output Only] Type of the resource. Always`compute#healthAggregationPolicy` for health aggregation policies.
`id`	`string` [Output Only] Unique identifier for the resource; defined by the server.
`items[]`	`object` A list of HealthAggregationPolicy resources.
`items[].kind`	`string` [Output Only] Type of the resource. Always`compute#healthAggregationPolicy` for health aggregation policies.
`items[].id`	`string (uint64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`items[].creationTimestamp`	`string` [Output Only] Creation timestamp inRFC3339 text format.
`items[].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.
`items[].description`	`string` An optional description of this resource. Provide this property when you create the resource.
`items[].selfLink`	`string` [Output Only] Server-defined URL for the resource.
`items[].selfLinkWithId`	`string` [Output Only] Server-defined URL with id for the resource.
`items[].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.
`items[].policyType`	`enum` Specifies the type of the healthAggregationPolicy. The only allowed value for global resources is`DNS_PUBLIC_IP_POLICY`. The only allowed value for regional resources is`BACKEND_SERVICE_POLICY`. Must be specified when the healthAggregationPolicy is created, and cannot be mutated.
`items[].healthyPercentThreshold`	`integer (uint32 format)` Can only be set if the`policyType` field is`BACKEND_SERVICE_POLICY`. Specifies the threshold (as a percentage) of healthy endpoints required in order to consider the aggregated health result HEALTHY. Defaults to`60`. Must be in range [0, 100]. Not applicable if the`policyType` field is`DNB_PUBLIC_IP_POLICY`. Can be mutated. This field is optional, and will be set to the default if unspecified. Note that both this threshold and`minHealthyThreshold` 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.
`items[].minHealthyThreshold`	`integer (uint32 format)` Can only be set if the`policyType` field is`BACKEND_SERVICE_POLICY`. Specifies the minimum number of healthy endpoints required in order to consider the aggregated health result HEALTHY. Defaults to`1`. Must be positive. Not applicable if the`policyType` field is`DNB_PUBLIC_IP_POLICY`. Can be mutated. This field is optional, and will be set to the default if unspecified. Note that both this threshold and`healthyPercentThreshold` 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.
`items[].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`HealthAggregationPolicy`. An up-to-date fingerprint must be provided in order to patch the HealthAggregationPolicy; Otherwise, the request will fail with error`412 conditionNotMet`. To see the latest fingerprint, make a`get()` request to retrieve the HealthAggregationPolicy. A base64-encoded string.
`nextPageToken`	`string` [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than`maxResults`, use the`nextPageToken` as a value for the query parameter`pageToken` in the next list request. Subsequent list requests will have their own`nextPageToken` to continue paging through the results.
`selfLink`	`string` [Output Only] Server-defined URL for this resource.
`warning`	`object` [Output Only] Informational warning message.
`warning.code`	`enum` [Output Only] A warning code, if applicable. For example, Compute Engine returns`NO_RESULTS_ON_PAGE` if there are no results in the response.
`warning.message`	`string` [Output Only] A human-readable description of the warning code.
`warning.data[]`	`object` [Output Only] Metadata about this warning in`key: value` format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
`warning.data[].key`	`string` [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be`scope` and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
`warning.data[].value`	`string` [Output Only] A warning data value corresponding to the key.

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

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.

Movatterモバイル変換

Method: regionHealthAggregationPolicies.list Stay organized with collections Save and categorize content based on your preferences.