Skip to main content

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 FieldDescription
    start_timestampSorts 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).
  • 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:

    FieldFilter ConditionDescription
    database_id$eqFilter database backups whose database ID equal the specified string.
    start_timestamp$lte, $gtFilter database backups whose start timestamp is "less than or equal to" or "greater than" a given timestamp.
    type$inFilter 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 LinkDescription
    read-aws-environmentEmbeds 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.
Responses

Success

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.

GET /backups/aws/ec2-mssql/databases

Authorization

Request

Click Edit to configure Base URL
https://us-west-2.api.clumio.com
Bearer Token
limit — query
start — query
sort — query
filter — query
embed — query
curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/ec2-mssql/databases' \
-H 'Accept: application/api.clumio.backup-ec2-mssql-databases=v1+json' \
-H 'Authorization: Bearer <TOKEN>'