Scaleway Managed Database for Redis™ API (original) (raw)

Introduction

Redis™ Database Instance

A Redis™ Database Instance, also known as a Redis™ cluster, consists of either one standalone node or a cluster composed of three to six nodes. The cluster uses partitioning to split the keyspace. Each partition is replicated and can be reassigned or elected as the primary when necessary. Standalone mode creates a standalone database provisioned on a single node.

GET`

/redis/v1/zones/{zone}/clusters

`

POST`

/redis/v1/zones/{zone}/clusters

`

GET`

/redis/v1/zones/{zone}/clusters/{cluster_id}

`

PATCH`

/redis/v1/zones/{zone}/clusters/{cluster_id}

`

DELETE`

/redis/v1/zones/{zone}/clusters/{cluster_id}

`

GET`

/redis/v1/zones/{zone}/clusters/{cluster_id}/metrics

`

POST`

/redis/v1/zones/{zone}/clusters/{cluster_id}/migrate

`

Nodes Types

Nodes are the compute units that make up your Redis™ Database Instance. Different node types are available with varying amounts of RAM and vCPU.

GET`

/redis/v1/zones/{zone}/node-types

`

Redis™ engine versions

The Redis™ database engine versions available at Scaleway for your clusters.

GET`

/redis/v1/zones/{zone}/cluster-versions

`

TLS Certificates

Transport Layer Security (TLS) is an Internet security protocol that enables data to be securely exchanged over a network using in transit encryption. If you set the tls_enabled parameter to true when creating or updating a cluster, a TLS certificate will be automatically generated for your Redis™ Database Instance to ensure secure connections.

GET`

/redis/v1/zones/{zone}/clusters/{cluster_id}/certificate

`

POST`

/redis/v1/zones/{zone}/clusters/{cluster_id}/renew-certificate

`

Advanced Settings

Advanced settings allow you to tune the behavior of your Redis™ database engine to better fit your needs. Available settings depend on the version of the Redis™ engine. Note that some settings can only be defined upon the Redis™ engine initialization. These are called init settings. You can find a full list of the settings available in the response body of the list available Redis™ versions endpoint.

Each advanced setting entry has a default value that users can override. The deletion of a setting entry will restore the setting to default value. Some of the defaults values can be different from the engine's defaults, as we optimize them to the Scaleway platform.

POST`

/redis/v1/zones/{zone}/clusters/{cluster_id}/settings

`

PUT`

/redis/v1/zones/{zone}/clusters/{cluster_id}/settings

`

DELETE`

/redis/v1/zones/{zone}/clusters/{cluster_id}/settings/{setting_name}

`

ACL Rules

Network Access Control Lists (ACLs) allow you to manage network inbound traffic by setting up ACL rules.

GET`

/redis/v1/zones/{zone}/acls/{acl_id}

`

DELETE`

/redis/v1/zones/{zone}/acls/{acl_id}

`

POST`

/redis/v1/zones/{zone}/clusters/{cluster_id}/acls

`

PUT`

/redis/v1/zones/{zone}/clusters/{cluster_id}/acls

`

Endpoints

Manage endpoint access to your Redis™ Database Instance through Public or Private Networks

POST`

/redis/v1/zones/{zone}/clusters/{cluster_id}/endpoints

`

PUT`

/redis/v1/zones/{zone}/clusters/{cluster_id}/endpoints

`

GET`

/redis/v1/zones/{zone}/endpoints/{endpoint_id}

`

PATCH`

/redis/v1/zones/{zone}/endpoints/{endpoint_id}

`

DELETE`

/redis/v1/zones/{zone}/endpoints/{endpoint_id}

`