List EBS volume backups

Returns a list of EBS volumes that have been backed up by Clumio. EBS volume backups can be restored through the POST /restores/aws/ebs-volumes endpoint.

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
volume_id	$eq	The ID of the volume backup. For example, `?filter={"volume_id":{"$eq":"d0ba78cc-582b-11ea-9bdc-82f798bd42fe"}}`
start_timestamp	$lte, $gt	The timestamp value of when the backup started. Represented in RFC-3339 format. For example, `?filter={"start_timestamp":{"$lte":"1985-04-12T23:20:50Z"}}`

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

Responses

200
default

Success

application/api.clumio.backup-aws-ebs-volumes=v2+json

Schema
Example (from schema)

Schema

_embedded object
Embedded responses related to the resource.
items object[]
A collection of requested items.
_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.
restore-aws-ebs-volume 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.
account_native_id string
The AWS-assigned ID of the account associated with the backup.
aws_az string
The availability zone associated with the volume backup. For example, us-west-2a.
aws_region string
The AWS region in which the volume backup resides. For example, us-west-2.
backup_tier string
Backup Tier
browsing_failed_reason string
The reason that browsing is unavailable for the backup. Possible values include "file_limit_exceeded" and "browsing_unavailable". If browse indexing is successful, then this field has a value of null.
expiration_timestamp string
The timestamp of when this backup expires. Represented in RFC-3339 format.
id string
The Clumio-assigned ID of the volume backup.
iops int64
Iops of the volume.
is_browsable boolean
Determines whether browsing is available for the backup. If true, then browsing is available for the backup.
is_encrypted boolean
Determines whether the EBS volume backup is encrypted. If true, the volume backup is encrypted.
kms_key_native_id string
The AWS-assigned ID of the KMS key encrypting this EBS volume backup. If the volume is not encrypted, this field has a value of null.
migration_timestamp string
The timestamp of when the migration was triggered. This field will be set only for migration backups. Represented in RFC-3339 format.
size int64
The size of the volume backup. Measured in gigabytes (GB).
start_timestamp string
The timestamp of when this backup started. Represented in RFC-3339 format.
tags object[]
The volume tags applied to the original EBS volume before backup.
key string
The AWS-assigned tag key.
value string
The AWS-assigned tag value.
type string
The type of the backup. Possible values - clumio_backup, aws_snapshot.
utilized_size_in_bytes uint64
Utilized size
volume_id string
The Clumio-assigned ID of the EBS volume associated with the volume backup.
volume_native_id string
The AWS-assigned ID of the EBS volume associated with the volume backup.
volume_type string
The volume type of the original EBS volume before backup. Possible values include gp2, io1, st1, sc1, standard.
_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": [
      {
        "_links": {
          "_self": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "restore-aws-ebs-volume": {
            "href": "string",
            "templated": true,
            "type": "string"
          }
        },
        "account_native_id": "string",
        "aws_az": "string",
        "aws_region": "string",
        "backup_tier": "string",
        "browsing_failed_reason": "string",
        "expiration_timestamp": "string",
        "id": "string",
        "iops": 0,
        "is_browsable": true,
        "is_encrypted": true,
        "kms_key_native_id": "string",
        "migration_timestamp": "string",
        "size": 0,
        "start_timestamp": "string",
        "tags": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "type": "string",
        "utilized_size_in_bytes": 0,
        "volume_id": "string",
        "volume_native_id": "string",
        "volume_type": "string"
      }
    ]
  },
  "_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 EBS volume backups​

List EBS volume backups