Overview

Install and manage Cloudera Data Warehouse clusters.

Version information

Version : 0.9.109

License information

URI scheme

Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Paths

Adds the given user to the cluster.

POST /api/v1/dw/addUser

Description

Adds the given user to the cluster. Please note that the user must pre-exist.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Creates a backup from the cluster configuration and settings.

POST /api/v1/dw/backupCluster

Description

Creates a backup from the configuration and settings, including all the connected DbCatalogs, Virtual Warehouses and Data Visualisation Apps. The returned data may be used to restore all the entities by using the "restore-cluster" command. The CDW doesn’t provide centralized management of the backups. Learn more at https://docs.cloudera.com/data-warehouse/cloud/backup-and-restore/topics/dw-environment-reactivation.html

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Creates a backup for the data warehouse.

POST /api/v1/dw/createBackup

Description

Creates an on-demand backup for the data warehouse including Kubernetes objects, persistent volumes, etc. Backup requests are processed asynchronously and instantaneously.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Create a Cloudera Data Warehouse cluster.

POST /api/v1/dw/createCluster

Description

Create a Cloudera Data Warehouse cluster.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Create a diagnostic job for the given cluster.

POST /api/v1/dw/createClusterDiagnosticDataJob

Description

Creates a diagnostic job for the given cluster. The diagnostic data job is useful for troubleshooting purposes. The job collects logs and metrics (see –download-options to see available options) which are going to be bundled into a single file and will be available at the desired location (see –destination). General metadata about the diagnostics will also be included as the bundle-info.json file.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Creates a Cloudera Data Visualization.

POST /api/v1/dw/createDataVisualization

Description

Creates a Cloudera Data Visualization.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Create a Database Catalog.

POST /api/v1/dw/createDbc

Description

DEPRECATED: Create a Database Catalog. The Database Catalog creation is deprecated and will be removed in subsequent releases. The Default Database Catalog is getting created during the cluster activation (create-cluster).

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Create a diagnostic job for the given database catalog.

POST /api/v1/dw/createDbcDiagnosticDataJob

Description

Creates a diagnostic job for the given database catalog. The diagnostic data job is useful for troubleshooting purposes. The job collects logs and metrics (see –download-options to see available options) which are going to be bundled into a single file and will be available at the desired location (see –destination). General metadata about the diagnostics will also be included as the bundle-info.json file.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Create a Virtual Warehouse.

POST /api/v1/dw/createVw

Description

Create a Virtual Warehouse.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Create a diagnostic job for the given Virtual Warehouse.

POST /api/v1/dw/createVwDiagnosticDataJob

Description

Creates a job for the given Virtual Warehouse. The diagnostic data job is useful for troubleshooting purposes. The job collects logs and metrics (see –hive-download-options, –impala-download-options to see available options) which are going to be bundled into a single file and will be available at the desired location (see –destination). General metadata about the diagnostics will also be included as the bundle-info.json file.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Deletes a data warehouse backup.

POST /api/v1/dw/deleteBackup

Description

Deletes an existing data warehouse backup. The call returns immediately.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Delete a Cloudera Data Warehouse cluster.

POST /api/v1/dw/deleteCluster

Description

Delete a Cloudera Data Warehouse cluster.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Deletes a diagnostic job for the given cluster.

POST /api/v1/dw/deleteClusterDiagnosticDataJob

Description

Deletes a diagnostic job for the given cluster. The job can be deleted even when its status is "Running".

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Asynchronous operation that deletes a Cloudera Data Visualization. When the DV is in deleting state, we can still use describe-data-visualization to check the status. Once it is deleted, the describe-data-visualization would return a not found error.

POST /api/v1/dw/deleteDataVisualization

Description

Asynchronous operation that deletes a Cloudera Data Visualization. When the DV is in deleting state, we can still use describe-data-visualization to check the status. Once it is deleted, the describe-data-visualization would return a not found error.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Delete a Database Catalog.

POST /api/v1/dw/deleteDbc

Description

Delete a Database Catalog.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Deletes a diagnostic job for the given Database Catalog.

POST /api/v1/dw/deleteDbcDiagnosticDataJob

Description

Deletes a diagnostic job for the given Database Catalog. The job can be deleted even when its status is "Running".

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Deletes the given user from the cluster.

POST /api/v1/dw/deleteUser

Description

Deletes the given user from the cluster. Please note that the user itself won’t be deleted, only removed from the cluster.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Delete a Virtual Warehouse.

POST /api/v1/dw/deleteVw

Description

Delete a Virtual Warehouse.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Delete a diagnostic job for the given Virtual Warehouse.

POST /api/v1/dw/deleteVwDiagnosticDataJob

Description

Delete a diagnostic job for the given Virtual Warehouse. The job can be deleted even when its status is "Running".

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Get allowed compute instance types for both AWS and Azure cluster types and their default values.

POST /api/v1/dw/describeAllowedInstanceTypes

Description

Get allowed compute instance types for both AWS and Azure cluster types and their default values.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Describes the backup.

POST /api/v1/dw/describeBackup

Description

Returns the description of an existing data warehouse backup.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Describe a Cloudera Data Warehouse cluster.

POST /api/v1/dw/describeCluster

Description

Describe a Cloudera Data Warehouse cluster.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Describes a diagnostic job for the given Cluster.

POST /api/v1/dw/describeClusterDiagnosticDataJob

Description

Describes a diagnostic job for the given Cluster. The output includes a list of jobs along with their current status and some metadata related to each job.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Describe a service configuration.

POST /api/v1/dw/describeConfig

Description

Describe a service configuration.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Get differences between two service configurations.

POST /api/v1/dw/describeConfigDiff

Description

Get differences between two service configurations.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Describes a Cloudera Data Visualization.

POST /api/v1/dw/describeDataVisualization

Description

Describes a Cloudera Data Visualization.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Describe a Database Catalog.

POST /api/v1/dw/describeDbc

Description

Describe a Database Catalog.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Describes the Database Catalog current configuration.

POST /api/v1/dw/describeDbcConfig

Description

Describes the Database Catalog current configuration.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Describes a diagnostic job for the given Database Catalog.

POST /api/v1/dw/describeDbcDiagnosticDataJob

Description

Describes a diagnostic job for the given Database Catalog. The output includes a list of jobs along with their current status and some metadata related to each job.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Get Kubeconfig for a Cloudera Data Warehouse cluster.

POST /api/v1/dw/describeKubeconfig

Description

Get Kubeconfig for a Cloudera Data Warehouse cluster.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Describes the restore.

POST /api/v1/dw/describeRestore

Description

Returns the description of a data warehouse restore operation.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Get the DWX server settings.

POST /api/v1/dw/describeServerSetting

Description

Get the DWX server settings. This method can be used from DWX Private Cloud version 1.4.1.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Describe a Virtual Warehouse.

POST /api/v1/dw/describeVw

Description

Describe a Virtual Warehouse.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Describes the current configuration of a Hive or Impala Virtual Warehouse.

POST /api/v1/dw/describeVwConfig

Description

Describes the current configuration of a Hive or Impala Virtual Warehouse.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Describe a diagnostic jobs for the given Virtual Warehouse.

POST /api/v1/dw/describeVwDiagnosticDataJob

Description

Describes a diagnostic job for the given Virtual Warehouse. The output includes a list of jobs along with their current status and metadata related to each job.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Gets latest version and latest compatible version for Cloudera Data Visualization.

POST /api/v1/dw/getDataVisualizationUpgradeVersion

Description

Gets latest version and latest compatible version for Cloudera Data Visualization.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Gets job logs.

POST /api/v1/dw/getLogs

Description

Given the CRN, returns the corresponding job logs.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Gets the latest version and latest compatible version for Database Catalog.

POST /api/v1/dw/getUpgradeDbcVersions

Description

Gets the latest version and latest compatible version for Database Catalog.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Gets the latest version and latest compatible version for Virtual Warehouse.

POST /api/v1/dw/getUpgradeVwVersions

Description

Gets the latest version and latest compatible version for Virtual Warehouse.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Check the health of the API.

POST /api/v1/dw/healthCheck

Description

Check the health of the API.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Lists potential backup entities associated with the data warehouse.

POST /api/v1/dw/listBackupEntities

Description

Lists potential backup entities associated with the data warehouse.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Lists backups.

POST /api/v1/dw/listBackups

Description

Lists backups associated with the data warehouse.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Get a list of diagnostic jobs for the given cluster.

POST /api/v1/dw/listClusterDiagnosticDataJobs

Description

Lists diagnostic jobs for the given cluster. The output includes a list of jobs along with their current status and metadata related to each job.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

List Cloudera Data Warehouse clusters.

POST /api/v1/dw/listClusters

Description

List Cloudera Data Warehouse clusters.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Lists Cloudera Data Visualization in the provided CDW cluster.

POST /api/v1/dw/listDataVisualizations

Description

Lists Cloudera Data Visualization in the provided CDW cluster.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Get the configuration history of a Database Catalog.

POST /api/v1/dw/listDbcConfigs

Description

Get the configuration history of a Database Catalog.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Get a list of diagnostic jobs for the given Database Catalog.

POST /api/v1/dw/listDbcDiagnosticDataJobs

Description

Lists diagnostic jobs for the given Database Catalog. The output includes a list of jobs along with their current status and metadata related to each job.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Get the list of events for the given Database Catalog.

POST /api/v1/dw/listDbcEvents

Description

Get the list of events for the given Database Catalog.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

List Database Catalogs.

POST /api/v1/dw/listDbcs

Description

List Database Catalogs.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Get the list of events.

POST /api/v1/dw/listEvents

Description

Get the list of events for the given Operation or a specific Service (Cluster, Database Catalog, Virtual Warehouse, or Data Visualization App). Events can belong to a particular Operation which might span across multiple Services. This happens if the given operation affects one or more Services e.g.: restore-cluster. It is also possible to return the events only for a given Service, in this case it is enough to pass the Id of a Service (e.g.: env-sq7hfv, warehouse-1696571829-pps2, compute-1696571962-8dd8, impala-1696572085-cn44).

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Lists the latest version of the product (if available) for all catalogs in the environment.

POST /api/v1/dw/listLatestVersions

Description

Lists the latest version of the product (if available) for all catalogs in the environment.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

successful operation

default

The default response on an error.

Lists restores.

POST /api/v1/dw/listRestores

Description

Lists restores associated with the data warehouse.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Lists the users who have access to the cluster.

POST /api/v1/dw/listUsers

Description

Lists the users who have access to the cluster.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Get the configuration history of a Virtual Warehouse.

POST /api/v1/dw/listVwConfigs

Description

Get the configuration history of a Virtual Warehouse.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Get a list of diagnostic jobs for the given Virtual Warehouse.

POST /api/v1/dw/listVwDiagnosticDataJobs

Description

Lists diagnostic jobs for the given Virtual Warehouse. The output includes a list of jobs along with their current status and metadata related to each job.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Get the list of events for the given Virtual Warehouse.

POST /api/v1/dw/listVwEvents

Description

Get the list of events for the given Virtual Warehouse.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

List Virtual Warehouses.

POST /api/v1/dw/listVws

Description

List Virtual Warehouses.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Rebuild a Database Catalog.

POST /api/v1/dw/rebuildDbc

Description

Rebuild a Database Catalog. Please use this feature for Database Catalogs which are in inconsistent or erroneous state. Running/Stopped Database Catalogs are safe to rebuild as well. This is a Beta feature. If a rebuild has been initiated, try to avoid rebuilding it again until it is completed or in erroneous state.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Rebuild a Virtual Warehouse.

POST /api/v1/dw/rebuildVw

Description

Rebuild a Virtual Warehouse. Please use this feature for Virtual Warehouses which are in inconsistent or erroneous state. Running/Stopped Virtual Warehouses are safe to rebuild as well. This is a Beta feature. If a rebuild has been initiated, try to avoid rebuilding it again until it is completed or in erroneous state.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Renew certificates for a Cloudera Data Warehouse Azure cluster.

POST /api/v1/dw/renewCertificates

Description

Renew certificate for a Cloudera Data Warehouse Azure cluster.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

405

Operation not allowed on non-Azure clusters.

default

The default response on an error.

Restart a Database Catalog.

POST /api/v1/dw/restartDbc

Description

Restart a Database Catalog.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Restart a Virtual Warehouse.

POST /api/v1/dw/restartVw

Description

Restart a Virtual Warehouse.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Restores backup.

POST /api/v1/dw/restoreBackup

Description

Restores the state of the data warehouse from an existing backup.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Restores the cluster from a backup data made by "backup-cluster" command.

