Retrieve an EC2 instance backup
Returns a representation of the specified EC2 instance backup.
Path Parameters
- backup_id string required
Performs the operation on the backup with the specified ID.
- 200
- default
Success
- application/api.clumio.backup-aws-ec2-instances=v1+json
- Schema
- Example (from schema)
Schema
_links object
- account_native_id string
The AWS-assigned ID of the account associated with the backup.
ami object
attached_backup_ebs_volumes object[]
- 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
- 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
- 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[]
- 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[]
- 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[]
- 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": {
"_self": {
"href": "string",
"templated": true,
"type": "string"
},
"restore-aws-ec2-instance": {
"href": "string",
"templated": true,
"type": "string"
}
},
"account_native_id": "string",
"ami": {
"ami_native_id": "string",
"architecture": "string",
"has_ena_support": true,
"hypervisor_type": "string",
"image_type": "string",
"is_public": true,
"name": "string",
"number_of_ebs_volumes": 0,
"number_of_ephemeral_volumes": 0,
"owner_id": "string",
"platform": "string",
"root_device_name": "/dev/xvda",
"root_device_type": "ebs",
"sriov_net_support": "string",
"virtualization_type": "string"
},
"attached_backup_ebs_volumes": [
{
"id": "string",
"is_root": true,
"kms_key_native_id": "string",
"name": "string",
"size": 0,
"status": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"type": "string",
"utilized_size_in_bytes": 0,
"volume_native_id": "string"
}
],
"aws_az": "string",
"aws_region": "string",
"backup_ami": {
"ami_native_id": "string",
"architecture": "string",
"has_ena_support": true,
"hypervisor_type": "string",
"image_type": "string",
"is_public": true,
"name": "string",
"number_of_ebs_volumes": 0,
"number_of_ephemeral_volumes": 0,
"owner_id": "string",
"platform": "string",
"root_device_name": "/dev/xvda",
"root_device_type": "ebs",
"sriov_net_support": "string",
"virtualization_type": "string"
},
"backup_tier": "string",
"browsing_failed_reason": "file_limit_exceeded",
"expiration_timestamp": "string",
"iam_instance_profile": {
"arn": "string",
"name": "string",
"native_id": "string"
},
"id": "string",
"instance_id": "string",
"instance_native_id": "string",
"instance_store_block_device_mappings": [
{
"encryption": "string",
"is_nvme": true,
"name": "string",
"size": 0,
"type": "string",
"virtual_name": "string"
}
],
"instance_type": "string",
"is_browsable": true,
"key_pair_name": "string",
"key_pair_native_id": "string",
"migration_timestamp": "string",
"network_interfaces": [
{
"device_index": 0,
"network_interface_native_id": "string",
"public_ip": "string",
"security_group_native_ids": [
"string"
],
"subnet_native_id": "string",
"virtual_name": "string"
}
],
"public_ip_address": "string",
"size": 0,
"start_timestamp": "string",
"subnet_native_id": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"type": "clumio_backup",
"utilized_size_in_bytes": 0,
"vpc_native_id": "string"
}
Error
- application/json
- Schema
- Example (from schema)
Schema
errors object[]
{
"errors": [
{
"error_code": 0,
"error_message": "string"
}
]
}
GET /backups/aws/ec2-instances/:backup_id
Authorization
Request
Request
curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/ec2-instances/:backup_id' \
-H 'Accept: application/api.clumio.backup-aws-ec2-instances=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/ec2-instances/:backup_id' \
-H 'Accept: application/api.clumio.backup-aws-ec2-instances=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/ec2-instances/:backup_id' \
-H 'Accept: application/api.clumio.backup-aws-ec2-instances=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/ec2-instances/:backup_id' \
-H 'Accept: application/api.clumio.backup-aws-ec2-instances=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/ec2-instances/:backup_id' \
-H 'Accept: application/api.clumio.backup-aws-ec2-instances=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/ec2-instances/:backup_id' \
-H 'Accept: application/api.clumio.backup-aws-ec2-instances=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/ec2-instances/:backup_id' \
-H 'Accept: application/api.clumio.backup-aws-ec2-instances=v1+json' \
-H 'Authorization: Bearer <TOKEN>'