Show Backup

Shows information about a backup Returns detailed information about one or more backup instances.

Input Parameter Description

NameTypeDescription
backup_namestringName of the backup object, which must refer to a currently existing backup. The default value is ''.
datasource_namestringDatasource where backup is located.
optionsmap of string to strings

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

Supported Parameters (keys)Parameter Description
backup_idBackup instance ID to show. Leave empty to show information from the most recent backup instance in the container. The default value is ''.
show_files

If true, returns the contents of the specified backup_id The default value is false. The supported values are:

  • true
  • false
validate

Checks the backup for completeness The default value is false. The supported values are:

  • true
  • false

Output Parameter Description

NameTypeDescription
backup_descriptionmap of string to stringsBackup description
backup_idsmap of string to stringsBackup instances in this backup
backup_contentsmap of string to stringsBackup contents
deleted_backup_idsmap of string to stringsBackup instances that have been deleted from this backup object
infomap of string to stringsAdditional information.