Relational Database Service (RDS)¶

The RDS client is the command-line interface (CLI) for the Database service (RDS) API and its extensions.

For help on a specific rds command, enter:

$ openstack rds help SUBCOMMAND

Datastore Operations¶

rds datastore type list¶

List available datastores.

openstack rds datastore type list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

This command is provided by the otcextensions plugin.

rds datastore version list¶

Lists available versions for a datastore.

openstack rds datastore version list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    {mysql,postgresql,sqlserver}

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

{mysql,postgresql,sqlserver}¶: Name of the datastore Engine.

This command is provided by the otcextensions plugin.

Flavor Operations¶

rds flavor list¶

List database flavors.

openstack rds flavor list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    {mysql,postgresql,sqlserver}
    <version>

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

{mysql,postgresql,sqlserver}¶: Name of the datastore Engine.

version¶: Specifies the database version.

This command is provided by the otcextensions plugin.

Instance Operations¶

rds instance backup policy set¶

Set Database Backup Policy

openstack rds instance backup policy set
    --keep-days <keep_days>
    [--start-time <start_time>]
    [--period <period>]
    <instance>

--keep-days <keep_days>¶: Specifies the number of days toretain the generated backup files.

--start-time <start_time>¶: Specifies the backup time window.The value must be a valid value in the”hh:mm-HH:MM” format.

--period <period>¶: Specifies the backup cycleconfiguration. Data will beautomatically backed up on theselected days every week.

instance¶: Instance ID or Name

This command is provided by the otcextensions plugin.

rds instance backup policy show¶

Show Database instance Backup Policy

openstack rds instance backup policy show <instance>

instance¶: Instance ID or Name

This command is provided by the otcextensions plugin.

rds instance create¶

Create a new database instance.

openstack rds instance create
    --size <size>
    --volume-type
    {common,ultrahigh}
    --availability-zone <availability_zone>
    [--datastore-type <datastore>]
    [--datastore-version <datastore_version>]
    [--configuration <configuration_id>]
    [--disk-encryption-id <disk_encryption_id>]
    [--port <port>]
    [--password <password>]
    [--router-id <router_id>]
    [--network-id <net_id>]
    [--security-group-id <security_group_id>]
    [--ha-mode {sync,semisync,async}]
    [--charge-mode <charge_mode>]
    [--replica-of <source_instance>]
    [--from-instance <source_instance>]
    [--backup <backup>]
    [--backup-keepdays <backup_keepday>]
    [--backup-timeframe <HH:MM-HH:MM>]
    [--restore-time <time>]
    [--wait]
    [--wait-interval WAIT_INTERVAL]
    [--wait-timeout WAIT_TIMEOUT]
    <name>
    <flavor>

--size <size>¶: Size of the instance disk volume in GB.

--volume-type {common,ultrahigh}¶: Volume type. (COMMON, ULTRAHIGH).

--availability-zone <availability_zone>¶: The Zone hint to give to Nova.

--datastore-type <datastore>¶: Name of the datastore (type).

--datastore-version <datastore_version>¶: Datastore version.

--configuration <configuration_id>¶: ID of the configuration group to attach to the instance.

--disk-encryption-id <disk_encryption_id>¶: key ID for disk encryption.

--port <port>¶: Database Port

--password <password>¶: ID of the configuration group to attach to the instance.

--router-id <router_id>¶: ID of a Router the DB should be connected to

--network-id <net_id>¶: ID of a Neutron network the DB should be connected to.

--security-group-id <security_group_id>¶: Security group ID.

--ha-mode {sync,semisync,async}¶: replication mode for the standby DB instance. This parameter is required when using ha flavors.

--charge-mode <charge_mode>¶: Specifies the billing mode.

--replica-of <source_instance>¶: ID or name of an existing instance to replicate from.

--from-instance <source_instance>¶: Source instance ID or Name to create from. It is required when recovering from backup or PITR.

--backup <backup>¶: Backup ID or Name to create new instance from.

--backup-keepdays <backup_keepday>¶: Specifies the retention days for specific backup files.

--backup-timeframe <HH:MM-HH:MM>¶: Specifies the backup time window. Automated backups will be triggered during the backup time window.

--restore-time <time>¶: Time (UNIX timestamp in ms) to create new instance as a PointInTime recovery.

--wait¶: Wait for the instance to become active

--wait-interval <WAIT_INTERVAL>¶: Interval for checking status

--wait-timeout <WAIT_TIMEOUT>¶: Timeout

name¶: Name of the instance.

flavor¶: Flavor spec_code

This command is provided by the otcextensions plugin.

rds instance delete¶

Deletes an instance.

openstack rds instance delete
    [--wait]
    [--wait-interval WAIT_INTERVAL]
    [--wait-timeout WAIT_TIMEOUT]
    <instance>

--wait¶: Wait for the instance to be deleted

--wait-interval <WAIT_INTERVAL>¶: Interval for checking status

--wait-timeout <WAIT_TIMEOUT>¶: Timeout

instance¶: ID or name of the Instance

This command is provided by the otcextensions plugin.

rds instance list¶

List database instances

openstack rds instance list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--limit <limit>]
    [--id <id>]
    [--name <name>]
    [--type {ha,replica,single}]
    [--datastore-type {mysql,postgresql,sqlserver}]
    [--router-id <router_id>]
    [--network-id <net_id>]
    [--offset <offset>]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--limit <limit>¶: Limit the number of results displayed