POST /api/v1/dw/restoreCluster

Description

Restores the cluster from a backup data made by "backup-cluster" command. The operation restores the default DbCatalog configuration, the Virtual Warehouses and the Data Visualisation Apps. Learn more at https://docs.cloudera.com/data-warehouse/cloud/backup-and-restore/topics/dw-environment-reactivation.html

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Starts a suspended Virtual Warehouse.

POST /api/v1/dw/startVw

Description

Starts a suspended Virtual Warehouse. Has no effect if the VW is already started.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Suspends a running Database Catalog.

POST /api/v1/dw/suspendDbc

Description

Suspends a running Database Catalog. Has no effect if the DBC is already suspended.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Suspends a running Virtual Warehouse.

POST /api/v1/dw/suspendVw

Description

Suspends a running Virtual Warehouse. Has no effect if the VW is already suspended.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Updates the Cloudera Data Warehouse cluster.

POST /api/v1/dw/updateCluster

Description

Update the Cloudera Data Warehouse cluster.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Asynchronous operation that updates the configuration of a Cloudera Data Visualization. The describe-data-visualization can be used at any time to get the latest status of a Data Visualization.

POST /api/v1/dw/updateDataVisualization

Description

Asynchronous operation that updates the configuration of a Cloudera Data Visualization. The describe-data-visualization can be used at any time to get the latest status of a Data Visualization.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Update the configuration of a Database Catalog.

POST /api/v1/dw/updateDbc

Description

Update the configuration of a Database Catalog.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Update a Database Catalog configuration.

POST /api/v1/dw/updateDbcConfig

Description

Update a Database Catalog configuration.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Update the DWX server settings.

POST /api/v1/dw/updateServerSetting

Description

Update the DWX server settings. The input list of server settings will be updated accordingly (turns on if enabled: true is set, turns off if enabled: false is set). Some settings need further actions to be taken (e.g. recreating a Virtual Warehouse), this is indicated in the server setting list returned by the describeServerSetting functionality. This method can be used from DWX Private Cloud version 1.4.1.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Update the SSH Key for a Cloudera Data Warehouse cluster

POST /api/v1/dw/updateSshKey

Description

Update the SSH Key for a Cloudera Data Warehouse cluster

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Update the configuration of a Virtual Warehouse.

POST /api/v1/dw/updateVw

Description

Update the configuration of a Virtual Warehouse.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Update a Virtual Warehouse configuration.

POST /api/v1/dw/updateVwConfig

Description

Update a Virtual Warehouse configuration.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Upgrade the Cloudera Data Warehouse cluster.

POST /api/v1/dw/upgradeCluster

Description

Upgrade the Cloudera Data Warehouse cluster to the latest supported version. Expect downtime during the upgrade and refrain issuing queries. You can check the current status of the cluster with the describe-cluster command.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Asynchronous operation that upgrades a Cloudera Data Visualization to a compatible version. The describe-data-visualization can be used at any time to get the latest status of a Data Visualization.

POST /api/v1/dw/upgradeDataVisualization

Description

Asynchronous operation that upgrades a Cloudera Data Visualization to a compatible version. The describe-data-visualization can be used at any time to get the latest status of a Data Visualization.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Upgrades the Database Catalog to a compatible version.

POST /api/v1/dw/upgradeDbc

Description

Upgrades the Database Catalog to a compatible version.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Upgrades the Virtual Warehouse to a compatible version.

POST /api/v1/dw/upgradeVw

Description

Upgrades the Virtual Warehouse to a compatible version.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Definitions

ActorResponse

A CDP actor (user or machine user).

Name Description Schema

crn
optional

Actor CRN.

string

email
optional

Email address for users.

string

machineUsername
optional

Username for machine users.

string

workloadUsername
optional

Username for users.

string

AddUserRequest

Request object for the addUser method.

Name Description Schema

clusterId
required

The ID of the cluster to which the user must be added.

string

userId
required

A cloud based unique identifier of the user (ARN for AWS users, groupId for Azure users).

string

AddUserResponse

Response object for the addUser method.

Type : object

AllowedInstanceTypes

Allowed compute instance type values and default compute instance type value.

Name Description Schema

allowed
optional

Allowed values for the instance type. This setting is Cluster-wide.

< string > array

default
optional

Default value for the compute instance type usage. This setting is Cluster-wide.

< string > array

ApplicationConfigDiff

Differences between two ApplicationConfigs.

Name Description Schema

configBlocksDiffs
optional

Differences between the two sets of ConfigBlocks.

isChanged
required

Has any of the configurations changed?

boolean

ApplicationConfigReq

Configurations for an application inside a service.

Name Description Schema

configBlocks
optional

List of ConfigBlocks for the application.

< ConfigBlockReq > array

ApplicationConfigResp

Configurations for an application inside a service.

Name Description Schema

configBlocks
optional

List of ConfigBlocks for the application.

< ConfigBlockResp > array

AutoscalingOptionsCreateRequest

Auto-scaling configuration for a Virtual Warehouse.

Name Description Schema

autoSuspendTimeoutSeconds
optional

Auto suspend threshold for Virtual Warehouse.

integer (int32)

disableAutoSuspend
optional

Turn off auto suspend for Virtual Warehouse.

boolean

enableUnifiedAnalytics
optional

DEPRECATED in favor of the top level enableUnifiedAnalytics flag. Enable Unified Analytics. In case of Hive Virtual Warehouses this cannot be provided, because this value is inferred. In case of Impala this can be set. Passing –query-isolation-options will be considered if this flag is set to true. If Unified Analytics enabled then the "impalaEnableShutdownOfCoordinator" explicitly disabled and should not be provided, furthermore the "impalaHighAvailabilityMode" cannot be set to ACTIVE_ACTIVE.

boolean

hiveDesiredFreeCapacity
optional

Set Desired free capacity. Either "hiveScaleWaitTimeSeconds" or "hiveDesiredFreeCapacity" can be provided.

integer (int32)

hiveScaleWaitTimeSeconds
optional

Set wait time before a scale event happens. Either "hiveScaleWaitTimeSeconds" or "hiveDesiredFreeCapacity" can be provided.

integer (int32)

impalaEnableCatalogHighAvailability
optional

DEPRECATED in favor of the top level impalaHASettings object. Enables a backup instance for Impala catalog to ensure high availability.

boolean

impalaEnableShutdownOfCoordinator
optional

DEPRECATED in favor of the top level impalaHASettings object. Enables a shutdown of the coordinator. If Unified Analytics enabled then this setting explicitly disabled and should not be provided.

boolean

impalaHighAvailabilityMode
optional

DEPRECATED in favor of the top level impalaHASettings object. Set High Availability mode. If not provided the default will apply. This value is disregarded for Hive.

enum (ACTIVE_PASSIVE, ACTIVE_ACTIVE, DISABLED)

impalaNumOfActiveCoordinators
optional

DEPRECATED in favor of the top level impalaHASettings object. Number of the active coordinators.

integer (int32)

impalaScaleDownDelaySeconds
optional

Scale down threshold in seconds. If not provided defaults will apply.

integer (int32)

impalaScaleUpDelaySeconds
optional

Scale up the scaling up threshold in seconds. If not provided defaults will apply.

integer (int32)

impalaShutdownOfCoordinatorDelaySeconds
optional

DEPRECATED in favor of the top level impalaHASettings object. Delay in seconds before the shutdown of coordinator event happens.

integer (int32)

maxClusters
optional

Maximum number of available compute groups.
Default : 10

integer (int32)

minClusters
optional

Minimum number of available compute groups.
Default : 1

integer (int32)

podConfigName
optional

Name of the pod configuration.

string

AutoscalingOptionsResponse

Auto-scaling configuration for a Virtual Warehouse.

Name Description Schema

autoSuspendTimeoutSeconds
optional

Auto suspend threshold for Virtual Warehouse.

integer (int32)

disableAutoSuspend
optional

Turn off auto suspend for Virtual Warehouse.

boolean

enableUnifiedAnalytics
optional

DEPRECATED in favor of the top level enableUnifiedAnalytics flag. Whether the Unified Analytics is enabled.

boolean

hiveDesiredFreeCapacity
optional

Desired free capacity.

integer (int32)

hiveScaleWaitTimeSeconds
optional

Wait time before a scale event happens.

integer (int32)

impalaEnableCatalogHighAvailability
optional

DEPRECATED in favor of the top level impalaHASettings object. Denotes whether a backup instance for Impala catalog is enabled.

boolean

impalaEnableShutdownOfCoordinator
optional

DEPRECATED in favor of the top level impalaHASettings object. Whether a shutdown of the coordinator is enabled.

boolean

impalaHighAvailabilityMode
optional

DEPRECATED in favor of the top level impalaHASettings object. High Availability mode.

enum (ACTIVE_PASSIVE, ACTIVE_ACTIVE, DISABLED)

impalaNumOfActiveCoordinators
optional

DEPRECATED in favor of the top level impalaHASettings object. Number of the active coordinators.

integer (int32)

impalaScaleDownDelaySeconds
optional

Scale down threshold in seconds.

integer (int32)

impalaScaleUpDelaySeconds
optional

Scale up the scaling up threshold in seconds.

integer (int32)

impalaShutdownOfCoordinatorDelaySeconds
optional

DEPRECATED in favor of the top level impalaHASettings object. Delay in seconds before the shutdown of coordinator event happens.

integer (int32)

maxClusters
optional

Maximum number of available compute groups.

integer (int32)

minClusters
optional

Minimum number of available compute groups.

integer (int32)

podConfigName
optional

Name of the pod configuration.

string

AutoscalingOptionsUpdateRequest

Auto-scaling configuration for a Virtual Warehouse. Provide those values only that you want to update.

Name Description Schema

autoSuspendTimeoutSeconds
optional

Auto suspend threshold for Virtual Warehouse.

integer (int32)

disableAutoSuspend
optional

Turn off auto suspend for Virtual Warehouse.

boolean

hiveDesiredFreeCapacity
optional

Set Desired free capacity. Either "hiveScaleWaitTimeSeconds" or "hiveDesiredFreeCapacity" can be provided.

integer (int32)

hiveScaleWaitTimeSeconds
optional

Set wait time before a scale event happens. Either "hiveScaleWaitTimeSeconds" or "hiveDesiredFreeCapacity" can be provided. If "hiveScaleWaitTimeSeconds" provided, then the "hiveDesiredFreeCapacity" will be explicityly set to 0.

integer (int32)

impalaNumOfActiveCoordinators
optional

DEPRECATED in favor of the top level impalaHASettings object. Number of the active coordinators.

integer (int32)

impalaScaleDownDelaySeconds
optional

Scale down threshold in seconds.

integer (int32)

impalaScaleUpDelaySeconds
optional

Scale up the scaling up threshold in seconds.

integer (int32)

impalaShutdownOfCoordinatorDelaySeconds
optional

DEPRECATED in favor of the top level impalaHASettings object. Delay in seconds before the shutdown of coordinator event happens.

integer (int32)

maxClusters
optional

Maximum number of available compute groups. Zero means, the maxClusters will not be updated..
Default : 0

integer (int32)

minClusters
optional

Minimum number of available compute groups. Zero means, the minClusters will not be updated.
Default : 0

integer (int32)

AwsActivationOptions

Options for activating an AWS environment.

Name Description Schema

additionalInstanceTypes
optional

Additional (fallback) instance types listed in their priority order. They will be used instead of the primary compute instance type in case it is unavailable. You cannot include any instance type that was already indicated in computeInstanceTypes. Use describe-allowed-instance-types to see currently supported values and also the default value when nothing is provided for the computeInstanceTypes.

< string > array

computeInstanceTypes
optional

AWS compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values.

< string > array

customAmiId
optional

Custom AMI ID.

string

enableSpotInstances
optional

Whether to enable Spot instances for Virtual warehouses. It cannot be updated later. If the aws-options is not provided it defaults to false.
Default : false

boolean

lbSubnetIds
optional

IDs of AWS subnets where the cluster load balancer should be deployed.

< string > array

nodeRoleCDWManagedPolicyArn
optional

Managed Policy Arn to be attached to the Node Instance Role.

string

reducedPermissionMode
optional

Use this option to activate the environment with fewer than half of the standard required IAM permissions on your AWS cross-account IAM role.

boolean

workerSubnetIds
optional

IDs of AWS subnets where the cluster worker nodes should be deployed.

< string > array

AwsOptionsResponse

Response object of the cluster AWS settings.

Name Description Schema

availabilityZones
optional

List of availability zones that the cluster is restricted to use.

< string > array

customAmiId
optional

