Skip to main content

Restore an EC2 Microsoft SQL database​

Restores an EC2 MSSQL database from a given backup or to a specified point in time.

Query Parameters
  • embed string

    Embeds the details of each associated resource. Set the parameter to one of the following embeddable links to include additional details associated with the resource.

    Embeddable LinkDescription
    read-taskEmbeds the associated task in the response. For example, ?embed=read-task
    For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.
Request Body required
  • source object required

    The EC2 MSSQL database backup to be restored. Only one of backup or pitr should be set. pitr A database backup at a specific point in time to be restored.

  • backup object

    The EC2 MSSQL database backup to be restored.

  • backup_id string required

    The Clumio-assigned ID of the backup to be restored. Use the GET /backups/aws/ec2-mssql/databases endpoint to fetch valid values.

  • pitr object

    A database backup at a specific point-in-time to be restored.

  • database_id string required

    The Clumio-assigned ID of the MSSQL database to be restored. Use the GET /datasources/aws/ec2-mssql/databases endpoint to fetch valid values.

  • restore_to_latest boolean

    If enabled, performs PITR till the latest possible time. Either timestamp or restore_to_latest must be provided, but not both.

  • timestamp string

    The point in time to be restored in RFC-3339 format. Either timestamp or restore_to_latest must be provided, but not both.

  • restore_to_aag object

    An AG database to be restored to an AAG.

  • database_id string required

    The Clumio-assigned ID of the MSSQL database to be restored. Use the GET /datasources/aws/ec2-mssql/databases endpoint to fetch valid values.

  • target object required

    The configuration of the EC2 MSSQL database to which the data has to be restored.

  • data_files_path string

    The target location within the instance to restore data files. For example, C:\\Programe Files\clumio\restored-data-files\. If this field is empty, we will restore data files into the same location as the source database.

  • database_name string required

    The user-assigned name of the database.

  • final_database_state string

    Final database state after clumio restored the database. If final_database_state is set to empty then clumio will make database in online state. Possible vales are RESTORING or ONLINE

  • instance_id string required

    The Clumio-assigned ID of the instance to restore the database into. Use the GET /datasources/aws/ec2-mssql/instances to fetch valid values.

  • log_files_path string

    The target location within the instance to restore log files. For example, C:\\Programe Files\clumio\restored-log-files\. If this field is empty, we will restore log files into the same location as the source database.

  • restore_as_new_database boolean

    The boolean value representing if the database has to be restored as new database.

Responses

Success

Schema
  • _embedded object

    Embedded responses related to the resource.

  • read-task Embeds the associated task of a resource in the response if requested using the `embed` query parameter.

    Embeds the associated task of a resource in the response if requested using the embed query parameter.

  • _links object

    URLs to pages related to the resource.

  • _self object

    The HATEOAS link to this resource.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • read-task object

    A HATEOAS link to the task associated with this resource.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • task_id string

    The Clumio-assigned ID of the task created by this restore request. The progress of the task can be monitored using the GET /tasks/{task_id} endpoint.

Loading...