--id <id>¶: Specifies the DB instance ID.

--name <name>¶: Specifies the DB instance Name.

--type {ha,replica,single}¶: Specifies the instance type. Values cane be single/ha/replica.

--datastore-type {mysql,postgresql,sqlserver}¶: Specifies the database type. value is MySQL, PostgreSQL, or SQLServer.

--router-id <router_id>¶: Specifies the ID of Router to which instance should be connected to.

--network-id <net_id>¶: Indicates the Neutron network ID of DB Instance.

--offset <offset>¶: Specifies the index position.

This command is provided by the otcextensions plugin.

rds instance restore¶

Restores an instance from backup.

openstack rds instance restore
    (--backup <backup> | --restore-time <restore_time>)
    [--wait]
    [--wait-interval WAIT_INTERVAL]
    <instance>

--backup <backup>¶: ID or name of the backup.

--restore-time <restore_time>¶: Specifies the time point of data restoration in the UNIX timestamp

--wait¶: Wait for the instance to become active

--wait-interval <WAIT_INTERVAL>¶: Interval for checking status

instance¶: ID or name of the target instance.

This command is provided by the otcextensions plugin.

rds instance restore time show¶

Show Database instance recovery timeframe

openstack rds instance restore time show
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    <instance>

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

instance¶: Instance ID or Name

This command is provided by the otcextensions plugin.

rds instance show¶

Show instance details

openstack rds instance show <instance>

instance¶: Instance (name or ID)

This command is provided by the otcextensions plugin.

Backup Operations¶

rds backup create¶

Create Database backup

openstack rds backup create
    [--description <description>]
    [--databases <databases>]
    [--wait]
    [--wait-interval WAIT_INTERVAL]
    <name>
    <instance>

--description <description>¶: Description for the backup

--databases <databases>¶: Specifies a CSV list of self-built SQL Serverdatabases that are partially backed up(Only SQL Server support partial backups.)

--wait¶: Wait for the instance to become active

--wait-interval <WAIT_INTERVAL>¶: Interval for checking status

name¶: Name for the backup

instance¶: ID or Name of the instance to create backup from

This command is provided by the otcextensions plugin.

rds backup delete¶

Delete Backup

openstack rds backup delete <backup_id> [<backup_id> ...]

backup_id¶: ID of the backup

This command is provided by the otcextensions plugin.

rds backup download links¶

List Backup Download Links

openstack rds backup download links
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    <backup_id>

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

backup_id¶: ID of the backup

This command is provided by the otcextensions plugin.

rds backup list¶

List database backups

openstack rds backup list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--backup-id <backup_id>]
    [--backup-type {auto,manual,fragment,incremental}]
    [--offset <offset>]
    [--limit <limit>]
    [--begin-time <begin_time>]
    [--end-time <end_time>]
    <instance>

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--backup-id <backup_id>¶: Specify the backup ID.

--backup-type {auto,manual,fragment,incremental}¶: Specify the backup type.

--offset <offset>¶: Specify the index position.

--limit <limit>¶: Specify the limit of resources to be queried.

--begin-time <begin_time>¶: Specify the start time for obtaining the backup list.

--end-time <end_time>¶: Specify the end time for obtaining the backup list.

instance¶: Specify instance ID or Name to get backup list

This command is provided by the otcextensions plugin.

Configuration Operations¶

rds configuration apply¶

Apply Configuration to the instance(s)

openstack rds configuration apply
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    --instance <instance_id>
    <configuration>

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--instance <instance_id>¶: ID of the instance the configuration should be applied to. (repeat option to apply to multiple instances).

configuration¶: Configuration name or id

This command is provided by the otcextensions plugin.

rds configuration create¶

Create new Configuration

openstack rds configuration create
    [--description <description>]
    --datastore-type
    {mysql,postgresql,sqlserver}
    --datastore-version <datastore_version>
    [--value <key=value>]
    <name>

--description <description>¶: Parameter group description

--datastore-type {mysql,postgresql,sqlserver}¶: Datastore type

--datastore-version <datastore_version>¶: Datastore version

--value <key=value>¶: Configuration value(repeat option to set multiple values)

name¶: Parameter group name

This command is provided by the otcextensions plugin.

rds configuration delete¶

Delete a configuration

openstack rds configuration delete
    <configuration>
    [<configuration> ...]

configuration¶: ID or name of the configuration group

This command is provided by the otcextensions plugin.

rds configuration list¶

List Configurations

openstack rds configuration list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

This command is provided by the otcextensions plugin.

rds configuration parameter list¶

List Configuration parameters

openstack rds configuration parameter list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    <configuration>

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

configuration¶: ID or name of the configuration

This command is provided by the otcextensions plugin.

rds configuration set¶

Set values of the Configuration

openstack rds configuration set
    [--name <name>]
    [--description <description>]
    --value <key
    =value>
    <configuration>

--name <name>¶: New Configuration name

--description <description>¶: New Configuration description

--value <key=value>¶: Configuration value(repeat option to set multiple values).

configuration¶: Configuration id

This command is provided by the otcextensions plugin.

rds configuration show¶

Show details of a database configuration

openstack rds configuration show <configuration>

configuration¶: ID or name of the configuration

This command is provided by the otcextensions plugin.

last updated: 2023-08-18 10:18