Id of the Custom Amazon Machine Image

string

lbSubnetIds
optional

IDs of AWS subnets where the cluster load balancer should be deployed.

< string > array

reducedPermissionMode
optional

Denotes whether the Reduced Permission mode is enabled.

boolean

subnetIds
optional

IDs of AWS subnets where the cluster has been deployed.

< string > array

workerSubnetIds
optional

IDs of AWS subnets where the cluster worker nodes should be deployed.

< string > array

AzureActivationOptions

Options for activating an Azure environment.

Name Description Schema

computeInstanceTypes
optional

Azure compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values and the default value used for the case it is not provided.

< string > array

enableAZ
optional

Enables Azure Availability Zones for the cluster deployment.

boolean

enablePrivateAks
optional

Enable Azure Private AKS mode.
Default : false

boolean

enablePrivateSQL
optional

Enables private SQL for the cluster deployment.
Default : false

boolean

enableSpotInstances
optional

Whether to enable spot instances for Virtual warehouses. It cannot be updated later. If the AzureActivationOptions is not provided it defaults to false.
Default : false

boolean

logAnalyticsWorkspaceId
optional

Enable monitoring of Azure Kubernetes Service (AKS) cluster. Workspace ID for Azure log analytics.

string

outboundType
optional

Network outbound type. This setting controls the egress traffic for cluster nodes in Azure Kubernetes Service. Please refer to the following AKS documentation on the Azure portal. https://learn.microsoft.com/en-us/azure/aks/egress-outboundtype, https://learn.microsoft.com/en-us/azure/aks/nat-gateway

enum (LoadBalancer, UserAssignedNATGateway, UserDefinedRouting)

privateDNSZoneAKS
optional

Private DNS zone AKS resource ID.

string

subnetId
optional

ID of Azure subnet where the cluster should be deployed. It is a mandatory parameter for Azure cluster creation.

string

userAssignedManagedIdentity
optional

Resource ID of the managed identity used by AKS. It is a mandatory parameter for Azure cluster creation.

string

AzureOptionsResponse

Response object of the cluster Azure settings.

Name Description Schema

enableAZ
optional

Denotes whther the Azure Availability Zones for the cluster is enabled or not.
Default : false

boolean

logAnalyticsWorkspaceId
optional

Workspace ID for Azure log analytics.

string

outboundType
optional

The current outbound type setting.

string

subnetId
optional

ID of Azure subnet where the cluster is deployed.

string

Backup

Backup entry

Name Description Schema

backupCreationTime
optional

The time when the backup was created.

string

backupCrn
optional

The CRN of the backup.

string

backupJob
optional

The backup job name.

string

backupJobState
optional

The current state of the backup job.

string

backupName
optional

The display name of the backup.

string

backupPhase
optional

The phase of the backup operation.

string

backupUpdatedTime
optional

The time when the backup was updated.

string

errors
optional

The errors from backup job.

< Message > array

includedNamespaces
optional

The list of namespaces to be included in backup.

< string > array

warnings
optional

The warnings from backup job.

< Message > array

BackupClusterRequest

Request object for the backupCluster method.

Name Description Schema

clusterId
required

The ID of the cluster.

string

BackupClusterResponse

Response object for the backupCluster method.

Name Description Schema

clusterId
optional

The ID of the cluster.

string

data
optional

The backup data.

string

md5
optional

The md5 hash of the encoded data.

string

operationId
optional

The ID of the backup operation.

string

timestamp
optional

The date of the creation.

string (date-time)

CloudUserReference

Cloud user definition object.

Name Description Schema

userId
required

A cloud based unique identifier of the user (ARN for AWS users, groupId for Azure users).

string

ClusterCreateDiagnosticDataDownloadOptions

Flags that denote which diagnostics to include for the cluster.

Name Description Schema

includeClusterInfo
optional

Include cluster info.
Default : false

boolean

includeIstioSystem
optional

Include Istio system.
Default : false

boolean

includeKubeSystem
optional

Include Kube system.
Default : false

boolean

includeSharedServices
optional

Include shared services.
Default : false

boolean

ClusterDiagnosticDataJob

Represents a Diagnostic Data Job.

Name Description Schema

endTime
optional

The finish time of the Diagnostic Data Job.

string (date-time)

jobId
optional

The unique identifier of the Diagnostic Data Job.

string

labels
optional

Additional key-value pair attributes associated with the Diagnostic Data Job.

< string, string > map

startTime
optional

The start time of the Diagnostic Data Job.

string (date-time)

status
optional

The job status.

url
optional

This URL points to a download location if the destination is DOWNLOAD.

string

ClusterSummaryResponse

A Cloudera Data Warehouse cluster.

Name Description Schema

additionalInstanceTypes
optional

Additional (fallback) instance types listed in their priority order. They are used instead of the primary compute instance type in case it is unavailable. Since additional instance types are not supported for Azure, this is always empty for it.

< string > array

awsOptions
optional

Response object of AWS related cluster options.

azureOptions
optional

Response object of Azure related cluster options.

cloudPlatform
optional

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

string

computeInstanceTypes
optional

Compute instance types that the environment is restricted to use. This affects the creation of the virtual warehouses where this restriction will apply.

< string > array

creationDate
optional

Creation date of cluster.

string (date-time)

creator
optional

The creator of the cluster.

crn
optional

The CRN of the cluster.

string

description
optional

Cluster description.

string

enableSpotInstances
optional

Denotes whether the spot instances have been enabled for the cluster. This value is only available for AWS and Azure clusters.

boolean

environmentCrn
optional

The CRN of the environment where the cluster is located.

string

externalBuckets
optional

External buckets attached to the environment.

< ExternalBucket > array

id
optional

The ID of the cluster.

string

name
optional

Name of the cluster (same as the name of the environment).

string

reservedComputeNodes
optional

Number of additional reserved nodes for executors and coordinators to use during autoscaling.

integer (int32)

reservedSharedServicesNodes
optional

Number of additional reserved nodes for other services in the cluster.

integer (int32)

resourcePool
optional

The name of the Resource Pool the cluster is in.

string

status
optional

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

string

whitelistK8sClusterAccessIpCIDRs
optional

List of IP address CIDRs to whitelist for kubernetes cluster access.

string

whitelistWorkloadAccessIpCIDRs
optional

List of IP address CIDRs to whitelist for workload access.

string

ConfigBlock

Set values for a configuration file of a service.

Name Description Schema

configFile
optional

Configuration file to update.

string

content
optional

Set values for text format configuration file e.g. TEXT, JSON, YAML, XML typed file.

string

keyValue
optional

Set values for key-value format configuration file e.g. ENV, PROPERTIES, FLAGFILE, HADOOP_XML typed file.

< string, string > map

ConfigBlockDiff

Differences between two ConfigBlocks.

Name Description Schema

contentDiff
optional

Differences between the contents.

id
optional

ID of the ConfigBlock.

string

ConfigBlockReq

A piece of configuration stored in the same place (e.g. same file or environment variables).

Name Description Schema

content
required

Contents of a ConfigBlock.

format
required

Format of ConfigBlock.

enum (HADOOP_XML, PROPERTIES, TEXT, JSON, BINARY, ENV, FLAGFILE)

id
required

ID of the ConfigBlock. Unique within an ApplicationConfig.

string

ConfigBlockResp

A piece of configuration stored in the same place (e.g. same file or environment variables).

Name Description Schema

content
optional

Contents of a ConfigBlock.

format
optional

Format of ConfigBlock.

enum (HADOOP_XML, PROPERTIES, TEXT, JSON, BINARY, ENV, FLAGFILE)

id
optional

ID of the ConfigBlock. Unique within an ApplicationConfig.

string

ConfigBlocksDiffs

Differences between two sets of ConfigBlocks.

Name Description Schema

added
optional

Config blocks that are only present in the new configuration.

< ConfigBlockResp > array

changed
optional

Config blocks that are different between the two configurations.

< ConfigBlockDiff > array

isChanged
required

Has any of the config blocks changed?

boolean

removed
optional

Config blocks that are only present in the old configuration.

< ConfigBlockResp > array

same
optional

Config blocks that are the same in both configurations.

< ConfigBlockResp > array

ConfigContentDiff

Difference between two ConfigContents.

Name Description Schema

keyValues
optional

Different between keyValues of two ConfigContents.

ConfigContentReq

Contents of a ConfigBlock.

Name Description Schema

json
optional

JSON type configuration.

string

keyValues
optional

Key-value type configurations.

< string, string > map

text
optional

Text type configuration.

string

ConfigContentResp

Contents of a ConfigBlock.

Name Description Schema

json
optional

JSON type configuration.

string

keyValues
optional

Key-value type configurations.

< string, string > map

text
optional

Text type configuration.

string

ConfigHistoryItem

An entry in the configuration history of a service.

Name Description Schema

configId
optional

ID of the configuration.

string

from
optional

When was this configuration used from.

string (date-time)

serviceId
optional

DBC or VW ID that this configuration belongs to.

string

CreateBackupRequest

Request object for the create backup request.

Name Description Schema

backupName
optional

Specified name for the backup. If not set, the name will be blank.

string

namespaceName
optional

DEPRECATED in favor of the namespaceNames. Namespace of the potential candidate for backup. If not set, all of the Data Warehouse namespaces will be backed up.

string

namespaceNames
optional

If both namespaceName and namespaceNames are set, the namespaceName will be ignored! A list of namespace of the potential candidates for backup. If not set, all of the Data Warehouse namespaces will be backed up.

< string > array

CreateBackupResponse

Response object for the create backup request.

Name Description Schema

backupCrn
required

The CRN the backup.

string

CreateClusterDiagnosticDataJobRequest

Request object for the createClusterDiagnosticDataJob method.

Name Description Schema

bundleMetadata
optional

Additional user-defined metadata information that is attached to the resulting bundle-info.json when posting the bundle.

< string, string > map

caseNumber
optional

Optional support case number in case of UPLOAD_TO_CLOUDERA destination, otherwise only act as additional data.

string

clusterId
required

ID of the Cluster.

string

destination
required

Destination of the diagnostics collection.

enum (UPLOAD_TO_CLOUDERA, DOWNLOAD)

downloadOptions
optional

Cluster diagnostic options. If not provided, everything will be included in the Diagnostic Data.

endTime
optional

The resulting bundle will contain logs/metrics before the specified end time. If not indicated, then the current time is taken as the end time.

string (date-time)

force
optional

Forced recreation of the diagnostic job.
Default : false

boolean

startTime
optional

The resulting bundle will contain logs/metrics after the specified start time. If not indicated, then 30 minutes ago from now is taken as the start time.

string (date-time)

CreateClusterDiagnosticDataJobResponse

Response object for the createClusterDiagnosticDataJob method.

Name Description Schema

id
optional

Identifier for each bundle collection.

string

labels
optional

Additional key-value pair attributes associated with the Diagnostic Data Job.

< string, string > map

status
optional

Status of the diagnostics collection request.

string

url
optional

This URL points to a download location if the destination is DOWNLOAD.

string

CreateClusterRequest

Request object for the createCluster method.

Name Description Schema

awsOptions
optional

Options for activating an AWS environment.

azureOptions
optional

Options for activating an Azure environment.

customRegistryOptions
optional

Options for custom ACR/ECR/Docker registries.

customSubdomain
optional

Custom environment subdomain. Overrides the environment subdomain using a customized domain either in the old subdomain format like ENV_ID.dw or the new format like dw-ENV_NAME.

string

databaseBackupRetentionPeriod
optional

PostgreSQL server backup retention days.
Default : 30

integer (int32)

enableStorageRoles
optional

DEPRECATED - Enable Storage Roles
Default : false

boolean

environmentCrn
required

The CRN of the environment for the cluster to create.

string

privateCloudOptions
optional

Options for activating a Private Cloud environment.

reservedComputeNodes
optional

Set additional number of nodes to reserve for executors and coordinators to use during autoscaling. Adding more reserved nodes increases your cloud costs.

integer (int32)

reservedSharedServicesNodes
optional

Set additional number of nodes to reserve for other services in the cluster. Adding more reserved nodes increases your cloud costs.

integer (int32)

resourcePool
optional

The Resource Pool of the cluster.

string

useOverlayNetwork
optional

Using an overlay network will save IP addresses in the VPC by using a private IP address range for Pods in the cluster.

boolean

usePrivateLoadBalancer
optional

Set up load balancer with private IP address. In AWS it is created in private subnets. In Azure an internal load balancer gets created. Make sure there is connectivity between your client network and the network (VPC/VNet) where CDW environment is deployed.

boolean

