Managed Database for Redis™ API

Introduction

Managed Database for Redis™ is a low-latency caching solution. It allows you to easily set up a secure cache and lighten the load on your main database. Based on the in-memory data storage, Managed Database for Redis™ improves your application response time and helps you provide a better experience to your users.

Using Managed Database for Redis™ as a cache optimizes the speed of your requests as copies of the most frequently used data are stored in memory, making them accessible in milliseconds.

Concepts

Refer to our dedicated concepts page to find definitions of the different terms referring to Managed Database for Redis™.

Quickstart

1. Configure your environment variables.

   Note

   This is an optional step that seeks to simplify your usage of the APIs

   export ACCESS_KEY="<access-key>"
   export SECRET_KEY="<secret-key>"
   export SCW_ZONE="<zone>"
   

2. Edit the POST request payload you will use to create your Redis™ Database Instance cluster. Replace the parameters in the following example:

   {
   "project_id":"50e8d5d3-c623-4df8-a5ef-1972a5432001",
   "name":"cluster1",
   "version":"7.0.5",
   "tags":[
       "tag1"
   ],
   "node_type":"RED1-micro",
   "user_name":"redis-user",
   "password":"lxbemloZiPT1l37*",
   "cluster_size": 3,
   "endpoints": [
       {
         "private_network": {
           "id": "d8e65f2b-cce9-40b7-80fc-6a2902db6826",
           "service_ips": [
             "192.0.2.1/24",
             "192.0.2.2/24",
             "192.0.2.3/24"
             ]
           }
         }
       ],
   "tls_enabled": true
   }
   

   Parameter	Description
   project_id	REQUIRED The ID of the Project you want to create your Database Instance in. To find your Project ID you can list the projects or consult the Scaleway console.
   name	Name of the Redis™ Database Instance
   version	REQUIRED Version of the Redis™ engine. To check the list of available versions you can use the folowing endpoint: https://api.scaleway.com/redis/v1/zones/$SCW_ZONE/cluster-versions
   tags	The list of tags ["tag1", "tag2", ...] that will be associated with the Redis™ Database Instance. Tags can be appended to the query of the List Database Instances call to show a list of the Database Instances using a specific tag. You can also combine tags to list Database Instances that possess all of the appended tags.
   node_type	REQUIRED The node type. To check the list of available node types you can use the folowing endpoint: https://api.scaleway.com/redis/v1/zones/$SCW_ZONE/node-types
   user_name	REQUIRED Identifier of the default user, which is created concurrently with the Redis™ Database Instance
   password	REQUIRED Password for the default user
   cluster_size	INTEGER The number of nodes in the Redis™ Database Instance cluster. You can either set it to 1 for a standalone Database Instance, or set it to 3 to 6, for Database Instances in cluster mode
   endpoints	The network configuration of your Redis™ Database Instance. You can either set private_network or public_network. If you set up a Private Network, you must define the ID of the Private Network connected to the cluster, and one IPv4 address endpoint per node. The address must be in the RFC1918 subnet range and follow the CIDR notation method.
   tls_enabled	BOOLEAN Whether or not to enable TLS certificates

3. Create a Redis™ Database Instance by running the following command. Make sure you include the payload you edited in the previous step.

   curl -X POST \
     -H "Content-Type: application/json" \
     -H "X-Auth-Token: $SCW_SECRET_KEY" https://api.scaleway.com/redis/v1/zones/$SCW_REGION/clusters \
     -d  '{
       "project_id":"50e8d5d3-c623-4df8-a5ef-1972a5432001",
       "name":"cluster1",
       "version":"7.0.5",
       "tags":[
           "tag1"
       ],
       "node_type":"RED1-micro",
       "user_name":"redis-user",
       "password":"lxbemloZiPT1l37*",
       "cluster_size": 3,
       "endpoints": [
           {
             "private_network": {
               "id": "d8e65f2b-cce9-40b7-80fc-6a2902db6826",
               "service_ips": [
                 "192.0.2.1/24",
                 "192.0.2.2/24",
                 "192.0.2.3/24"
                 ]
               }
             }
           ],
       "tls_enabled": true
     }'
   

4. List your Redis™ Database Instances.

   curl -X GET
     -H "Content-Type: application/json" \
     -H "X-Auth-Token: $SCW_SECRET_KEY" https://api.scaleway.com/redis/v1/zones/$SCW_ZONE/clusters
   

5. Retrieve your Redis™ Database Instance IP and port from the response.

   Note

   In this tutorial, we will use 192.0.2.1 and 6379 as the IP and port, respectively

6. Connect to your Database Instance with the Redis™ client.

   Note

   You can use only one of your node IP addresses at a time to connect to your Redis™ Database Instance, as the Redis™ CLI does not support cluster mode.

   redis-cli -h 192.0.2.1 -p 6379 --user redis-user --askpass --tls --cacert SSL_redis-cluster1.pem
   

   Note

   The command above uses TLS to add an extra layer of security to your connection. The TLS certificate is generated automatically if you set tls_enabled to true. The certificates take on the following name structure: SSL_redis-<name-of-your-redis-database-instance>.pem. When using connectors other than redis-cli, you might need to specify the path to your certificate.

   Important

   Scaleway supports TLS1.2 and TLS1.3. If you use older versions of libssl, you might encounter connexion issues when using redis-cli. If this is the case, we recommend you check the libssl versions installed on your local machine and update if necessary.

7. Enter the database password that you defined upon creation.

You are now connected to your Managed Database for Redis™.

Going Further

For more information about Managed Database for Redis™, you can check out the following pages:

• Managed Database for Redis™ Documentation
• Managed Database for Redis™ FAQ
• Scaleway Slack Community join the #database channel
• Contact our support team.

Redis™ Database Instance

Nodes Types

Redis™ engine versions

TLS Certificates

Advanced Settings

ACL Rules

Endpoints