/show/backup

URL: http://<db.host>:<db.port>/show/backup

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

Input Parameter Description

Name

Type

Description

backup_name

string

Name of the backup object. An empty string or '*' will return all existing backups. The default value is ''.

datasource_name

string

Datasource where backup is located.

options

map of string to strings

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

Supported Parameters (keys)

Parameter Description

backup_id

Backup instance ID to show. Leave empty to show information from the most recent backup instance in the container. The default value is ''.

show_contents

Shows the contents of the specified backup_id The default value is none.

Supported Values	Description
none	No backup contents
object_names	Object names only
object_files	Object names and files

no_error_if_not_exists

If false will return an error if the provided input parameter backup_name does not exist. If true then it will return an empty result. The default value is false. The supported values are:

true
false

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

Name

Type

Description

status

String

'OK' or 'ERROR'

message

String

Empty if success or an error message

data_type

String

'show_backup_response' or 'none' in case of an error

data

String

Empty string

data_str

JSON or String

This embedded JSON represents the result of the /show/backup endpoint:

Name	Type	Description
backup_name	string	Value of input parameter backup_name.
backup_description	array of maps of string to strings	Backup description
backup_ids	array of maps of string to strings	Backup instances in this backup
backup_contents	array of maps of string to strings	Backup contents
deleted_backup_ids	array of maps of string to strings	Backup instances that have been deleted from this backup object
info	map of string to strings	Additional information.

Empty string in case of an error.