usePublicWorkerNode
optional

Set up worker node with public IP address. In AWS it is created in public subnets.

boolean

whitelistIpCIDRs
optional

This field is still available for Private Cloud deployments, however it’ll be removed for Public Cloud in the next DWX release. Please use the use 'whitelistK8sClusterAccessIpCIDRs' in combination of 'whitelistWorkloadAccessIpCIDRs' on Public Cloud. Comma separated list of IP address CIDRs to whitelist.

string

whitelistK8sClusterAccessIpCIDRs
optional

List of IP address CIDRs to whitelist for kubernetes cluster access.

< string > array

whitelistWorkloadAccessIpCIDRs
optional

List of IP address CIDRs to whitelist for workload access.

< string > array

CreateClusterResponse

Response object for the createCluster method.

Name Description Schema

clusterId
optional

ID of new cluster.

string

CreateDataVisualizationRequest

Request object for the createDataVisualization call.

Name Description Schema

clusterId
required

ID of cluster where Cloudera Data Visualization should be created.

string

config
required

The LDAP admin and user group configuration for Cloudera Data Visualization.

imageVersion
optional

Version of the Cloudera Data Visualization.

string

name
required

Name of the Cloudera Data Visualization

string

templateName
optional

The template size for the Cloudera Data Visualization.

string

CreateDataVisualizationResponse

Response object for the createDataVisualization method.

Name Description Schema

dataVisualizationId
optional

ID of the new Cloudera Data Visualization.

string

CreateDbcDiagnosticDataJobRequest

Request object for the createDbcDiagnosticDataJob method.

Name Description Schema

bundleMetadata
optional

Additional user-defined metadata information which is attached to resulting bundle-info.json when posting the bundle.

< string, string > map

caseNumber
optional

Optional support case number in case of UPLOAD_TO_CLOUDERA destination, otherwise only act as additional data.

string

clusterId
required

ID of cluster.

string

dbcId
required

ID of the Database Catalog.

string

destination
required

Destination of the diagnostics collection.

enum (UPLOAD_TO_CLOUDERA, DOWNLOAD)

downloadOptions
optional

Database Catalog diagnostic options. If not provided, everything will be included in the Diagnostic Data.

endTime
optional

The resulting bundle will contain logs/metrics before the specified end time. If not indicated, then the current time is taken as the end time.

string (date-time)

force
optional

Forced recreation of the diagnostic job.
Default : false

boolean

startTime
optional

The resulting bundle will contain logs/metrics after the specified start time. If not indicated, then 30 minutes ago from now is taken as the start time.

string (date-time)

CreateDbcDiagnosticDataJobResponse

Response object for the createDbcDiagnosticDataJob method.

Name Description Schema

id
optional

Identifier for each bundle collection.

string

labels
optional

Additional key-value pair attributes associated with the Diagnostic Data Job.

< string, string > map

status
optional

Status of the diagnostics collection request.

string

url
optional

This URL points to a download location if the destination is DOWNLOAD.

string

CreateDbcRequest

Request object for the createDbc method.

Name Description Schema

clusterId
required

ID of cluster where Database Catalog should be created.

string

dbDas
optional

The name of the DAS database. Not required for embedded databases.
Default : ""

string

dbHue
optional

The name of the HUE database. Not required for embedded databases.
Default : ""

string

dbMetastore
optional

The name of the Metastore database.
Default : ""

string

imageVersion
optional

Version of the Database Catalog.
Default : ""

string

isDefault
optional

Note
creating Default Database Catalogs is deprecated and explicitly disabled. Denotes if Default Database Catalog creation needed.
Default : false

boolean

loadDemoData
optional

Load demo data into the Database Catalog?

boolean

memorySize
optional

Set Metastore container memory size. If not provided, small will apply.

enum (small, medium, large)

name
required

Name of the Database Catalog.

string

CreateDbcResponse

Response object for the createDbc method.

Name Description Schema

dbcId
optional

ID of the new Database Catalog.

string

CreateVwDiagnosticDataJobRequest

Request object for the createVwDiagnosticDataJob method.

Name Description Schema

bundleMetadata
optional

Additional user-defined metadata information which is attached to resulting bundle-info.json when posting the bundle.

< string, string > map

caseNumber
optional

Optional support case number in case of UPLOAD_TO_CLOUDERA destination, otherwise only act as additional data.

string

clusterId
required

ID of cluster.

string

destination
required

Destination of the diagnostics collection.

enum (UPLOAD_TO_CLOUDERA, DOWNLOAD)

endTime
optional

The resulting bundle will contain logs/metrics before the specified end time. If not indicated, then the current time is taken as the end time.

string (date-time)

force
optional

Forced recreation of the diagnostic job.
Default : false

boolean

hiveDownloadOptions
optional

Hive diagnostic options. If not provided, everything will be included into the Diagnostic Data.

impalaDownloadOptions
optional

Impala diagnostic options. If not provided, everything will be included into the Diagnostic Data.

startTime
optional

The resulting bundle will contain logs/metrics after the specified start time. If not indicated, then 30 minutes ago from now is taken as the start time.

string (date-time)

vwId
required

ID of the Virtual Warehouse.

string

CreateVwDiagnosticDataJobResponse

Response object for the createVwDiagnosticDataJob method.

Name Description Schema

id
optional

Identifier for each bundle collection.

string

labels
optional

Additional key-value pair attributes associated with the Diagnostic Data Job.

< string, string > map

status
optional

Status of the diagnostics collection request.

string

url
optional

This URL points to a download location if the destination is DOWNLOAD.

string

CreateVwRequest

Request object for the createVw method.

Name Description Schema

autoscaling
optional

Autoscaling settings for the Virtual Warehouse.

availabilityZone
optional

This feature works only for AWS cluster type. An availability zone to host compute instances. If not specified, defaults to a randomly selected availability zone inferred from available subnets. In order to query possible options, see "availabilityZones" field of describe-cluster or list-clusters command response.

string

clusterId
required

ID of cluster where Virtual Warehouse should be created.

string

config
optional

Configuration settings for the Virtual Warehouse.

dbcId
required

ID of Database Catalog that the Virtual Warehouse should be attached to.

string

enableUnifiedAnalytics
optional

Enable Unified Analytics. In the case of Hive Virtual Warehouses, this cannot be provided, because this value is inferred. In the case of Impala, this can be set. Passing –query-isolation-options will be considered only if this flag is set to true. If Unified Analytics is enabled then the "enableShutdownOfCoordinator" in –impala-ha-settings is explicitly disabled (ignored) and should not be provided, furthermore the "highAvailabilityMode" in –impala-ha-settings cannot be set to ACTIVE_ACTIVE.

boolean

hiveAuthenticationMode
optional

DEPRECATED - Sets the authentication mode to use by Hive Server: * LDAP * KERBEROS Default: LDAP if not specified

string

imageVersion
optional

version of the Virtual Warehouse.
Default : ""

string

impalaHaSettings
optional

High Availability settings for the Impala Virtual Warehouse. NOTE that in –autoscaling object you should avoid using the same deprecated properties because only the –impala-ha-setting properties will be considered if any of its values are set.

impalaOptions
optional

Impala specific options. It cannot be provided for Virtual Warehouse types other than Impala.

name
required

Name of the Virtual Warehouse.

string

nodeCount
optional

Nodes per compute cluster. If specified, forces 'template' to be 'custom'
Default : 0

integer (int32)

platformJwtAuth
optional

Value of 'true' automatically configures the Virtual Warehouse to support JWTs issues by the CDP JWT token provider. Value of 'false' does not enable JWT auth on the Virtual Warehouse. If this field is not specified, it defaults to 'false'.
Default : false

boolean

queryIsolationOptions
optional

Query isolation settings for the Virtual Warehouse. For Impala this value will be considered only if Unified Analytics is enabled.

resourcePool
optional

The Resource Pool of the Virtual Warehouse.

string

tags
optional

Tags associated with the resources.

< TagRequest > array

template
optional

Name of configuration template to use.

enum (xsmall, small, medium, large)

vwType
required

Type of Virtual Warehouse to be created.

CreateVwResponse

Response object for the createVw method.

Name Description Schema

vwId
optional

ID of the new Virtual Warehouse.

string

CustomRegistryOptions

Options for custom ACR, ECR, or Docker registry.

Name Description Schema

disableImageVerification
optional

Disable image verification.

boolean

password
optional

Password for custom registry access (required only for Docker type).

string

registryType
optional

Custom registry type.

enum (ACR, ECR, Docker)

repositoryUrl
optional

URL of the custom image repository.

string

userName
optional

Username for custom registry access (required only for Docker type).

string

DBCCreateDiagnosticDataDownloadOptions

Flags that denote which diagnostics to include for a Database Catalog.

Name Description Schema

includeKubernetesResourceInfo
optional

Include kubernetes resource info.
Default : false

boolean

DataVisualizationSummary

A Cloudera Data Visualization.

Name Description Schema

adminGroups
optional

Admin groups that are allowed to access the Data Visualization.

< string > array

creatorCrn
optional

The CRN of the user who created the Cloudera Data Visualization

string

id
optional

The ID of the Cloudera Data Visualization.

string

imageVersion
optional

Current image version of the Cloudera Data Visualization

string

name
optional

The name of the Cloudera Data Visualization.

string

resourcePool
optional

The name of the Resource Pool the Cloudera Data Visualization is in.

string

size
optional

The template size for the Cloudera Data Visualization

string

status
optional

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

string

userGroups
optional

User groups that are allowed to access the Data Visualization.

< string > array

DbcDiagnosticDataJob

Represents a Diagnostic Data Job

Name Description Schema

endTime
optional

The finish time of the Diagnostic Data Job.

string (date-time)

jobId
optional

The unique identifier of the Diagnostic Data Job.

string

labels
optional

Additional key-value pair attributes associated with the Diagnostic Data Job.

< string, string > map

startTime
optional

The start time of the Diagnostic Data Job.

string (date-time)

status
optional

The job status.

url
optional

This URL points to a download location if the destination is DOWNLOAD.

string

DbcSummary

A Database Catalog.

Name Description Schema

creationDate
optional

Creation date of Database Catalog.

string (date-time)

creator
optional

The creator of the Database Catalog.

crn
optional

The CRN of the Database Catalog.

string

id
optional

The ID of the Database Catalog.

string

memorySize
optional

Metastore container memory size.

string

name
optional

The name of the Database Catalog.

string

resourcePool
optional

The name of the Resource Pool the Database Catalog is in.

string

status
optional

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

string

statusChangedAt
optional

Timestamp of the last status change of the Database Catalog.

string (date-time)

DeleteBackupRequest

Request object for the delete backup request.

Name Description Schema

backupCrn
required

The CRN of the backup.

string

DeleteBackupResponse

Response object for the delete backup request.

Name Description Schema

deleteBackupCrn
required

The CRN of the delete backup custom resource.

string

DeleteClusterDiagnosticDataJobRequest

Request object for the deleteClusterDiagnosticDataJob method.

Name Description Schema

clusterId
required

ID of the Cluster.

string

jobId
required

ID of the diagnostic job.

string

DeleteClusterDiagnosticDataJobResponse

Response object for the deleteClusterDiagnosticDataJob method.

Type : object

DeleteClusterRequest

Request object for the deleteCluster method.

Name Description Schema

clusterId
required

The ID of the cluster to delete.

string

force
optional

Force delete means CDW will delete the cluster even if there are attached DB Catalogs and Virtual Warehouses. All managed data will be lost and will not be recoverable. Force delete attempts all steps of the deletion even if previous steps have failed. NOTICE: Be aware that a Force delete may not remove all resources due to cloud provider constraints. Should this happen, it is responsibility of the user to ensure the impacted resources are deleted on the cloud provider.
Default : false

boolean

DeleteClusterResponse

Response object for the deleteCluster method.

Type : object

DeleteDataVisualizationRequest

Request object for the deleteDataVisualization method.

Name Description Schema

clusterId
required

ID of the Cloudera Data Visualization’s cluster.

string

dataVisualizationId
required

ID of the Cloudera Data Visualization to delete from the cluster.

string

DeleteDataVisualizationResponse

Response object for the deleteDataVisualization method.

Name Description Schema

status
optional

The status of asynchronous delete request for Cloudera Data Visualization. To find the latest status please use describe-data-visualization. Once the Data Visualization is deleted, the describe-data-visualization would return a not found error.

string

DeleteDbcDiagnosticDataJobRequest

Request object for the deleteDbcDiagnosticDataJobRequest method.

Name Description Schema

clusterId
required

ID of cluster.

string

dbcId
required

