list-workspaces¶

Description¶

List Cloudera AI workbenches.

Synopsis¶

  list-workspaces
[--query-options <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--query-options (array)

Additional query options.

Syntax:

"string" "string" ...

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

workspaces -> (array)

The list of workbenches.

item -> (object)

A Cloudera AI workbench which includes the deployed configuration details.

instanceName -> (string)

The name of the workbench.

environmentName -> (string)

The name of the workbench’s environment.

instanceStatus -> (string)

The workbench’s current status.

instanceUrl -> (string)

URL of the workbench’s user interface.

environmentCrn -> (string)

CRN of the environment.

crn -> (string)

The CRN of the workbench.

k8sClusterName -> (string)

The Kubernetes cluster name.

creatorCrn -> (string)

The CRN of the creator of the workbench.

version -> (string)

The version of Cloudera AI that was installed on the workbench.

httpsEnabled -> (boolean)

Indicates if HTTPs communication was enabled on this workbench when provisioned.

filesystemID -> (string)

A filesystem ID referencing the filesystem that was created on the cloud provider environment that this workbench uses.

cloudPlatform -> (string)

The cloud platform of the environment that was used to create this workbench.

monitoringEnabled -> (boolean)

If usage monitoring is enabled or not on this workbench.

loadBalancerIPWhitelists -> (array)

The whitelist of IPs for load balancer.

item -> (string)

creationDate -> (datetime)

Creation date of workbench.

failureMessage -> (string)

Failure message from the most recent failure that has occurred during workbench provisioning.

healthInfoLists -> (array)

The health info information of the workbench.

item -> (object)

Healthinfo object contains the health information of a resource.

resourceName -> (string)

The resource name being checked.

isHealthy -> (boolean)

The boolean that indicates the health status.

updatedAt -> (datetime)

The timestamp for the heartbeat.

message -> (string)

The message to show for the health info.

details -> (array)

The detail of the health info.

upgradeState -> (object)

Response object for the workbench summary.

state -> (string)

The current upgrade state of the workbench.

reason -> (string)

The reason for the current state.

nfsVersion -> (string)

NFS Version of the filesystem.

backupMetadata -> (object)

Backup metadata response object for the workbench summary.

backupVaultName -> (string)

The backup vault name.

lastSuccessfulBackupTime -> (datetime)

The time when the last successful backup was taken.

isSuccessfulBackupAvailable -> (boolean)

Whether successful backups are available for the workbench.

lastBackupStatus -> (string)

The status of the last backup initiated.

numberOfAvailableBackups -> (integer)

The number of backups available.

clusterID -> (string)

The Cluster ID for the workbench.

isPrivate -> (boolean)

The value to indicate if the cluster is private or not.

isRestored -> (boolean)

The value to indicate if the workbench is restored one or not

Form Factors¶

public, private