.TH "GCLOUD_COMPUTE_BACKEND\-SERVICES_GET\-HEALTH" 1



.SH "NAME"
.HP
gcloud compute backend\-services get\-health \- get backend health statuses from a backend service



.SH "SYNOPSIS"
.HP
\f5gcloud compute backend\-services get\-health\fR \fIBACKEND_SERVICE_NAME\fR [\fB\-\-global\fR\ |\ \fB\-\-region\fR=\fIREGION\fR] [\fB\-\-filter\fR=\fIEXPRESSION\fR] [\fB\-\-limit\fR=\fILIMIT\fR] [\fB\-\-page\-size\fR=\fIPAGE_SIZE\fR] [\fB\-\-sort\-by\fR=[\fIFIELD\fR,...]] [\fB\-\-uri\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fBgcloud compute backend\-services get\-health\fR is used to request the
current health status of instances in a backend service. Every group in the
service is checked and the health status of each configured instance is printed.

If a group contains names of instances that don't exist or instances that
haven't yet been pushed to the load\-balancing system, they will not show up.
Those that are listed as \f5\fIHEALTHY\fR\fR are able to receive load\-balanced
traffic. Those that are marked as \f5\fIUNHEALTHY\fR\fR are either failing the
configured health\-check or not responding to it.

Since the health checks are performed continuously and in a distributed manner,
the state returned by this command is the most recent result of a vote of
several redundant health checks. Backend services that do not have a valid
global forwarding rule referencing it will not be health checked and so will
have no health status.



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
\fIBACKEND_SERVICE_NAME\fR

Name of the backend service to operate on.


.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-global\fR

If set, the backend service is global.

.TP 2m
\fB\-\-region\fR=\fIREGION\fR

Region of the backend service to operate on. Overrides the default
\fBcompute/region\fR property value for this command invocation.


.RE
.RE
.sp

.SH "LIST COMMAND FLAGS"

.RS 2m
.TP 2m
\fB\-\-filter\fR=\fIEXPRESSION\fR

Apply a Boolean filter \fIEXPRESSION\fR to each resource item to be listed. If
the expression evaluates \f5True\fR, then that item is listed. For more details
and examples of filter expressions, run $ gcloud topic filters. This flag
interacts with other flags that are applied in this order: \fB\-\-flatten\fR,
\fB\-\-sort\-by\fR, \fB\-\-filter\fR, \fB\-\-limit\fR.

.TP 2m
\fB\-\-limit\fR=\fILIMIT\fR

Maximum number of resources to list. The default is \fBunlimited\fR. This flag
interacts with other flags that are applied in this order: \fB\-\-flatten\fR,
\fB\-\-sort\-by\fR, \fB\-\-filter\fR, \fB\-\-limit\fR.

.TP 2m
\fB\-\-page\-size\fR=\fIPAGE_SIZE\fR

Some services group resource list output into pages. This flag specifies the
maximum number of resources per page. The default is determined by the service
if it supports paging, otherwise it is \fBunlimited\fR (no paging). Paging may
be applied before or after \fB\-\-filter\fR and \fB\-\-limit\fR depending on the
service.

.TP 2m
\fB\-\-sort\-by\fR=[\fIFIELD\fR,...]

Comma\-separated list of resource field key names to sort by. The default order
is ascending. Prefix a field with ``~'' for descending order on that field. This
flag interacts with other flags that are applied in this order:
\fB\-\-flatten\fR, \fB\-\-sort\-by\fR, \fB\-\-filter\fR, \fB\-\-limit\fR.

.TP 2m
\fB\-\-uri\fR

Print a list of resource URIs instead of the default output, and change the
command output to a list of URIs. If this flag is used with \fB\-\-format\fR,
the formatting is applied on this URI list. To display URIs alongside other keys
instead, use the \fBuri()\fR transform.


.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha compute backend\-services get\-health
.RE

.RS 2m
$ gcloud beta compute backend\-services get\-health
.RE