ID of the Database Catalog.

string

jobId
required

ID of the diagnostic job.

string

DeleteDbcDiagnosticDataJobResponse

Response object for the deleteDbcDiagnosticDataJobRequest method.

Type : object

DeleteDbcRequest

Request object for the deleteDbc method.

Name Description Schema

clusterId
required

ID of the Database Catalog’s cluster.

string

dbcId
required

ID of the Database Catalog to delete.

string

DeleteDbcResponse

Response object for the deleteDbc method.

Type : object

DeleteUserRequest

Request object for the deleteUser method.

Name Description Schema

clusterId
required

The ID of the cluster from which the user must be deleted.

string

userId
required

A cloud based unique identifier of the user (ARN for AWS users, groupId for Azure users).

string

DeleteUserResponse

Response object for the deleteUser method.

Type : object

DeleteVwDiagnosticDataJobRequest

Request object for the deleteVwDiagnosticDataJobRequest method.

Name Description Schema

clusterId
required

ID of cluster.

string

jobId
required

ID of the diagnostic job.

string

vwId
required

ID of the Virtual Warehouse.

string

DeleteVwDiagnosticDataJobResponse

Response object for the deleteVwDiagnosticDataJobRequest method.

Type : object

DeleteVwRequest

Request object for the deleteVw method.

Name Description Schema

clusterId
required

ID of the Virtual Warehouse’s cluster.

string

vwId
required

ID of the Virtual Warehouse to delete.

string

DeleteVwResponse

Response object for the deleteVw method.

Type : object

DescribeAllowedInstanceTypesRequest

Request object for the describeAllowedInstanceTypes method.

Type : object

DescribeAllowedInstanceTypesResponse

Response object for the describeAllowedInstanceTypes method.

Name Description Schema

aws
optional

Instance type settings that are being used during cluster creation command on the AWS platform

azure
optional

Instance type settings that are being used during cluster creation command on the Azure platform

DescribeBackupRequest

Request object for the describe backup request.

Name Description Schema

backupCrn
required

The CRN of the backup.

string

DescribeBackupResponse

Response object for the describe backup request.

Name Description Schema

backup
required

The backup details.

DescribeClusterDiagnosticDataJobRequest

Request object for the describeClusterDiagnosticDataJob method.

Name Description Schema

clusterId
required

ID of the Cluster.

string

jobId
required

ID of the diagnostic job.

string

DescribeClusterDiagnosticDataJobResponse

Response object for the describeClusterDiagnosticDataJob method.

Name Description Schema

job
optional

The job belonging to the particular Cluster.

DescribeClusterRequest

Request object for the describeCluster method. Use only one of environmentName, clusterCrn and clusterId.

Name Description Schema

clusterId
required

The ID of the cluster to describe.

string

DescribeClusterResponse

Response object for the describeCluster method.

Name Description Schema

cluster
optional

The cluster.

DescribeConfigDiffRequest

Request object for the describeConfigDiff method.

Name Description Schema

clusterId
required

ID of the cluster.

string

fromConfigId
required

ID of the old service configuration.

string

toConfigId
required

ID of the new service configuration.

string

DescribeConfigDiffResponse

Response object for the describeConfigDiff method.

Name Description Schema

config
optional

The service configuration.

DescribeConfigRequest

Request object for the describeConfig method.

Name Description Schema

clusterId
required

ID of the cluster.

string

configId
required

ID of the service (Database Catalog or Virtual Warehouse).

string

DescribeConfigResponse

Response object for the describeConfig method.

Name Description Schema

config
optional

The service configuration.

DescribeDataVisualizationRequest

Request object for the describeDataVisualization method.

Name Description Schema

clusterId
required

ID of the Cloudera Data Visualization’s cluster.

string

dataVisualizationId
required

ID of the Cloudera Data Visualization

string

DescribeDataVisualizationResponse

Response object for the describeDataVisualization method.

Name Description Schema

dataVisualization
optional

The Cloudera Data Visualization.

DescribeDbcConfigRequest

Request object for the describeDbcConfig method.

Name Description Schema

clusterId
required

ID of the cluster.

string

dbcId
required

ID of the Database Catalog.

string

DescribeDbcConfigResponse

Response object for the describeDbcConfig method.

Name Description Schema

config
optional

The Database Catalog configuration.

DescribeDbcDiagnosticDataJobRequest

Request object for the describeDbcDiagnosticDataJobRequest method.

Name Description Schema

clusterId
required

ID of cluster.

string

dbcId
required

ID of the Database Catalog.

string

jobId
required

ID of the diagnostic job.

string

DescribeDbcDiagnosticDataJobResponse

Response object for the describeDbcDiagnosticDataJobRequest method.

Name Description Schema

job
optional

The job belonging to the particular Database Catalog

DescribeDbcRequest

Request object for the describeDbc method.

Name Description Schema

clusterId
required

ID of the Database Catalog’s cluster.

string

dbcId
required

ID of the Database Catalog.

string

DescribeDbcResponse

Response object for the describeDbc method.

Name Description Schema

dbc
optional

The Database Catalog.

DescribeKubeconfigRequest

Request object for the describeKubeconfig method.

Name Description Schema

clusterId
required

The ID of the cluster to describe.

string

DescribeKubeconfigResponse

Response object for the describeKubeconfig method.

Name Description Schema

kubeconfig
optional

The kubeconfig.

string

DescribeRestoreRequest

Request object for the describe restore request.

Name Description Schema

restoreCrn
required

The CRN of the restore.

string

DescribeRestoreResponse

Response object for the describe restore request.

Name Description Schema

restore
required

The restore details.

DescribeServerSettingItem

A DWX server setting.

Name Description Schema

configurationKey
optional

The identifier of the setting.

string

configurationName
optional

The name of the setting in human readable format.

string

description
optional

The description of the setting.

string

enabled
optional

The state of the setting.

boolean

requiresUpdate
optional

Indicates update requirements for the change to take effect.

DescribeServerSettingItemRequiresUpdate

Indicates an update requirement for the change to take effect. ENVIRONMENT - Means that the environments need to be updated/recreated for the setting change to take effect. DBC - Means that the Database Catalogs need an update/recreation. VW - Means that the Virtual Warehouses need the update/recreation. VIZ - Means that the Dataviz need the update/recreation.

Type : enum (ENVIRONMENT, DBC, VW, VIZ)

DescribeServerSettingRequest

Request object for the describeServerSetting method.

Type : object

DescribeServerSettingResponse

Response object for the describeServerSetting method.

Name Description Schema

settings
optional

The list of the server settings.

DescribeVwConfigRequest

Request object for the describeVwConfig method.

Name Description Schema

clusterId
required

ID of the cluster.

string

vwId
required

ID of the Virtual Warehouse.

string

DescribeVwConfigResponse

Response object for the describeVwConfig method.

Name Description Schema

config
optional

The Virtual Warehouse configuration.

DescribeVwDiagnosticDataJobRequest

Request object for the describeVwDiagnosticDataJobRequest method.

Name Description Schema

clusterId
required

ID of cluster.

string

jobId
required

ID of the diagnostic job.

string

vwId
required

ID of the Virtual Warehouse.

string

DescribeVwDiagnosticDataJobResponse

Response object for the describeVwDiagnosticDataJobRequest method.

Name Description Schema

job
optional

The job belonging to the particular Virtual Warehouse.

DescribeVwRequest

Request object for the describeVw method.

Name Description Schema

clusterId
required

ID of the Virtual Warehouse’s cluster.

string

vwId
required

ID of the Virtual Warehouse.

string

DescribeVwResponse

Response object for the describeVw method.

Name Description Schema

vw
optional

The Virtual Warehouse.

DiagnosticDataJobStatus

Represents the possible status values of a Diagnostic Data Job.

Type : enum (Starting, Succeeded, Failed, Running, Unknown, Deleted)

Error

An object returned on an error.

Name Description Schema

code
optional

The error code.

string

message
optional

The error message.

string

Event

Represents a Event.

Name Description Schema

event
optional

The name of the event.

string

message
optional

Detailed message.

string

operationId
optional

The ID of the operation to which the event belongs.

string

serviceId
optional

The ID of the service to which the event belongs.

string

timestamp
optional

The timestamp of the event.

string (date-time)

EventResponse

Represents a Event

Name Description Schema

event
optional

The code name of the event

string

message
optional

Detailed message

string

timestamp
optional

The timestamp of the event

string (date-time)

ExternalBucket

External bucket details.

Name Description Schema

accessInfo
optional

AccessInfo of the bucket.

name
optional

Name of the bucket.

string

ExternalBucketAccessInfo

External bucket definition.

Name Description Schema

accessMode
optional

Specifies whether the external bucket will be added in read-only or read-write mode.

enum (READ, READWRITE)

kmsCmkArn
optional

Enable server side encryption with the specified KMS CMK ARN. If the value is empty or unspecified, default server side encryption will be used when the access mode is read-write. Otherwise this value is ignored.

string

GetDataVisualizationUpgradeVersionRequest

Request object for the getDataVisualizationUpgradeVersion method.

Name Description Schema

clusterId
required

ID of the Cloudera Data Visualization’s cluster.

string

dataVisualizationId
required

ID of the Cloudera Data Visualization.

string

GetDataVisualizationUpgradeVersionResponse

Response object for the getDataVisualizationUpgradeVersion method.

Name Description Schema

upgradeVersions
optional

Details of upgrade versions.

GetLogsRequest

Request object for the get logs request.

Name Description Schema

crn
required

The CRN of the backup, restore or backup deletion.

string

GetLogsResponse

Response object for the get logs request.

Name Description Schema

logs
required

Contains the logs of the operation.

string

GetUpgradeDbcVersionsRequest

Request object for the getUpgradeDbcVersions method.

Name Description Schema

clusterId
required

The ID of the Database Catalog’s cluster.

string

dbcId
required

The ID of the Database Catalog.

string

GetUpgradeDbcVersionsResponse

Response object for the getUpgradeDbcVersions method.

Name Description Schema

compatibleCDPVersion
optional

The latest compatible CDP version.

string

compatibleVersion
optional

The latest compatible CDW version.

string

latestCDPVersion
optional

The latest available CDP version.

string

latestVersion
optional

The latest available CDW version.

string

GetUpgradeVwVersionsRequest

Request object for the getUpgradeVwVersions method.

Name Description Schema

clusterId
required

The ID of the Virtual Warehouse’s cluster.

string

vwId
required

The ID of the Virtual Warehouse.

string

GetUpgradeVwVersionsResponse

Response object for the getUpgradeVwVersions method.

Name Description Schema

compatibleCDPVersion
optional

The latest compatible CDP version.

string

compatibleVersion
optional

The latest compatible CDW version.

string

latestCDPVersion
optional

The latest available CDP version.

string

latestVersion
optional

The latest available CDW version.

string

HealthCheckRequest

Request object for the healthCheck method.

Type : object

HealthCheckResponse

Response object for the healthCheck method.

Name Description Schema

message
optional

HealthCheck status text.

string

HiveCreateDiagnosticDataDownloadOptions

Flags that denote which diagnostics to include for a Hive Virtual Warehouse.

Name Description Schema

includeComputeResourceInfo
optional

Include compute resource info.
Default : false

boolean

includeErrordump
optional

Include the error dump.
Default : false

boolean

includeGclogs
optional

Include the Garbage collector logs.
Default : false

boolean

includeHeapdump
optional

Include the heap-dump.
Default : false

boolean

includeHms
optional

Include the HMS diagnostics.
Default : false

boolean

includeKubernetesResourceInfo
optional

Include Kubernetes resource info.
Default : false

boolean

includeLogs
optional

Include logs.
Default : false

boolean

ImpalaCreateDiagnosticDataDownloadOptions

Flags that denote which diagnostics to include for an Impala Virtual Warehouse.

Name Description Schema

includeHms
optional

Include the HMS diagnostics.
Default : false

boolean

includeKubernetesResourceInfo
optional

Include kubernetes resource info.
Default : false

boolean

includeMinidump
optional

Include the minidump.
Default : false

boolean

includeProfile
optional

Include the profile.
Default : false

boolean

includeSidecar
optional

Include the sidecar diagnostics.
Default : false

boolean

includeWorkload
optional

Include the workload diagnostics.
Default : false

boolean

ImpalaHASettingsCreateRequest

High Availability settings for the Impala Virtual Warehouse. The values are disregarded for Hive.

Name Description Schema

enableCatalogHighAvailability
optional

Enables a backup instance for Impala catalog to ensure high availability.

boolean

enableShutdownOfCoordinator
optional

