describe-backup¶

Description¶

Returns the description of an existing data warehouse backup.

Synopsis¶

  describe-backup
--backup-crn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--backup-crn (string)

The CRN of the backup.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

backup -> (object)

Backup entry

Form Factors: private

backupCrn -> (string)

The CRN of the backup.

backupCreationTime -> (string)

The time when the backup was created.

backupName -> (string)

The display name of the backup.

backupUpdatedTime -> (string)

The time when the backup was updated.

backupPhase -> (string)

The phase of the backup operation.

backupJobState -> (string)

The current state of the backup job.

backupJob -> (string)

The backup job name.

includedNamespaces -> (array)

The list of namespaces to be included in backup.

item -> (string)

warnings -> (array)

The warnings from backup job.

item -> (object)

The message object used to display warnings and errors during DRS workflows

Form Factors: private

text -> (string)

The text message of the warning/error.

timestamp -> (string)

The time when the warning/error is hit.

namespace -> (string)

The namespace that has the warning/error.

errors -> (array)

The errors from backup job.

item -> (object)

The message object used to display warnings and errors during DRS workflows

Form Factors: private

text -> (string)

The text message of the warning/error.

timestamp -> (string)

The time when the warning/error is hit.

namespace -> (string)

The namespace that has the warning/error.

Form Factors¶

private