Retrieve an Iceberg table backup
Returns a representation of the specified Iceberg table 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-iceberg-tables=v1+json
- Schema
- Example (from schema)
Schema
- account_native_id string
The AWS-assigned ID of the account associated with this database at the time of backup.
- aws_region string
The AWS region associated with this environment.
- backup_aws_region string
The region in which this backup is stored. For policies that keep backups in-region, this value will be the same as the source region of the asset backed up. For out of region policies, this region will the one specified in the policy.
- expiration_timestamp string
The timestamp of when this backup expires. Represented in RFC-3339 format.
- id string
The Clumio-assigned ID of the backup.
- newly_added_snapshots int32
The total count of the newly added snapshots in this backup.
- schema string
The schema of the Iceberg table captured in this backup.
- snapshot_created_at string
The timestamp of when the Iceberg snapshot was created. Represented in RFC-3339 format.
- snapshot_id string
The ID of the Iceberg snapshot associated with this backup.
- start_timestamp string
The timestamp of when this backup started. Represented in RFC-3339 format.
summary object
added_records stringThe number of records added in this snapshot.
operation stringThe operation that produced this snapshot. For example, "append" or "overwrite".
total_files_size stringThe total size of the data files in this snapshot. Measured in bytes.
total_records stringThe total number of records in the Iceberg table at this snapshot.
- table_id string
The Clumio-assigned ID of the Iceberg table.
- table_name string
The name of the Iceberg table.
- type string
The record type of this backup. This field is always set to "iceberg_snapshot" or "iceberg_metadata".
{
"account_native_id": "string",
"aws_region": "string",
"backup_aws_region": "string",
"expiration_timestamp": "string",
"id": "string",
"newly_added_snapshots": 0,
"schema": "string",
"snapshot_created_at": "string",
"snapshot_id": "string",
"start_timestamp": "string",
"summary": {
"added_records": "string",
"operation": "string",
"total_files_size": "string",
"total_records": "string"
},
"table_id": "string",
"table_name": "string",
"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"
}
]
}