Enables a shutdown of the coordinator. If Unified Analytics is enabled, then this setting is explicitly disabled (ignored) and should not be provided.

boolean

highAvailabilityMode
optional

Set High Availability mode. If not provided, the default will apply. DISABLED - Disables Impala coordinator and Database Catalog high availability. ACTIVE_PASSIVE - Runs multiple coordinators (one active, one passive) and Database Catalogs (one active, one passive). ACTIVE_ACTIVE - Runs multiple coordinators (both active) and Database Catalogs (one active, one passive). If Unified Analytics is enabled, then this cannot be set to ACTIVE_ACTIVE.

numOfActiveCoordinators
optional

The number of active coordinators.

integer (int32)

shutdownOfCoordinatorDelaySeconds
optional

Delay in seconds before the shutdown of coordinator event happens.

integer (int32)

ImpalaHASettingsOptionsResponse

Impala High Availability settings for a Virtual Warehouse.

Name Description Schema

enableCatalogHighAvailability
optional

Denotes whether a backup instance for Impala catalog is enabled.

boolean

enableShutdownOfCoordinator
optional

Whether a shutdown of the coordinator is enabled.

boolean

highAvailabilityMode
optional

High Availability mode. DISABLED - Impala coordinator and Database Catalog high availability is disabled. ACTIVE_PASSIVE - Multiple coordinators (one active, one passive) and Database Catalogs (one active, one passive) are run. ACTIVE_ACTIVE - Multiple coordinators (both active) and Database Catalogs (one active, one passive) are run.

numOfActiveCoordinators
optional

Number of the active coordinators.

integer (int32)

shutdownOfCoordinatorDelaySeconds
optional

Delay in seconds before the shutdown of coordinator event happens.

integer (int32)

ImpalaHASettingsUpdateRequest

High Availability settings update options for the Impala Virtual Warehouse.

Name Description Schema

numOfActiveCoordinators
optional

The number of active coordinators.

integer (int32)

shutdownOfCoordinatorDelaySeconds
optional

Delay in seconds before the shutdown of coordinator event happens.

integer (int32)

ImpalaHighAvailabilityMode

Set Impala High Availability mode. If not provided, the default will apply. DISABLED - Disables Impala coordinator and Database Catalog high availability. ACTIVE_PASSIVE - Runs multiple coordinators (one active, one passive) and Database Catalogs (one active, one passive). ACTIVE_ACTIVE - Runs multiple coordinators (both active) and Database Catalogs (one active, one passive). If Unified Analytics is enabled, then this cannot be set to ACTIVE_ACTIVE.

Type : enum (ACTIVE_PASSIVE, ACTIVE_ACTIVE, DISABLED)

ImpalaOptionsCreateRequest

Impala specific options. It cannot be provided for Virtual Warehouse types other than Impala.

Name Description Schema

scratchSpaceLimit
optional

Defines the limit for scratch space in GiB needed by Impala for spilling queries. If this is set, "spillToS3Uri" cannot be set. The valid values are between 1-16000 for AWS and 1-16684 for Azure. It will choose the first valid value for which the total disk space is greater than or equal to the specified scratch space limit. The valid scratch space limit values per node in GiBs for AWS are [300, 634, 968, 1302, 1636, 1970, 2304, 2638, 2972, 6550, 7000, 8000, 9000, 10000, 11000, 12000, 13000, 14000, 15000, 16000]. Valid values for Azure are [300, 684, 812, 1068, 1324, 1836, 2348, 3372, 4396, 8492, 16684].

integer (int32)

spillToS3Uri
optional

Set S3 URI in "s3://bucket/path" format and enable spilling to S3. If this is set, "scratchSpaceLimit" cannot be set. Spilling to a remote storage is not supported on Azure, it is available on AWS and PvC platforms. If your workload results in large volumes of intermediate data being written, it is recommended to configure the heavy spilling queries to use a remote storage location rather than the local one since Impala occasionally needs to use persistent storage for writing intermediate files during large sorts, joins, aggregations, or analytic function operations. Note that this value is ignored if the Impala version does not support spilling to S3.

string

ImpalaOptionsResponse

Impala specific settings.

Name Description Schema

scratchSpaceLimit
optional

Maximum scratch space used for spilling to disk.

integer (int32)

spillToS3Uri
optional

Impala spill to S3 URI.

string

KeyValuesDiff

Different between keyValues of two ConfigContents.

Name Description Schema

added
optional

Keys that are only present in the new configuration.

< string, string > map

changed
optional

Keys with different values.

< string, StringDiff > map

removed
optional

Keys that are only present in the old configuration.

< string, string > map

same
optional

Keys that are present in both configurations.

< string, string > map

ListBackupEntitiesRequest

Request object for the list backup entities request.

Type : object

ListBackupEntitiesResponse

Response object for the list backup entities request.

Name Description Schema

items
required

A list of available namespaces for backup, corresponding to the CDW entities.

< string > array

ListBackupsRequest

Request object for the list backups request.

Name Description Schema

backupName
optional

Specified name for the backup. If not present, this filter is not used.

string

jobStates
optional

The job states we need to filter by. If not present, this filter is not used.

< string > array

ListBackupsResponse

Response object for the list backups request.

Name Description Schema

backups
required

List of backups.

< SimpleBackup > array

ListClusterDiagnosticDataJobsRequest

Request object for the listClusterDiagnosticDataJobs method.

Name Description Schema

clusterId
required

ID of the Cluster.

string

pageSize
optional

The size of each page.
Minimum value : 1
Maximum value : 100

integer (int32)

startingToken
optional

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

string

status
optional

Filter for job status, only those jobs will be returned which have the given status.

ListClusterDiagnosticDataJobsResponse

Response object for the listClusterDiagnosticDataJobs method.

Name Description Schema

jobs
optional

The list of jobs belonging to the particular cluster.

nextToken
optional

The token to use when requesting the next set of results. If there are no additional results, the string is empty.

string

ListClustersRequest

Request object for the listClusters method.

Name Description Schema

cloudPlatform
optional

Filter returned clusters by hosting platform.

enum (AWS, AZURE)

clusterId
optional

Filter returned clusters by cluster ID.

string

environmentCrn
optional

Filter returned clusters for the belonging Environment CRN.

string

name
optional

Filter returned clusters by name.

string

status
optional

Filter returned clusters by cluster status.

enum (Creating, Created, Accepted, Starting, Running, Stopping, Stopped, Updating, PreUpdate, PreUpgrade, Restarting, Deleting, Upgrading, Waiting, Error, Failed)

ListClustersResponse

Response object for the listClusters method.

Name Description Schema

clusters
optional

The list of clusters.

ListDataVisualizationsRequest

Request object for the listDataVisualizations method.

Name Description Schema

clusterId
required

ID of cluster to list Cloudera Data Visualizations.

string

ListDataVisualizationsResponse

Response object for the listDataVisualizations method.

Name Description Schema

dataVisualizations
optional

The list of Cloudera Data Visualizations.

ListDbcConfigsRequest

Request object for the listDbcConfigs method.

Name Description Schema

clusterId
required

ID of the Database Catalog’s cluster.

string

dbcId
required

ID of the Database Catalog.

string

ListDbcConfigsResponse

Response object for the listDbcConfigs method.

Name Description Schema

configHistory
optional

Configuration history of a service.

< ConfigHistoryItem > array

ListDbcDiagnosticDataJobsRequest

Request object for the listDbcDiagnosticDataJobsRequest method.

Name Description Schema

clusterId
required

ID of cluster.

string

dbcId
required

ID of the Database Catalog.

string

pageSize
optional

The size of each page.
Minimum value : 1
Maximum value : 100

integer (int32)

startingToken
optional

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

string

status
optional

Filter for job type

ListDbcDiagnosticDataJobsResponse

Response object for the listDbcDiagnosticDataJobsRequest method.

Name Description Schema

jobs
optional

The list of the jobs belonging to the particular Database Catalog

nextToken
optional

The token to use when requesting the next set of results. If there are no additional results, the string is empty.

string

ListDbcEventsRequest

Request object for the listDbcEvents method.

Name Description Schema

ascending
optional

Provide the result in ascending order, default is descending.
Default : false

boolean

clusterId
required

ID of cluster.

string

dbcId
required

ID of the Database Catalog.

string

limit
optional

Limit the number of returned rows. If not specified all the events will be returned. Please note the DWX only stores the last 50 events.

integer (int32)

ListDbcEventsResponse

Response object for the listDbcEvents method.

Name Description Schema

events
optional

The list of the events belonging to the particular Database Catalog

< EventResponse > array

ListDbcsRequest

Request object for the listDbcs method.

Name Description Schema

clusterId
required

ID of cluster to list.

string

ListDbcsResponse

Response object for the listDbcs method.

Name Description Schema

dbcs
optional

The list of Database Catalogs.

< DbcSummary > array

ListEventsRequest

Request object for the listEvents method.

Name Description Schema

ascending
optional

Provide the result in ascending order, default is descending.
Default : false

boolean

limit
optional

Limit the number of returned rows. If not specified then the recent 20 events will be returned. The maximum is 100.

integer (int32)

operationId
optional

Filter events based on the operation ID. Either operation ID or service ID is required.

string

serviceId
optional

Filter events based on the service ID. It can be Cluster ID, Database Catalog ID, Virtual Warehouse ID or Data Visualization App ID.

string

ListEventsResponse

Response object for the listEvents method.

Name Description Schema

events
optional

List of the events.

< Event > array

ListLatestVersionsRequest

Request object of the listLatestVersions call.

Name Description Schema

clusterId
required

The ID of the cluster from which the version information must be collected.

string

ListLatestVersionsResponse

Response object of the listLatestVersions call.

Name Description Schema

idToLatestVersionsMap
optional

Map containing the latest image versions for each Virtual Warehouse found in the cluster.

< string, string > map

ListRestoresRequest

Request object for the list restores request.

Name Description Schema

backupCrn
optional

CRN of the backup.

string

jobStates
optional

The job states to filter by.

< string > array

ListRestoresResponse

Response object for the list restores request.

Name Description Schema

restores
required

List of restores for the control plane.

< SimpleRestore > array

ListUsersRequest

Request object for the listUsers method.

Name Description Schema

clusterId
required

The ID of the cluster for which the users must be retrieved.

string

ListUsersResponse

Response object for the listUsers method.

Name Description Schema

users
optional

The list of users allowed to access the given cluster.

< CloudUserReference > array

ListVwConfigsRequest

Request object for the listVwConfigs method.

Name Description Schema

clusterId
required

ID of the Virtual Warehouse’s cluster.

string

vwId
required

ID of the Virtual Warehouse.

string

ListVwConfigsResponse

Response object for the listVwConfigs method.

Name Description Schema

configHistory
optional

Configuration history of a service.

< ConfigHistoryItem > array

ListVwDiagnosticDataJobsRequest

Request object for the listVwDiagnosticDataJobsRequest method.

Name Description Schema

clusterId
required

ID of cluster.

string

pageSize
optional

The size of each page.
Minimum value : 1
Maximum value : 100

integer (int32)

startingToken
optional

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

string

status
optional

Filter for job type

vwId
required

ID of the Virtual Warehouse.

string

ListVwDiagnosticDataJobsResponse

Response object for the listVwDiagnosticDataJobsRequest method.

Name Description Schema

jobs
optional

The list of the jobs belonging to the particular Virtual Warehouse.

nextToken
optional

The token to use when requesting the next set of results. If there are no additional results, the string is empty.

string

ListVwEventsRequest

Request object for the listVwEvents method.

Name Description Schema

ascending
optional

Provide the result in ascending order, default is descending.
Default : false

boolean

clusterId
required

ID of cluster.

string

limit
optional

Limit the number of returned rows. If not specified all the events will be returned. Please note the DWX only stores the last 50 events.

integer (int32)

vwId
required

ID of the Virtual Warehouse.

string

ListVwEventsResponse

Response object for the listVwEvents method.

Name Description Schema

events
optional

The list of the events belonging to the particular Virtual Warehouse

< EventResponse > array

ListVwsRequest

Request object for the listVws method.

Name Description Schema

clusterId
required

ID of cluster to list.

string

filter
optional

Filter object for listVws method.

ListVwsResponse

Response object for the listVws method.

Name Description Schema

vws
optional

The list of Virtual Warehouses.

< VwSummary > array

Message

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

Name Description Schema

namespace
optional

The namespace that has the warning/error.

string

text
optional

The text message of the warning/error.

string

timestamp
optional

The time when the warning/error is hit.

string

PrivateCloudActivationOptions

Options for activating a Private Cloud environment.

Name Description Schema

