Skip to main content

List EC2 instance backups​

Returns a list of EC2 instances that have been backed up by Clumio. EC2 instance backups can be restored through the POST /restores/aws/ec2-instances 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 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
    instance_id$eqThe ID of the instance backup. For example, ?filter={"instance_id":{"$eq":"d0ba78cc-582b-11ea-9bdc-82f798bd42fe"}}
    start_timestamp$lte, $gtThe 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

Success

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-ec2-instance 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.

  • ami object

    An Amazon Machine Image is a supported and maintained image provided by AWS that provides the information required to launch an instance.

  • ami_native_id string

    The AWS-assigned ID of the AMI.

  • architecture string

    The architecture of the AMI. Possible values include 'i386', 'x86_64', and 'arm64'.

  • has_ena_support boolean

    Specifies whether enhanced networking with ENA is enabled.

  • hypervisor_type string

    The hypervisor type of the AMI. Possible values include 'ovm' and 'xen'.

  • image_type string

    Type of Image (machine | kernel | ramdisk ).

  • is_public boolean

    A Boolean that indicates whether the image is public.

  • name string

    The name of the AMI.

  • number_of_ebs_volumes int64

    Number of ebs volumes.

  • number_of_ephemeral_volumes int64

    Number of ephemeral volumes.

  • owner_id string

    The ID of the Amazon Web Services account that owns the image.

  • platform string

    The platform of the AMI. Possible values include "windows" and "linux".

  • root_device_name string

    Possible values: [/dev/xvda, /dev/sda1]

    The name of the root device used by the AMI.

  • root_device_type string

    Possible values: [ebs, instance-store]

    The type of root device used by the AMI.

  • sriov_net_support string

    A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.

  • virtualization_type string

    The type of virtualization of the AMI. Possible values include 'hvm' and 'paravirtual.'

  • attached_backup_ebs_volumes object[]

    The EBS volumes attached to the instance.

  • id string

    The Clumio-assigned id for the volume.

  • is_root boolean

    Determines whether this device is the root for the instance.

  • kms_key_native_id string

    The AWS-assigned id of the KMS key used for encryption of the volume.

  • name string

    The device name for the EBS volume. For example, '/dev/xvda'.

  • size int64

    The size of the EBS volume. Measured in bytes (B).

  • status string

    The status of the EBS volume. Possible values include 'attaching', 'attached', 'detaching', 'detached'.

  • tags object[]

    The AWS tags applied to the EBS volume.

  • key string

    The AWS-assigned tag key.

  • value string

    The AWS-assigned tag value.

  • type string

    The type of the volume. Possible values include 'gp2', 'io1', 'st1', 'sc1', and 'standard'.

  • utilized_size_in_bytes uint64

    The number of bytes written in the EBS volume.

  • volume_native_id string

    The AWS-assigned ID of the EBS volume.

  • aws_az string

    The availability zone of the instance.

  • aws_region string

    The AWS region in which the instance backup resides. For example, us-west-2.

  • backup_ami object

    An Amazon Machine Image is a supported and maintained image provided by AWS that provides the information required to launch an instance.

  • ami_native_id string

    The AWS-assigned ID of the AMI.

  • architecture string

    The architecture of the AMI. Possible values include 'i386', 'x86_64', and 'arm64'.

  • has_ena_support boolean

    Specifies whether enhanced networking with ENA is enabled.

  • hypervisor_type string

    The hypervisor type of the AMI. Possible values include 'ovm' and 'xen'.

  • image_type string

    Type of Image (machine | kernel | ramdisk ).

  • is_public boolean

    A Boolean that indicates whether the image is public.

  • name string

    The name of the AMI.

  • number_of_ebs_volumes int64

    Number of ebs volumes.

  • number_of_ephemeral_volumes int64

    Number of ephemeral volumes.

  • owner_id string

    The ID of the Amazon Web Services account that owns the image.

  • platform string

    The platform of the AMI. Possible values include "windows" and "linux".

  • root_device_name string

    Possible values: [/dev/xvda, /dev/sda1]

    The name of the root device used by the AMI.

  • root_device_type string

    Possible values: [ebs, instance-store]

    The type of root device used by the AMI.

  • sriov_net_support string

    A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.

  • virtualization_type string

    The type of virtualization of the AMI. Possible values include 'hvm' and 'paravirtual.'

  • backup_tier string

    The tier to which the backup is tagged to.

  • browsing_failed_reason string

    Possible values: [file_limit_exceeded, browsing_unavailable]

    The reason that browsing is unavailable for the backup. 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.

  • iam_instance_profile object

    Denotes an IAM instance profile. An instance profile is a container for an IAM role that you can use to pass role information to an EC2 instance when the instance starts.

  • arn string

    The Amazon Resource Name (ARN) specifying the IAM instance profile.

  • name string

    The AWS-assigned name of the IAM instance profile.

  • native_id string

    The AWS-assigned ID of the IAM instance profile.

  • id string

    The Clumio-assigned ID of the instance backup.

  • instance_id string

    The Clumio-assigned ID of the EC2 instance associated with the instance backup.

  • instance_native_id string

    The AWS-assigned ID of the EC2 instance associated with the instance backup.

  • instance_store_block_device_mappings object[]

    The InstanceStore volumes attached to the instance.

  • encryption string

    Encryption for the instance store volume. Possible values include 'hardware encrypted' and 'Not encrypted'.

  • is_nvme boolean

    Determines whether or not the volume is a NVME instance store volume or a non-NVME instance store volume.

  • name string

    The device name for the instance store volume. For example, '/dev/sdb'.

  • size int64

    The size of the instance store volume. Measured in bytes (B).

  • type string

    The type of the block device. Only possible value is "Instance Store".

  • virtual_name string

    The AWS-assigned name of the instance store volume.

  • instance_type string

    The instance type of the original EC2 instance before backup. For example, m5.large.

  • is_browsable boolean

    Determines whether browsing is available for the backup. If true, then browsing is available for the backup.

  • key_pair_name string

    The name of the key pair associated with this instance. If this instance was not launched with an associated key pair, then this field has a value of null.

  • key_pair_native_id string

    The ID of the key pair associated with this instance. If this instance was not launched with an associated key pair, then 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.

  • network_interfaces object[]

    The network interfaces attached to the instance.

  • device_index int64

    The device index for the network interface.

  • network_interface_native_id string

    The AWS-assigned ID for the network interface.

  • public_ip string

    The public IP v4 address of the network interface if one was assigned.

  • security_group_native_ids string[]

    The AWS-assigned IDs for the security groups associated with this network interface.

  • subnet_native_id string

    The subnet native ID for the network interface.

  • virtual_name string

    The AWS-assigned name of the network interface. For example, eth0.

  • public_ip_address string

    The public IP v4 address of the instance if one was assigned.

  • size int64

    The size of the instance backup. This is the sum of all the EBS volumes attached to the EC2 measured in gigabytes (GB).

  • start_timestamp string

    The timestamp of when this backup started. Represented in RFC-3339 format.

  • subnet_native_id string

    The AWS-assigned Subnet ID of the EC2 instance.

  • tags object[]

    The instance tags applied to the original EC2 instance before backup.

  • key string

    The AWS-assigned tag key.

  • value string

    The AWS-assigned tag value.

  • type string

    Possible values: [clumio_backup, aws_snapshot]

    The type of the backup.

  • utilized_size_in_bytes uint64

    The total number of bytes written in all the disks of the EC2 instance.

  • vpc_native_id string

    The AWS-assigned ID of the VPC associated with the EC2 instance.

  • _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.

Loading...