1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-08 10:35:03 +00:00
gcloud-help/gcloud/alpha/memcache/instances/describe
2023-05-04 10:43:54 +00:00

79 lines
2.9 KiB
Text

NAME
gcloud alpha memcache instances describe - display metadata for a
Memorystore Memcached instance
SYNOPSIS
gcloud alpha memcache instances describe (INSTANCE : --region=REGION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Displays all metadata associated with a Memcached instance given a
valid instance name.
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.
EXAMPLES
To display the metadata for an instance named my-memcache-instance in
region us-central1, run:
$ gcloud alpha memcache instances describe my-memcache-instance \
--region=us-central1
POSITIONAL ARGUMENTS
Instance resource - Arguments and flags that specify the Memcached
instance 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.
To set the instance attribute:
▸ provide the argument instance 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 Memcached region of the instance. Overrides the
default memcache/region property value for this command invocation.
To set the region attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property memcache/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 memcache/v1beta2 API. The full documentation for this
API can be found at: https://cloud.google.com/memorystore/
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:
$ gcloud memcache instances describe
$ gcloud beta memcache instances describe