describe-backup¶

Description¶

Describe a backup using the associated backup ID.

Synopsis¶

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

Options¶

--backup-id (integer)

The ID of the backup to describe.

--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)

Service backup object.

id -> (integer)

Backup ID.

serviceID -> (string)

Service ID of a backed-up CDE service.

serviceName -> (string)

Name of a backed-up CDE service.

serviceVersion -> (string)

Version of a backed-up CDE service.

environmentName -> (string)

Name of CDP environment with which a backed-up CDE service was associated.

environmentCrn -> (string)

CRN of CDP environment with which a backed-up CDE service was associated.

creator -> (string)

The workload name of the user who created this backup.

creatorCrn -> (string)

CRN of of the user who created this backup.

cloudPlatform -> (string)

The cloud platform where a backed-up CDE service was enabled.

status -> (string)

Backup status.

created -> (string)

The time when the backup was created.

description -> (string)

Backup description.

errorMessage -> (string)

Error message, only set when there is an error.

archiveBasePath -> (string)

The path to the base location where the backups are stored.

archiveLocation -> (string)

Archive location under the base path.

Form Factors¶

public, private