Retrieve an EBS volume backup
Returns a representation of the specified EBS volume 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-ebs-volumes=v2+json
- Schema
- Example (from schema)
Schema
_links object
URLs to pages related to the resource.
_self object
The HATEOAS link to this resource.
href stringThe URI for the referenced operation.
templated booleanDetermines whether the "href" link is a URI template. If set to
true
, the "href" link is a URI template.type stringThe HTTP method to be used with the "href" link for the referenced operation.
restore-aws-ebs-volume object
A resource-specific HATEOAS link.
href stringThe URI for the referenced operation.
templated booleanDetermines whether the "href" link is a URI template. If set to
true
, the "href" link is a URI template.type stringThe 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 stringThe AWS-assigned tag key.
value stringThe 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": {
"_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"
}
Error
- application/json
- Schema
- Example (from schema)
Schema
errors object[]
A list of errors encountered during runtime.
error_code uint32error_message stringThe reason for the error.
{
"errors": [
{
"error_code": 0,
"error_message": "string"
}
]
}