gcloud_alpha_redis_instances_describe (1)
NAME
- gcloud alpha redis instances describe - show metadata for a Memorystore Redis instance
SYNOPSIS
-
gcloud alpha redis instances describe (INSTANCE : --region=REGION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Show metadata for a Memorystore Redis instance.
This command can fail for the following reasons:
-
- *
- The instance specified does not exist.
- *
- The active account does not have permission to access the given instance.
POSITIONAL ARGUMENTS
-
-
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 [project]
attribute: provide the argument [instance] 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.
-
- INSTANCE
-
ID of the instance or fully qualified identifier for the instance. This
positional must be specified if any of the other arguments in this group are
specified.
- --region=REGION
-
The name of the Redis region of the instance. Overrides the default redis/region
property value for this command invocation.
-
-
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 [project]
attribute: provide the argument [instance] 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.
GCLOUD WIDE FLAGS
These flags are available to all commands: --account, --configuration, --flags-file, --flatten, --format, --help, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity. Run $ gcloud help for details.
API REFERENCE
This command uses the redis/v1 API. The full documentation for this API can be found at: cloud.google.com/memorystore/docs/redis
EXAMPLES
To display the metadata for an instance with the name my-redis-instance in the default region, run:
- $ gcloud alpha redis instances describe my-redis-instance
NOTES
This command is currently in ALPHA and may change without notice. If this command fails with API permission errors despite specifying the right project, you will have to apply for early access and have your projects registered on the API whitelist to use it. To do so, contact Support at cloud.google.com/support These variants are also available:
- $ gcloud redis instances describe $ gcloud beta redis instances describe