.TH "GCLOUD_ALPHA_REDIS_INSTANCES_DESCRIBE" 1



.SH "NAME"
.HP
gcloud alpha redis instances describe \- show metadata for a Memorystore Redis instance



.SH "SYNOPSIS"
.HP
\f5gcloud alpha redis instances describe\fR (\fIINSTANCE\fR\ :\ \fB\-\-region\fR=\fIREGION\fR) [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Show metadata for a Memorystore Redis instance.

Displays all metadata associated with a Redis instance given a valid instance
name.

This command can fail for the following reasons:
.RS 2m
.IP "\(bu" 2m
The instance specified does not exist.
.IP "\(bu" 2m
The active account does not have permission to access the given instance.
.RE
.sp



.SH "EXAMPLES"

To display the metadata for an instance with the name \f5my\-redis\-instance\fR
in the default region, run:

.RS 2m
$ gcloud alpha redis instances describe my\-redis\-instance
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Instance resource \- Arguments and flags that specify the Memorystore Redis
instance you want to describe. 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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5instance\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIINSTANCE\fR

ID of the instance or fully qualified identifier for the instance.

To set the \f5instance\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5instance\fR on the command line.
.RE
.sp

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

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

The name of the Redis region of the instance. Overrides the default redis/region
property value for this command invocation.


To set the \f5region\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5instance\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-region\fR on the command line;
.IP "\(bu" 2m
set the property \f5redis/region\fR.
.RE
.sp


.RE
.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 "API REFERENCE"

This command uses the \fBredis/v1alpha1\fR API. The full documentation for this
API can be found at: https://cloud.google.com/memorystore/docs/redis/



.SH "NOTES"

This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation\-only early access
allowlist. These variants are also available:

.RS 2m
$ gcloud redis instances describe
.RE

.RS 2m
$ gcloud beta redis instances describe
.RE