Viewing high-level information about Memorystore for Valkey instances is essential to obtain a comprehensive snapshot of the instance's state, configuration, and connectivity.
The following are sample use cases for viewing summary information about Memorystore for Valkey instances:
- Retrieve connection endpoints: For Cluster Mode Enabled instances, you can retrieve the discovery endpoint, which consists of an IP address and port number. For Cluster Mode Disabled instances, you can obtain the primary and reader endpoints that you need to configure your client applications to connect to the instance.
- Verify custom configurations: view configuration parameters that a user
applies to an instance. For example, you can obtain the value that a user sets
for the
maxmemory-policyparameter. - Check information about nodes and shards: obtain information about the nodes and shards associated with an instance. This includes the number of shards, the node type, and the number of replicas that each shard has.
- Confirm data resiliency settings: verify active persistence modes for Redis Database (RDB) snapshots and Append-Only File (AOF) log files, as well as the status of whether an instance is protected from accidental deletion.
View instance summary information
You can view summary information about an instance by using either the Google Cloud console or the gcloud CLI.
Console
In the Google Cloud console, go to the Memorystore for Valkey page.
Click the ID of an instance about which you want to view summary information.
gcloud
To view summary information about an instance, use the
gcloud memorystore instances describe
command:
gcloud memorystore instances describe INSTANCE_ID \ --location=REGION_ID
Make the following replacements:
- INSTANCE_ID: the ID of the instance about which you want to view summary information
- REGION_ID: the region where the instance is located
For example:
gcloud memorystore instances describe my-instance \ --location=us-central1