Retrieve an EC2 MSSQL database backup
Returns a representation of the specified EC2 MSSQL database backup.
Path Parameters
- backup_id string required
Performs the operation on the backup with the specified ID. Use the GET /backups/aws/ec2-mssql/databases endpoint to fetch valid values.
- 200
- default
Success
- application/api.clumio.backup-ec2-mssql-databases=v1+json
- Schema
- Example (from schema)
Schema
_embedded object
Embedded responses related to the resource.
read-aws-environmentEmbed information for AWS Environment details
_links object
URLs to pages related to the resource.
_self object
The HATEOAS link to this resource.
href stringThe URI for the referenced operation.
templated booleanDetermines whether the "href" link is a URI template. If set to
true
, the "href" link is a URI template.type stringThe HTTP method to be used with the "href" link for the referenced operation.
read-aws-environment object
A resource-specific HATEOAS link.
href stringThe URI for the referenced operation.
templated booleanDetermines whether the "href" link is a URI template. If set to
true
, the "href" link is a URI template.type stringThe HTTP method to be used with the "href" link for the referenced operation.
restore-ec2-mssql-database object
A resource-specific HATEOAS link.
href stringThe URI for the referenced operation.
templated booleanDetermines whether the "href" link is a URI template. If set to
true
, the "href" link is a URI template.type stringThe HTTP method to be used with the "href" link for the referenced operation.
database_files object[]
List of database files at the time of backup.
name stringThe name of the database file.
type stringThe type of the database file. Possible values include sql_row_file and sql_log_file.
- database_id string
The Clumio-assigned ID of the database associated with this backup.
- engine string
The Microsoft SQL database engine at the time of backup.
- engine_version string
The Microsoft SQL database engine version at the time of backup.
- environment_id string
The Clumio-assigned ID of the AWS environment associated with the database at the time of backup.
- expiration_timestamp string
The timestamp of when this backup expires. Represented in RFC-3339 format.
- host_endpoint string
The user-provided endpoint of the host containing the given database at the time of backup.
- host_id string
The Clumio-assigned ID of the host associated with the database at the time of backup.
- id string
The Clumio-assigned ID of the backup.
- instance_id string
The Clumio-assigned instance id at the time of backup.
- instance_name string
The instance name at the time of backup.
- start_timestamp string
The timestamp of when this backup started. Represented in RFC-3339 format.
- type string
Possible values: [
mssql_database_backup
,mssql_log_backup_full_recovery_model
,mssql_log_backup_bulk_logged_model
]The type of backup.
{
"_embedded": {},
"_links": {
"_self": {
"href": "string",
"templated": true,
"type": "string"
},
"read-aws-environment": {
"href": "string",
"templated": true,
"type": "string"
},
"restore-ec2-mssql-database": {
"href": "string",
"templated": true,
"type": "string"
}
},
"database_files": [
{
"name": "string",
"type": "string"
}
],
"database_id": "string",
"engine": "string",
"engine_version": "string",
"environment_id": "string",
"expiration_timestamp": "string",
"host_endpoint": "string",
"host_id": "string",
"id": "string",
"instance_id": "string",
"instance_name": "string",
"start_timestamp": "string",
"type": "mssql_database_backup"
}
Error
- application/json
- Schema
- Example (from schema)
Schema
errors object[]
A list of errors encountered during runtime.
error_code uint32error_message stringThe reason for the error.
{
"errors": [
{
"error_code": 0,
"error_message": "string"
}
]
}