list-vws¶

Description¶

List Virtual Warehouses.

Synopsis¶

  list-vws
--cluster-id <value>
[--filter <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cluster-id (string)

ID of cluster to list.

--filter (object)

Filter object for Virtual Warehouses.

vwType -> (string)

Type of Virtual Warehouse: ‘hive’ or ‘impala’.

dbcId -> (string)

Filter Virtual Warehouses by Database Catalog Id.

compactor -> (boolean)

Filter Virtual Warehouses whether it is a Compactor or not.

viz -> (boolean)

Filter the Virtual Warehouses based on whether it has Data Visualisation.

Shorthand Syntax:

vwType=string,dbcId=string,compactor=boolean,viz=boolean

JSON Syntax:

{
  "vwType": "hive"|"impala",
  "dbcId": "string",
  "compactor": true|false,
  "viz": true|false
}

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

vws -> (array)

The list of Virtual Warehouses.

item -> (object)

A Virtual Warehouse.

crn -> (string)

The CRN of the Virtual Warehouse.

id -> (string)

The ID of the Virtual Warehouse.

name -> (string)

The name of the Virtual Warehouse.

vwType -> (string)

Type of Virtual Warehouse: ‘hive’ or ‘impala’.

dbcId -> (string)

ID of Database Catalog that the Virtual Warehouse is attached to.

status -> (string)

Status of the Virtual Warehouse. Possible values are: Creating, Created, Accepted, Starting, Running, Stopping, Stopped, Updating, PreUpdate, Upgrading, PreUpgrade, Restarting, Deleting, Waiting, Failed, Error.

statusChangedAt -> (datetime)

Timestamp of the last status change of the Virtual Warehouse.

creator -> (object)

A CDP actor (user or machine user).

crn -> (string)

Actor CRN.

email -> (string)

Email address for users.

workloadUsername -> (string)

Username for users.

machineUsername -> (string)

Username for machine users.

creationDate -> (datetime)

Creation date of Virtual Warehouse.

configId -> (string)

ID of the configuration.

cdhVersion -> (string)

CDH image version.

endpoints -> (object)

Endpoints for accessing the Virtual Warehouse.

hiveJdbc -> (string)

JDBC URL for Hive Virtual Warehouses.

impalaJdbc -> (string)

JDBC URL for Impala Virtual Warehouses.

impalaFENGJdbc -> (string)

FENG JDBC URL for Impala Virtual Warehouses.

impalaShell -> (string)

Command to use impala-shell for Impala Virtual Warehouses.

hue -> (string)

URL of Hue for both Hive and Impala Virtual Warehouses.

das -> (string)

URL of Data Analytics Studio for Hive Virtual Warehouses.

tags -> (array)

Tags associated with the resources.

item -> (object)

A key/value pair attached to some resources.

key -> (string)

The tag’s name.

value -> (string)

The associated value of the tag.

compactor -> (boolean)

Denotes whether the Hive Virtual Warehouse is a compactor or not.

viz -> (boolean)

Denotes whether the Virtual Warehouse has Data Visualisation or not.

autoscalingOptions -> (object)

Auto-scaling configuration for a Virtual Warehouse.

minClusters -> (integer)

Minimum number of available compute groups.

maxClusters -> (integer)

Maximum number of available compute groups.

disableAutoSuspend -> (boolean)

Turn off auto suspend for Virtual Warehouse.

autoSuspendTimeoutSeconds -> (integer)

Auto suspend threshold for Virtual Warehouse.

enableUnifiedAnalytics -> (boolean)

Whether the Unified Analytics is enabled.

hiveScaleWaitTimeSeconds -> (integer)

Wait time before a scale event happens.

hiveDesiredFreeCapacity -> (integer)

Desired free capacity.

impalaHighAvailabilityMode -> (string)

High Availability mode.

impalaScaleUpDelaySeconds -> (integer)

Scale up the scaling up threshold in seconds.

impalaScaleDownDelaySeconds -> (integer)

Scale down threshold in seconds.

impalaEnableShutdownOfCoordinator -> (boolean)

Whether a shutdown of the coordinator is enabled.

impalaNumOfActiveCoordinators -> (integer)

Number of the active coordinators.

impalaShutdownOfCoordinatorDelaySeconds -> (integer)

Delay in seconds before the shutdown of coordinator event happens.

impalaEnableCatalogHighAvailability -> (boolean)

Denotes whether a backup instance for Impala catalog is enabled.

podConfigName -> (string)

Name of the pod configuration.

queryIsolationOptions -> (object)

Configurations for Query Isolation.

maxQueries -> (integer)

Maximum Concurrent Isolated Queries

maxNodesPerQuery -> (integer)

Maximum Nodes Per Isolated Query

Form Factors¶

public, private