List EC2 MSSQL Database Backups

Retrieve a list of EC2 MSSQL database backups.

Query Parameters

limit int64
Limits the size of the response on each page to the specified number of items.
start string
Sets the page number used to browse the collection. Pages are indexed starting from 1 (i.e., ?start=1).
sort string
Returns the list of backups in the order specified. Set sort to the name of the sort field by which to sort in ascending order. To sort the list in reverse order, prefix the field name with a minus sign (-). Only one field may be sorted at a time.

The following table lists the supported sort fields for this resource:

Sort Field Description
start_timestamp Sorts the backups in ascending timestamp order (oldest first). For example, ?sort=start_timestamp
If a sort order is not specified, the individual rules are sorted by "start_timestamp" in descending timestamp order (newest first).

Sort Field	Description
start_timestamp	Sorts the backups in ascending timestamp order (oldest first). For example, `?sort=start_timestamp`

filter string

Narrows down the results to only the items that satisfy the filter criteria. The following table lists the supported filter fields for this resource and the filter conditions that can be applied on those fields:

Field	Filter Condition	Description
database_id	$eq	Filter database backups whose database ID equal the specified string.
start_timestamp	$lte, $gt	Filter database backups whose start timestamp is "less than or equal to" or "greater than" a given timestamp.
type	$in	Filter a particular type of database backups. Possible values include `ec2_mssql_database_backup`, `ec2_mssql_log_backup_full_recovery_model` and `ec2_mssql_log_backup_bulk_logged_model`.

For more information about filtering, refer to the Filtering section of this guide.

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

Embeddable Link Description
read-aws-environment Embeds the associated AWS Environment details in the response. For example, ?embed=read-aws-environment
For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.

Embeddable Link	Description
read-aws-environment	Embeds the associated AWS Environment details in the response. For example, `?embed=read-aws-environment`

Responses

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.
items object[]
A collection of requested items.
_embedded object
Embedded responses related to the resource.
read-aws-environment
Embed information for AWS Environment details
_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-aws-environment object
A resource-specific HATEOAS link.
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.
restore-ec2-mssql-database object
A resource-specific HATEOAS link.
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.
database_files object[]
List of database files at the time of backup.
name string
The name of the database file.
type string
The 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.
_links object
URLs to pages related to the resource.
_first object
The HATEOAS link to the first page of results.
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.
_last object
The HATEOAS link to the last page of results.
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.
_next object
The HATEOAS link to the next page of results.
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.
_prev object
The HATEOAS link to the previous page of results.
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.
_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.
current_count int64
The number of items listed on the current page.
filter_applied string
The filter used in the request. The filter includes both manually-specified and system-generated filters.
limit int64
The maximum number of items displayed per page in the response.
start string
The page number used to get this response. Pages are indexed starting from 1 (i.e., "start": "1").
total_count int64
The total number of items, summed across all pages.
total_pages_count int64
The total number of pages of results.

{
  "_embedded": {
    "items": [
      {
        "_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"
      }
    ]
  },
  "_links": {
    "_first": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_last": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_next": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_prev": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "current_count": 0,
  "filter_applied": "string",
  "limit": 0,
  "start": "string",
  "total_count": 0,
  "total_pages_count": 0
}

Error

application/json

Schema
Example (from schema)

Schema

errors object[]
A list of errors encountered during runtime.
error_code uint32
error_message string
The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

List EC2 MSSQL Database Backups​

List EC2 MSSQL Database Backups