AWS
EBS
Retrieve an EBS volume backupget

Retrieve an EBS volume backup

get https://{region}.api.clumio.com/backups/aws/ebs-volumes/{backup_id}-v2

Returns a representation of the specified EBS volume backup.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

_links

object

URLs to pages related to the resource.

_self

object

The HATEOAS link to this resource.

restore-aws-ebs-volume

object

A resource-specific HATEOAS link.

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

required

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

string

required

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

required

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

tags

object

key

string

required

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

required

The Clumio-assigned ID of the EBS volume associated with the volume backup.

volume_native_id

string

required

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.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://us-west-2.api.clumio.com/backups/aws/ebs-volumes/backup_id-v2 \
3
     --header 'accept: application/api.clumio.backup-aws-ebs-volumes=v2+json'


xxxxxxxxxx
39
}
1
{
2
  "_links": {
3
    "_self": {
4
      "href": "string",
5
      "templated": true,
6
      "type": "string"
7
    },
8
    "restore-aws-ebs-volume": {
9
      "href": "string",
10
      "templated": true,
11
      "type": "string"
12
    }
13
  },
14
  "account_native_id": "string",
15
  "aws_az": "string",
16
  "aws_region": "string",
17
  "backup_tier": "string",
18
  "browsing_failed_reason": "string",
19
  "expiration_timestamp": "string",
20
  "id": "string",
21
  "iops": 0,
22
  "is_browsable": true,
23
  "is_encrypted": true,
24
  "kms_key_native_id": "string",
25
  "migration_timestamp": "string",

200200 HTTP success response

defaultError