dbDas
optional

The name of the DAS database. Not required for embedded databases

string

dbHue
optional

The name of the HUE database. Not required for embedded databases.

string

dedicatedExecutorNodes
optional

Enable to use dedicated nodes exclusively for executors and coordinators, and improve performance. You can enable this only if you reserved nodes while adding a CDP Private Cloud containerized ECS cluster. When disabled, non-compute pods such as MetaStore and Data Visualization can also use the reserved nodes.
Default : false

boolean

delegationPassword
required

Password of delegation user.

string

delegationUsername
required

Name of delegation user. This user is used between Hue - Impala to create a session, as Hue should not pass the user credentials, instead Hue authenticates with the delegation user, then this user will impersonate the logged in user. This means that the Delegation User and Password should be able to authenticate through LDAP.

string

securityContextConstraintName
optional

The name of the Hive Security Context Constraint.

string

storageClass
optional

The storage class for the Local Storage Operator.

string

QueryIsolationOptionsRequest

Configurations for Query Isolation.

Name Description Schema

maxNodesPerQuery
optional

Maximum Nodes Per Isolated Query. If not provided, 0 will be applied. The 0 value means the query isoltaion functionality will be disabled.
Default : 0

integer (int32)

maxQueries
optional

Maximum Concurrent Isolated Queries. If not provided, 0 will be applied. The 0 value means the query isoltaion functionality will be disabled.
Default : 0

integer (int32)

QueryIsolationOptionsResponse

Configurations for Query Isolation.

Name Description Schema

maxNodesPerQuery
optional

Maximum Nodes Per Isolated Query

integer (int32)

maxQueries
optional

Maximum Concurrent Isolated Queries

integer (int32)

RebuildDbcRequest

Request object for the rebuildDbc method.

Name Description Schema

clusterId
required

ID of the Database Catalog’s cluster.

string

dbcId
required

ID of the Database Catalog to rebuild.

string

RebuildDbcResponse

Response object for the rebuildDbc method.

Type : object

RebuildVwRequest

Request object for the rebuildVw method.

Name Description Schema

clusterId
required

ID of the Virtual Warehouse’s cluster.

string

vwId
required

ID of the Virtual Warehouse to rebuild.

string

RebuildVwResponse

Response object for the rebuildVw method.

Type : object

RenewCertificatesRequest

Request object for the renewCertificates method.

Name Description Schema

clusterId
required

The ID of the Azure cluster to renew certificates for.

string

RenewCertificatesResponse

Response object for the renewCertificates method.

Type : object

ReplicaStatus

Status information on the current state of replicas in the virtual warehouse.

Name Description Schema

readyCoordinatorReplicas
optional

Total number of ready coordinator replicas in the virtual warehouse. This number only contains the healthy executor replicas that have already started up and are ready to accept requests. If this number is less than the totalCoordinatorReplicas, then the virtual warehouse might still be starting up or there might be a problem scheduling these replicas.

integer (int32)

readyExecutorReplicas
optional

Total number of ready executor replicas in the virtual warehouse. This number only contains the healthy executor replicas that have already started up and are ready to accept requests. If this number is less than the totalExecutorReplicas, then the virtual warehouse might still be starting up or there might be a problem scheduling these replicas.

integer (int32)

totalCoordinatorReplicas
optional

Total number of coordinator replicas scheduled for the virtual warehouse. This number contains the number of coordinator replicas in pending state, as well as the replicas that are already running. If this number is zero, then the coordinator functionality is stopped.

integer (int32)

totalExecutorReplicas
optional

Total number of executor replicas scheduled for the virtual warehouse. This number contains the number of executor replicas in pending state, as well as the replicas that are already running. If this number is zero, then the executor functionality is stopped.

integer (int32)

RestartDbcRequest

Request object for the restartDbc method.

Name Description Schema

clusterId
required

ID of the Database Catalog’s cluster.

string

dbcId
required

The id of the Database Catalog to restart.

string

RestartDbcResponse

Response object for the restartDbc method.

Type : object

RestartVwRequest

Request object for the restartVw method.

Name Description Schema

clusterId
required

ID of the Virtual Warehouse’s cluster.

string

vwId
required

The id of the Virtual Warehouse to restart.

string

RestartVwResponse

Response object for the restartVw method.

Type : object

Restore

Restore entry

Name Description Schema

backupCrn
optional

The CRN of the backup.

string

errors
optional

The errors from restore job.

< Message > array

excludedResources
optional

The list of resources to be excluded in restore.

< string > array

includedNamespaces
optional

The list of namespaces to be included in restore.

< string > array

restoreCreationTime
optional

The time when the restore was created.

string

restoreCrn
optional

The CRN of the restore.

string

restoreJob
optional

The restore job name.

string

restoreJobState
optional

The current state of the restore job.

string

restorePhase
optional

The phase of the restore operation.

string

restoreUpdatedTime
optional

The updated time of the restore.

string

successConditions
optional

The list of conditions to be met for a successful restore.

< string > array

warnings
optional

The warnings from restore job.

< Message > array

RestoreBackupRequest

Request object for the restore backup request.

Name Description Schema

backupCrn
required

The CRN of the backup.

string

namespaceNames
optional

A list of namespaces of the potential candidates for restore. If not set, all of the Data Warehouse namespaces within the backup CRN will be restored.

< string > array

RestoreBackupResponse

Response object for the restore backup request.

Name Description Schema

restoreCrn
required

The CRN of the restore.

string

RestoreClusterEntityPlan

Entity status after the restore operation.

Name Description Schema

action
optional

The action associated with the plan. Possible actions: Create, Update, Skip

string

id
optional

The ID of the entity.

string

message
optional

The description of the plan.

string

ref
optional

The reference of the entity in the backup data.

string

RestoreClusterRequest

Request object for the restoreCluster method.

Name Description Schema

clusterId
required

The ID of the cluster.

string

data
required

Dump of configuration received by calling "dump-cluster" command.

string

RestoreClusterResponse

Response object for the restoreCluster method.

Name Description Schema

action
optional

The cluster action. Possible actions: Create, Skip

string

clusterId
optional

The ID of the cluster.

string

dbcRestorePlans
optional

Information about the restore-plan of the DbCatalogs.

hiveRestorePlans
optional

Information about the restore-plan of the Hive Virtual Warehouses.

hueRestorePlans
optional

Information about the restore-plan of Hue.

impalaRestorePlans
optional

Information about the restore-plan of the Impala Virtual Warehouses.

message
optional

The description of the cluster action.

string

operationId
optional

The ID of the restore operation.

string

vizRestorePlans
optional

Information about the restore-plan of the Data Visualization Apps.

ServiceConfigDiff

Differences between two service configurations.

Name Description Schema

applicationConfigsDiffs
optional

Differences between the application specific configurations.

< string, ApplicationConfigDiff > map

commonConfigsDiff
optional

Differences between the common configurations.

isChanged
optional

Has any of the configurations changed?

boolean

ServiceConfigReq

Configurations for a service (DBC or VW)

Name Description Schema

applicationConfigs
optional

Application specific configurations.

< string, ApplicationConfigReq > map

commonConfigs
optional

Configurations that are applied to every application in the service.

enableSSO
optional

Should SSO be enabled for this VW.

boolean

ldapGroups
optional

LDAP Groupnames to be enabled for auth.

< string > array

ServiceConfigResp

Configurations for a service (DBC or VW)

Name Description Schema

applicationConfigs
optional

Application specific configurations.

< string, ApplicationConfigResp > map

commonConfigs
optional

Configurations that are applied to every application in the service.

enableSSO
optional

Should SSO be enabled for this VW. This cannot be changed later.

boolean

ldapGroups
optional

List of LDAP Groupnames to be enabled for auth.

< string > array

SimpleBackup

A simple backup entry for listBackup usage

Name Description Schema

backupCreationTime
optional

The time when the backup was created.

string

backupCrn
optional

The CRN of the backup.

string

backupName
optional

The display name of the backup.

string

SimpleRestore

A simple Restore entry for listRestore Usage

Name Description Schema

backupCrn
optional

The CRN of the backup.

string

includedNamespaces
optional

The list of namespaces to be included in restore.

< string > array

restoreCreationTime
optional

The time when the restore was created.

string

restoreCrn
optional

The CRN of the restore.

string

StartVwRequest

The request object for the startVw method.

Name Description Schema

clusterId
required

The ID of the Virtual Warehouse cluster.

string

vwId
required

The ID of the Virtual Warehouse.

string

StartVwResponse

The response object for the startVw method.

Type : object

StringDiff

Difference between two strings.

Name Description Schema

from
required

The old value.

string

to
required

The new value.

string

SuspendDbcRequest

The request object for the suspendDbc method.

Name Description Schema

clusterId
required

The ID of the Database Catalog’s cluster.

string

dbcId
required

The ID of the Database Catalog to suspend.

string

SuspendDbcResponse

The response object for the suspendDbc method.

Type : object

SuspendVwRequest

The request object for the suspendVw method.

Name Description Schema

clusterId
required

The ID of the Virtual Warehouse cluster.

string

vwId
required

The ID of the Virtual Warehouse to suspend.

string

SuspendVwResponse

The response object for the suspendVw method.

Type : object

TagRequest

A key/value pair that can be attached to some resources.

Name Description Schema

key
required

The tag’s name.

string

value
required

The associated value of the tag.

string

TagResponse

A key/value pair attached to some resources.

Name Description Schema

key
required

The tag’s name.

string

value
required

The associated value of the tag.

string

UpdateClusterExternalBucketAccessInfo

Cluster external bucket definition to update.

Name Description Schema

accessMode
optional

Specifies whether the external bucket will be added in read-only or read-write mode.

enum (READ, READWRITE)

kmsCmkArn
optional

Enable server side encryption with the specified KMS CMK ARN. If the value is empty or unspecified, default server side encryption will be used when the access mode is read-write. Otherwise this value is ignored.

string

UpdateClusterObservabilityConfig

Cluster observability settings to update.

Name Description Schema

logsForwardingConfig
optional

Create the log forwarding configuration in a valid fluentd format. Then that configuration is later inserted into a larger fluentd configuration.

string

proxyCABundle
optional

Set the proxy CA certificates (PEM Bundle). If you use a TLS-terminating proxy server to inspect outbound internet traffic, you need to provide the proxy server’s CA certificates bundle in PEM bundle format when you configure log forwarding.

string

UpdateClusterRequest

Request object for the updateCluster method.

Name Description Schema

awsUpdate
optional

Additional properties for AWS clusters.

azureUpdate
optional

Additional properties for Azure clusters.

clusterId
required

The ID of the cluster to update.

string

description
optional

Cluster description.

string

observabilityConfig
optional

Cluster observability configurations to update. You can forward logs from environments activated in Cloudera Data Warehouse (CDW) to observability and monitoring systems such as Datadog, New Relic, or Splunk. Please refer to the following Cloudera documentation for more info. https://docs.cloudera.com/data-warehouse/cloud/monitoring/topics/dw-observability-log-forwarding.html

whitelistIpCIDRs
optional

List of IP address CIDRs to whitelist. NOTE: CDW is in process of rolling out a new feature to whitelist IP CIDR separately for Kubernetes Clusters and Loadbalancers on CDP Public Cloud. For an existing cluster, if different IP CIDR has been already applied to LoadBalancer and the Kubernetes cluster through the DWX UI, then updating the IP CIDR of such cluster is not supported from CLI. In the upcoming release, the CLI will support this feature. Please make use of UI for the same.

< string > array

whitelistK8sClusterAccessIpCIDRs
optional

List of IP address CIDRs to whitelist for kubernetes cluster access.

< string > array

whitelistWorkloadAccessIpCIDRs
optional

List of IP address CIDRs to whitelist for workload access.

< string > array

awsUpdate

Name Description Schema

externalBuckets
optional

External bucket definition.

azureUpdate

Name Description Schema

renewCertificate
optional

Renew Azure cluster certificate.
Default : false

boolean

UpdateClusterResponse

Response object for the updateCluster method.

Type : object

UpdateDataVisualizationRequest

Request object for the updateDataVisualization method.

Name Description Schema

clusterId
required

ID of the Cloudera Data Visualization’s cluster.

string

config
optional

The service configuration to update the DataVisualization with. This will be applied on top of the existing configuration so there’s no need to list configurations that stay the same.

dataVisualizationId
required

ID of the Cloudera Data Visualization.

string

UpdateDataVisualizationResponse

Response object for the updateDataVisualization method.

Name Description Schema

status
optional

The status of asynchronous update configuration request for Cloudera Data Visualization. To find the latest status please use describe-data-visualization.

