Managing Cloud Databases backups

Restoring a backup in the UI

To restore a backup to a new service instance,

1. Click in the corresponding row to expand the options for the backup that you want to restore.
2. Click Restore.
3. Use the dialog box to select from some available options.
   • The new instance is automatically named <name>-restore-[timestamp], but you can rename it.
   • You can also select the region where the new instance is located. Cross-region restores are supported, except for restoring into or out of the eu-de region.
   • You can choose the initial resource allocation, either to expand or shrink the resources on the new instance. You can also enable or disable dedicated cores.
4. Click Restore. A "restore from backup started" message appears. Clicking Your new instance is available now. takes you to your Resources List.

Restoring a backup in the CLI

The Resource Controller supports provisioning of database instances, and provisioning and restoring are the responsibility of the Resource Controller CLI. Use the resource service-instance-create command.

ibmcloud resource service-instance-create <SERVICE_INSTANCE_NAME> <service-id> standard <region> -p '{"backup_id":"BACKUP_ID"}'

Change the value of SERVICE_INSTANCE_NAME to the name that you want for your new instance. The service-id is the type of instance, such as databases-for-postgresql or messages-for-rabbitmq. The region is where you want the new instance to be located, which can be a different region from the source instance. Cross-region restores are supported, except for restoring to or from eu-de by using another region. BACKUP_ID is the backup that you want to restore.

Optional parameters are available through the CLI. Use them if you need to customize resources, or use a Key Protect key for BYOK encryption on the new instance.

ibmcloud resource service-instance-create <SERVICE_INSTANCE_NAME> <service-id> standard <region> -p
'{"backup_id":"BACKUP_ID","key_protect_key":"KEY_PROTECT_KEY_CRN", "members_disk_allocation_mb":"DESIRED_DISK_IN_MB", "members_memory_allocation_mb":"DESIRED_MEMORY_IN_MB", "members_cpu_allocation_count":"NUMBER_OF_CORES"}'

A pre-formatted command for a specific backup is available in detailed view of the backup on the Backups tab of your instance's dashboard.

By default, restoring from a backup provisions an instance with the preferred version of the database type, not the version of the instance you restore from. You can specify a version by adding the version in the parameters object, as in the following example.

`ibmcloud resource service-instance-create SERVICE_INSTANCE_NAME databases-for-mysql standard us-south -p '{"backup_id":"<BACKUP_ID>", "version": "<VERSION>"}'

To see a list of versions available, run ibmcloud cdb deployables.

Restoring a backup through the API

The Resource Controller API supports provisioning and restoring database instances. The create request is a POST to the /resource_instances endpoint.

curl -X POST \
  https://resource-controller.cloud.ibm.com/v2/resource_instances \
  -H 'Authorization: Bearer <>' \
  -H 'Content-Type: application/json' \
    -d '{
    "name": "<SERVICE_INSTANCE_NAME>",
    "target": "<region>",
    "resource_group": "<your-resource-group>",
    "resource_plan_id": "<service-id>",
    "parameters":{
      "backup_id": "<backup_id>"
    }
  }'

The parameters name, target, resource_group, and resource_plan_id are all required, and backup_id is the backup that you want to restore.

The target is the region where you want the new instance to be located, which can be a different region from the source instance. Cross-region restores are supported, except for restoring into or out of the eu-de region.

If you need to adjust resources or use a Key Protect key, add any of the optional parameters key_protect_key, members_disk_allocation_mb, members_memory_allocation_mb, and members_cpu_allocation_count, and their preferred values to the body of the request.

By default, restoring from a backup provisions an instance with the preferred version of the database type, not the version of the instance you restore from. You can specify a version by adding the version in the parameters object, as in the following example.

`ibmcloud resource service-instance-create SERVICE_INSTANCE_NAME databases-for-mysql standard us-south -p '{"backup_id":"<BACKUP_ID>", "version": "<VERSION>"}'

To see a list of versions available, run ibmcloud cdb deployables.

Restoring a backup through Terraform

Use Terraform to restore to a backup from an older version to a new version.

1. Set your backup_id. For more information, see backup_id.
2. Set your version in the version attribute. For more information, see version.

The code looks like:

resource "ibm_database" "<your-instance>" {
  name                                 = "<your_database_name>"
  service                              = "<service>"
  plan                                 = "<plan>"
  location                             = "<region>"
  version                              = "<version>"
  backup_id                            = "<backup_id>"
}

For more information, see the Cloud Databases Terraform Registry.