Show Backup

Shows information about one or more backups accessible via the data source specified by input parameter datasource_name.

Input Parameter Description

Name

Type

Description

backup_name

string

Name of the backup. An empty string or '*' will show all existing backups. Any text followed by a '*' will show backups whose name starts with that text. The default value is ''.

datasource_name

string

Data source through which the backup is accessible.

options

map of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)

Parameter Description

backup_id

ID of the snapshot to show. Leave empty to show information from the most recent snapshot in the backup. The default value is ''.

show_contents

Show the contents of the backed-up snapshots. The default value is none.

Supported Values	Description
none	Don't show snapshot contents.
object_names	Show backed-up object names, and for tables, sizing detail.
object_files	Show backed-up object names, and for tables, sizing detail and associated files.

no_error_if_not_exists

Whether or not to suppress the error if the specified backup does not exist. The default value is false. The supported values are:

true
false

Output Parameter Description

Name	Type	Description
backup_name	string	Value of input parameter backup_name.
backup_description	array of maps of string to strings	Details about the overall backup(s).
backup_ids	array of maps of string to strings	Details about the individual snapshots contained within the backup(s).
backup_contents	array of maps of string to strings	When show_contents is object_names, the names of the backed-up objects as well as sizing detail of any backed-up tables; when object_files, the names of the backed-up objects as well as sizing detail and associated data files of any backed-up tables.
deleted_backup_ids	array of maps of string to strings	IDs of any snapshots that have been deleted from the containing backup(s).
info	map of string to strings	Additional information.