string

UpdateDbcConfigRequest

Request object for the updateDbcConfig method.

Name Description Schema

clusterId
required

ID of the cluster.

string

component
required

Database Catalog configuration component to update.

enum (DasEventProcessor, DatabusProducer, HueQueryProcessor, Metastore)

dbcId
required

ID of the Database Catalog.

string

set
optional

Configuration files of the selected component to update.

< ConfigBlock > array

UpdateDbcConfigResponse

Response object for the updateDbcConfig method.

Type : object

UpdateDbcRequest

Request object for the updateDbc method.

Name Description Schema

clusterId
required

ID of the Database Catalog’s cluster.

string

config
optional

The service configuration to update the DBC with. This will be applied on top of the existing configuration so there’s no need to list configurations that stay the same.

dbcId
required

ID of the Database Catalog.

string

memorySize
optional

Set Metastore container memory size. If not provided, small will apply.

enum (small, medium, large)

UpdateDbcResponse

Response object for the updateDbc method.

Type : object

UpdateServerSettingItem

A DWX server setting update.

Name Description Schema

configurationKey
optional

The identifier of the setting.

string

enabled
optional

The state of the setting.

boolean

UpdateServerSettingRequest

Request object for the updateServerSetting method.

Name Description Schema

settings
optional

The list of the server setting updates.

UpdateServerSettingResponse

Response object for the updateServerSetting method.

Name Description Schema

status
optional

Update status.

string

UpdateSshKeyRequest

Request object for the updateSshKey method.

Name Description Schema

clusterId
required

The ID of the cluster to update the SSH Key.

string

UpdateSshKeyResponse

Response object for the updateSshKey method.

Name Description Schema

message
optional

A message describing the outcome of the SSH Key update process.

string

status
optional

The status of the cluster.

string

UpdateVwConfigRequest

Request object for the updateVwConfig method.

Name Description Schema

clusterId
required

ID of the cluster.

string

component
required

Configuration component to update. Hive components are [DasWebapp, Hiveserver2, QueryCoordinator, QueryExecutor, StandaloneQueryExecutor, TokenAuth, Hue]. Impala components are [Hue, ImpalaAutoscaler, ImpalaCatalogd, ImpalaCoordinator, ImpalaExecutor, ImpalaProxy, ImpalaStatestored, ImpalaTokenAuth].

enum (DasWebapp, Hiveserver2, QueryCoordinator, QueryExecutor, StandaloneQueryExecutor, TokenAuth, Hue, ImpalaAutoscaler, ImpalaCatalogd, ImpalaCoordinator, ImpalaExecutor, ImpalaProxy, ImpalaStatestored, ImpalaTokenAuth)

set
optional

Configuration files of the selected component to update.

< ConfigBlock > array

vwId
required

ID of the Virtual Warehouse.

string

UpdateVwConfigResponse

Response object for the updateVwConfig method.

Type : object

UpdateVwRequest

Request object for the updateVw method.

Name Description Schema

autoscaling
optional

Autoscaling settings for the Virtual Warehouse.

clusterId
required

ID of the Virtual Warehouse’s cluster.

string

config
optional

The service configuration to update the VW with. This will be applied on top of the existing configuration so there’s no need to list configurations that stay the same.

hiveAuthenticationMode
optional

DEPRECATED - Sets the authentication mode to use by Hive Server: * LDAP * KERBEROS If not set then the authentication mode will not be changed during update.

string

impalaHaSettings
optional

High Availability settings update for the Impala Virtual Warehouse.

nodeCount
optional

Nodes per compute cluster. If specified, forces 'template' to be 'custom'
Default : 0

integer (int32)

platformJwtAuth
optional

Value of 'true' automatically configures the Virtual Warehouse to support JWTs issues by the CDP JWT token provider. Value of 'false' does not enable JWT auth on the Virtual Warehouse. If this field is not specified, it defaults to 'false'.

boolean

queryIsolationOptions
optional

Query isolation settings for Hive Virtual Warehouses.

template
optional

Name of configuration template to use.

enum (xsmall, small, medium, large)

vwId
required

ID of the Virtual Warehouse.

string

UpdateVwResponse

Response object for the updateVw method.

Type : object

UpgradeClusterRequest

Request object for the upgradeCluster method.

Name Description Schema

clusterId
required

The ID of the cluster to upgrade.

string

UpgradeClusterResponse

Response object for the upgradeCluster method.

Name Description Schema

message
optional

Detailed explanation of the status.

string

serviceUnhealthy
optional

True, if the service is in unhealthy state, false or omitted otherwise.

boolean

status
optional

The upgrade status. Possible values are: Upgrading, Error, Failed.

string

timedOut
optional

True if the upgrade timed out, false or omitted otherwise.

boolean

UpgradeDataVisualizationRequest

Request object for the upgradeDataVisualization method.

Name Description Schema

clusterId
required

ID of the Cloudera Data Visualization’s cluster.

string

dataVisualizationId
required

ID of the Cloudera Data Visualization.

string

imageVersion
required

Image version of the Cloudera Data Visualization to upgrade to.

string

UpgradeDataVisualizationResponse

Response object for the upgradeDataVisualization method.

Name Description Schema

status
optional

The status of asynchronous upgrade request for Cloudera Data Visualization. To find the latest status please use describe-data-visualization.

string

UpgradeDbcRequest

Request object for the upgradeDbc method.

Name Description Schema

clusterId
required

The ID of the Database Catalog’s cluster.

string

dbcId
required

The ID of the Database Catalog.

string

imageVersion
required

The version to which the Database Catalog should be upgraded.

string

UpgradeDbcResponse

Response object of the upgradeDbc call.

Name Description Schema

message
optional

The Upgrade message.

string

serviceUnhealthy
optional

True, if the service is in unhealthy state, false or omitted otherwise.

boolean

status
optional

The upgrade status. Possible values are: Upgrading, Error, Failed.

string

timedOut
optional

True if the upgrade timed out, false or omitted otherwise.

boolean

UpgradeVersions

Details of upgrade versions.

Name Description Schema

latestVersion
optional

Latest available Data Visualization version.

string

UpgradeVwRequest

Request object for the upgradeVw method.

Name Description Schema

clusterId
required

The ID of the Virtual Warehouse’s cluster.

string

dbcId
required

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

string

imageVersion
required

The version to which the Virtual Warehouse should be upgraded.

string

vwId
required

The ID of the Virtual Warehouse.

string

UpgradeVwResponse

Response object for the upgradeVw method.

Name Description Schema

message
optional

The upgrade message.

string

serviceUnhealthy
optional

True, if the service is in unhealthy state, false or omitted otherwise.

boolean

status
optional

The upgrade status. Possible values are: Upgrading, Error, Failed.

string

timedOut
optional

True if the upgrade timed out, false or omitted otherwise.

boolean

VizConfig

Configurations for a Cloudera Data Visualization

Name Description Schema

adminGroups
optional

Admin groups to allow configuration access to Data Visualization for selected users

< string > array

resourcePool
optional

The Resource Pool of the Cloudera Data Visualization.

string

userGroups
optional

User groups to allow user access to Data Visualization for selected users

< string > array

VwDiagnosticDataJob

Represents a Diagnostic Data Job.

Name Description Schema

endTime
optional

The finish time of the Diagnostic Data Job.

string (date-time)

jobId
optional

The unique identifier of the Diagnostic Data Job.

string

labels
optional

Additional key-value pair attributes associated with the Diagnostic Data Job.

< string, string > map

startTime
optional

The start time of the Diagnostic Data Job.

string (date-time)

status
optional

The job status.

url
optional

If the request is for download, this URL points to download location.

string

VwFilter

Filter object for Virtual Warehouses.

Name Description Schema

compactor
optional

Filter Virtual Warehouses whether it is a Compactor or not.

boolean

dbcId
optional

Filter Virtual Warehouses by Database Catalog Id.

string

viz
optional

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

boolean

vwType
optional

Virtual Warehouse type.

VwSummary

A Virtual Warehouse.

Name Description Schema

autoscalingOptions
optional

The current settings stored for autoscaling.

availabilityZone
optional

Availability zone in which the Virtual Warehouse is running.

string

cdhVersion
optional

CDH image version.

string

compactor
optional

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

boolean

configId
optional

ID of the configuration.

string

creationDate
optional

Creation date of Virtual Warehouse.

string (date-time)

creator
optional

The creator of the Virtual Warehouse.

crn
optional

The CRN of the Virtual Warehouse.

string

dbcId
optional

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

string

enableUnifiedAnalytics
optional

Denotes whether the Unified Analytics is enabled.

boolean

endpoints
optional

Endpoints for accessing the Virtual Warehouse.

hiveAuthenticationMode
optional

DEPRECATED - Authentication mode used by Hive Server: * LDAP * KERBEROS

string

id
optional

The ID of the Virtual Warehouse.

string

impalaHaSettingsOptions
optional

Current Impala High Availability settings.

impalaOptions
optional

Current Impala settings.

jwtAuth
optional

Details related to JWT Authentication settings on this Virtual Warehouse.

memoryCapacity
optional

Memory size of the Virtual Warehouse in MB.

integer (int32)

name
optional

The name of the Virtual Warehouse.

string

nodeCount
optional

Size of the Virtual Warehouse (node count per compute cluster).

integer (int32)

numOfCores
optional

Number of cores of the Virtual Warehouse.

integer (int32)

queryIsolationOptions
optional

The current settings stored for query-isolation.

replicaStatus
optional

Status information on the current state of replicas in the virtual warehouse.

resourcePool
optional

The name of the Resource Pool the Virtual Warehouse is in.

string

status
optional

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

string

statusChangedAt
optional

Timestamp of the last status change of the Virtual Warehouse.

string (date-time)

supportedAuthMethods
optional

Describes which authentication methods are supported on this Virtual Warehouse.

tags
optional

Tags associated with the resources.

< TagResponse > array

viz
optional

Denotes whether the Virtual Warehouse has Data Visualisation or not.

boolean

vwType
optional

The type of the Virtual Warehouse.

endpoints

Name Description Schema

das
optional

URL of Data Analytics Studio for Hive Virtual Warehouses.

string

fengImpalaShell
optional

Command to use impala-shell for Unified Analytics

string

fengKerberosImpalaShell
optional

Command to use impala-shell for Unified Analytics with Kerberos authentication in Private Cloud.

string

hiveJdbc
optional

JDBC URL for Hive Virtual Warehouses.

string

hiveKerberosJdbc
optional

JDBC URL with Kerberos authentication for Hive Virtual Warehouses in Private Cloud.

string

hostname
optional

Hostname for clients to use when connecting to the VW.

string

hue
optional

URL of Hue for both Hive and Impala Virtual Warehouses.

string

impalaFENGJdbc
optional

FENG JDBC URL for Impala Virtual Warehouses.

string

impalaFengKerberosJdbc
optional

Unified Analytics JDBC URL with Kerberos authentication for Impala Virtual Warehouses in Private Cloud.

string

impalaJdbc
optional

JDBC URL for Impala Virtual Warehouses.

string

impalaKerberosJdbc
optional

JDBC URL for Impala Virtual Warehouses with Kerberos authentication.

string

impalaShell
optional

Command to use impala-shell for Impala Virtual Warehouses.

string

jwtConnectionString
optional

Generic semi-colon delimited list of key-value pairs that contain all necessary information for clients to construct a connection to this Virtual Warehouse using JWTs as the authentication method.

string

jwtTokenGenUrl
optional

When platform JWT authentication is enabled, contains a URL where a JWT token can be generated by the CDP JWT token provider.

string

kerberosImpalaShell
optional

Command to use impala-shell for Impala Virtual Warehouses with Kerberos authentication.

string

port
optional

Port for clients to use when connecting to the VW.

integer (int32)

jwtAuth

Name Description Schema

provider
optional

If JWT auth is enabled on the Virtual Warehouse, describes the type of provider. If set to "CDP", then the CDP JWT auth provider is configured. If set to "CUSTOM", then another JWT provider is configured. If empty or missing, then JWT auth is not enabled on this Virtual Warehouse.

string

supportedAuthMethods

Name Description Schema

jwt
required

Indicates if JWT auth is supported on this Virtual Warehouse.

boolean

ldap
required

Indicates if username/password access to this Virtual Warehouse is supported.

boolean

sso
required

Indicates if SSO auth is supported on this Virtual Warehouse.

boolean

VwType

Type of Virtual Warehouse: 'hive' or 'impala'.

Type : enum (hive, impala)


Copyright © 2024 Cloudera, Inc. All rights reserved.