describe-workspace-backup¶

Description¶

Describe backup snaphot of a workbench.

Synopsis¶

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

Options¶

--backup-crn (string)

The CRN of the backup snaphot.

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

backupCrn -> (string)

The CRN of the backup snaphot.

backupName -> (string)

The name of the backup snapshot.

createdAt -> (datetime)

The creation time of the backup snapshot.

creatorCrn -> (string)

The CRN of the creator.

workspaceVersionAtBackup -> (string)

The version of the backed-up workbench at the time of backup.

backupStatus -> (string)

The status of the backup.

isCrossNsBackup -> (boolean)

Indicates whether the backup has cross namespace enabled.

instanceGroups -> (array)

The list of instance groups.

item -> (object)

Instance group information to show in workbench details.

instanceType -> (string)

The cloud provider instance type for the node instance.

instanceCount -> (integer)

The initial number of instance node.

instanceGroupName -> (string)

The system-assigned name of the instance group.

minInstances -> (integer)

The minimum number of instances that can be deployed to this instance group. If the value is 0, the group might be empty.

maxInstances -> (integer)

The maximum number of instances that can be deployed to this instance group.

instances -> (array)

Instances in the instance group.

item -> (object)

Represents each instance in an instance group.

instanceId -> (string)

Unique instance Id generated by the cloud provider.

availabilityZone -> (string)

Availability zone the instance belongs to.

tags -> (array)

Tags are key/value pairs that are applied to all tag-able resources deployed in the workbench’s cloud environment.

item -> (object)

Contains a single tag entry associated with a workbench.

key -> (string)

The name for the tag.

value -> (string)

The value for the tag.

cpu -> (string)

Number of CPUs attached to this instance type.

gpu -> (string)

Number of GPUs attached to this instance type.

memory -> (string)

Memory in GiB attached to this instance type.

rootVolumeSize -> (integer)

Root volume size in GiB attached to this instance type.

name -> (string)

The unique name for the instance or resource group of the workbench.

Form Factors¶

public, private