Exoscale APIv2 API documentation

Create a DBaaS Redis service

POST /dbaas-redis/{name}

Create a DBaaS Redis service

Path parameters

name string Required

Service name

Minimum length is 0, maximum length is 63.

Body Required

maintenance object

Automatic maintenance settings
- dow string Required
  
  Day of week for installing updates
  
  Values are saturday, tuesday, never, wednesday, sunday, friday, monday, or thursday.
- time string Required
  
  Time for installing updates, UTC
  
  Minimum length is 8, maximum length is 8.
plan string Required

Subscription plan

Minimum length is 1, maximum length is 128.
termination-protection boolean

Service is protected against termination and powering off
ip-filter array[string]

Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'
migration object

Migrate data from existing server
- host string Required
  
  Hostname or IP address of the server where to migrate data from
  
  Minimum length is 1, maximum length is 255.
- port integer(int64) Required
  
  Port number of the server where to migrate data from
  
  Minimum value is 1, maximum value is 65535.
- password string
  
  Password for authentication with the server where to migrate data from
  
  Minimum length is 1, maximum length is 255.
- ssl boolean
  
  The server where to migrate data from is secured with SSL
- username string
  
  User name for authentication with the server where to migrate data from
  
  Minimum length is 1, maximum length is 255.
- dbname string
  
  Database name for bootstrapping the initial connection
  
  Minimum length is 1, maximum length is 63.
- ignore-dbs string
  
  Comma-separated list of databases, which should be ignored during migration (supported by MySQL only at the moment)
  
  Minimum length is 1, maximum length is 2048.
- method string
  
  The migration method to be used
  
  Values are dump or replication.
redis-settings object

Redis.conf settings
fork-from-service string

Service name

Minimum length is 0, maximum length is 63.
recovery-backup-name string

Name of a backup to recover from for services that support backup names

Minimum length is 1.

Responses

• 200 object

200
- id string(uuid)
  
  Operation ID
- reason string
  
  Operation failure reason
  
  Values are incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, or conflict.
- reference object
  
  Related resource reference
  id string(uuid)
  
  Reference ID
  
  link string
  
  Link to the referenced resource
  
  command string
  
  Command name
- message string
  
  Operation message
- state string
  
  Operation status
  
  Values are failure, pending, success, or timeout.

POST /dbaas-redis/{name}

curl \
 -X POST https://api-ch-gva-2.exoscale.com/v2/dbaas-redis/{name} \
 -H "Content-Type: application/json" \
 -d '{"maintenance":{"dow":"saturday","time":"string"},"plan":"string","termination-protection":true,"ip-filter":["string"],"migration":{"host":"string","port":42,"password":"string","ssl":true,"username":"string","dbname":"string","ignore-dbs":"string","method":"dump"},"redis-settings":{},"fork-from-service":"string","recovery-backup-name":"string"}'

Request example

{
  "maintenance": {
    "dow": "saturday",
    "time": "string"
  },
  "plan": "string",
  "termination-protection": true,
  "ip-filter": [
    "string"
  ],
  "migration": {
    "host": "string",
    "port": 42,
    "password": "string",
    "ssl": true,
    "username": "string",
    "dbname": "string",
    "ignore-dbs": "string",
    "method": "dump"
  },
  "redis-settings": {},
  "fork-from-service": "string",
  "recovery-backup-name": "string"
}

Response example (200)

{
  "id": "string",
  "reason": "incorrect",
  "reference": {
    "id": "string",
    "link": "string",
    "command": "string"
  },
  "message": "string",
  "state": "failure"
}