gcloud compute health-aggregation-policies describe

NAME

gcloud compute health-aggregation-policies describe - describe a health aggregation policy

SYNOPSIS

gcloud compute health-aggregation-policies describe (HEALTH_AGGREGATION_POLICY : --region=REGION) [GCLOUD_WIDE_FLAG …]

DESCRIPTION

Describe a health aggregation policy.

EXAMPLES

To retrieve a single health aggregation policy and print its properties, run the following command:

gcloud compute health-aggregation-policies describe <HEALTH_AGGREGATION_POLICY_NAME> --region=<REGION>

POSITIONAL ARGUMENTS

Health aggregation policy resource - Name of the health aggregation policy you want to inspect. The arguments in this group can be used to specify the attributes of this resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways.

To set the project attribute:

provide the argument health_aggregation_policy on the command line with a fully specified name;
provide the argument --project on the command line;
set the property core/project.

This must be specified.

HEALTH_AGGREGATION_POLICY

ID of the health aggregation policy or fully qualified identifier for the health aggregation policy.

To set the health_aggregation_policy attribute:

provide the argument health_aggregation_policy on the command line.

This positional argument must be specified if any of the other arguments in this group are specified.

--region=REGION

The name of the Google Compute Engine region. To set the region attribute:

provide the argument health_aggregation_policy on the command line with a fully specified name;
provide the argument --region on the command line;
set the property compute/region.

GCLOUD WIDE FLAGS

These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.

Run $ gcloud help for details.

API REFERENCE

This command uses the compute/v1 API. The full documentation for this API can be found at: https://cloud.google.com/compute/

NOTES

These variants are also available:

gcloud alpha compute health-aggregation-policies describe

gcloud beta compute health-aggregation-policies describe

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-05-27 UTC.