Overview
Install and manage Cloudera Data Warehouse clusters.
Version information
Version : 0.9.128 (BETA)
License information
License : Apache 2.0
Terms of service : https://www.cloudera.com/legal/commercial-terms-and-conditions.html
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 |
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 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Create an AWS cluster in the Cloudera Data Warehouse.
POST /api/v1/dw/createAwsCluster
Description
Create an AWS cluster in the Cloudera Data Warehouse environment with the provided settings.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Create an Azure cluster in the Cloudera Data Warehouse.
POST /api/v1/dw/createAzureCluster
Description
Create an Azure cluster in the Cloudera Data Warehouse environment with the provided settings.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
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 |
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 |
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 |
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 |
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 |
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 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Create a a Private Cloud cluster in the Cloudera Data Warehouse.
POST /api/v1/dw/createPrivateCluster
Description
Create a Private Cloud cluster in the Cloudera Data Warehouse environment with the provided settings.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Create a resource allocation template.
POST /api/v1/dw/createResourceTemplate
Description
This command’s purpose is to facilitate the creation of resource templates in CDW. Users are allowed to tailor default CPU and Memory settings according to their needs. Setting up these values correctly is crucial when creating Hive / Impala and DataViz instances using the 'create-vw' / 'create-data-visualisation' commands. The 'id' of the response object must be supplied in the 'create-vw' / 'create-data-visualisation' command 'template' field to specify the chosen resource allocation size. Please note, that the 'default' fields in the response denote the default supplied value if the 'template' is not specified in the create commands. These templates are versioned so that users can rollback to a particular version. Existing resources are not affected by rollback. Learn more about each resource allocation with the 'describe-resource' command.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Delete a resource allocation template.
POST /api/v1/dw/deleteResourceTemplate
Description
This command’s purpose is to facilitate the delete of resource templates in CDW.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Gets Kubernetes certificates in JKS format.
POST /api/v1/dw/getK8sCertJKS
Description
Gets the Kubernetes certificate in a Java Truststore for the given cluster ID of the CDW environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Gets Kubernetes certificate in PEM format.
POST /api/v1/dw/getK8sCertPEM
Description
Gets the Kubernetes certificate in PEM format for the given cluster ID of the CDW environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
successful operation |
|
default |
The default response on an error. |
Get default resource allocation templates.
POST /api/v1/dw/listResourceTemplates
Description
This command provides a predefined set of available resource configuration in CDW. Users allowed to tailor these default CPU and Memory settings according their needs using the 'update-resource' command. Setting up these values correctly is crucial when creating a Hive / Impala and DataViz instances using the 'create-vw' / 'create-data-visualisation' commands. The 'id' of the response object has to be supplied in the 'create-vw' / 'create-data-visualisation' command 'template' field respectively, in order to specify the chosen resource allocation size. Please note, the 'default' fields in the response denotes default supplied value if the 'template' not specified in the create commands. These templates are versioned, so users are able to roll-back to a particular version. Existing resources not affected by roll-back. Learn more about each of the resource allocations with the 'describe-resource' command.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Resume Cloudera Data Warehouse cluster.
POST /api/v1/dw/resumeCluster
Description
Resume Cloudera Data Warehouse cluster. Resume cluster will start a stopped CDW cluster. Resuming a cluster in "Running" or "Error" state is not supported. Resume will start the AKS or EKS instance which belongs to this CDW. Please refer to the following AKS documentation for start/stop feature https://learn.microsoft.com/en-us/azure/aks/start-stop-cluster?tabs=azure-cli
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
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 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Suspend Cloudera Data Warehouse cluster.
POST /api/v1/dw/suspendCluster
Description
Suspend Cloudera Data Warehouse cluster. Suspend cluster requires a "Running" Azure or AWS CDW, trying to suspend a cluster already in "Stopped" or "Error" state is not supported. Every Virtual Warehouse and Database Catalog which belongs to that CDW must be stopped first. This operation will stop the AKS or EKS cluster for this CDW instance, however leaves other cloud resources in "Running" state, including the Postgres database. Please refer to the following AKS documentation for start/stop feature https://learn.microsoft.com/en-us/azure/aks/start-stop-cluster?tabs=azure-cli
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
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 |
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 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Updates an AWS cluster in the Cloudera Data Warehouse.
POST /api/v1/dw/updateAwsCluster
Description
Update an AWS cluster in the Cloudera Data Warehouse with the provided settings.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Updates an Azure cluster in the Cloudera Data Warehouse.
POST /api/v1/dw/updateAzureCluster
Description
Update an Azure cluster in the Cloudera Data Warehouse with the provided settings.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
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 |
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 |
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 |
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 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Updates a Private Cloud (PvC) cluster in the Cloudera Data Warehouse.
POST /api/v1/dw/updatePrivateCluster
Description
Update a Private Cloud cluster (PvC) in the Cloudera Data Warehouse with the provided settings.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Update a resource allocation template.
POST /api/v1/dw/updateResourceTemplate
Description
This command’s purpose is to facilitate the update of resource templates in CDW. Users are allowed to tailor default CPU and Memory settings according to their needs. Setting up these values correctly is crucial when creating Hive / Impala and DataViz instances using the 'create-vw' / 'create-data-visualisation' commands. The 'id' of the response object must be supplied in the 'create-vw' / 'create-data-visualisation' command 'template' field to specify the chosen resource allocation size. Please note, that the 'default' fields in the response denote the default supplied value if the 'template' is not specified in the create commands. These templates are versioned so that users can rollback to a particular version. Existing resources are not affected by rollback. Learn more about each resource allocation with the 'describe-resource' command.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Actor CRN. |
string |
email |
Email address for users. |
string |
machineUsername |
Username for machine users. |
string |
workloadUsername |
Username for users. |
string |
AddUserRequest
Request object for the addUser method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The ID of the cluster to which the user must be added. |
string |
userId |
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 |
Allowed values for the instance type. This setting is Cluster-wide. |
< string > array |
default |
Default value for the compute instance type usage. This setting is Cluster-wide. |
< string > array |
hive |
Allowed instance types for Hive Virtual Warehouses. |
|
impala |
Allowed instance types for Impala Virtual Warehouses. |
|
trino |
Allowed instance types for Trino Virtual Warehouses. |
AllowedInstanceTypesWithDefault
Allowed Virtual Warehouse compute instance types and their defaults.
| Name | Description | Schema |
|---|---|---|
allowed |
Allowed values for the compute instance type usage. One of these values can be used in the 'create-vw' command’s 'instance-type' field . |
< string > array |
default |
Default value for the compute instance type usage. This instance type will be used in the 'create-vw' command’s 'instance-type' field in case it has to be customized. The default value also depends on the cloud platform of the Cluster (AWS/Azure). |
string |
ApplicationConfigDiff
Differences between two ApplicationConfigs.
| Name | Description | Schema |
|---|---|---|
configBlocksDiffs |
Differences between the two sets of ConfigBlocks. |
|
isChanged |
Has any of the configurations changed? |
boolean |
ApplicationConfigReq
Configurations for an application inside a service.
| Name | Description | Schema |
|---|---|---|
configBlocks |
List of ConfigBlocks for the application. |
< ConfigBlockReq > array |
ApplicationConfigResp
Configurations for an application inside a service.
| Name | Description | Schema |
|---|---|---|
configBlocks |
List of ConfigBlocks for the application. |
< ConfigBlockResp > array |
ApplicationResources
The resource requirements of a component.
| Name | Description | Schema |
|---|---|---|
breakdown |
Breakdown of the service memory requirements. |
|
cpu |
Overall CPU requirements. |
number (float) |
ephemeralStorage |
Temporary storage for CDW pods, used for storing configurations and temporary data needed during a process. The lifespan of ephemeral storage is tied to the pod. |
string |
localStorageSize |
Local disk size requirements. |
|
memory |
Overall memory requirements. |
string |
ApplicationResourcesBreakdown
Breakdown of the service memory requirements.
| Name | Description | Schema |
|---|---|---|
headroom |
DEPRECATED: Java VM configuration for -Xmx (maximum heap size).Java VM overhead for Garbage Collector structures, metaspace, etc., and a safety margin to avoid out-of-memory issues. |
string |
maxDirectMemorySize |
Java VM configuration for -XX:MaxDirectMemorySize (limit for Direct Byte Buffers). |
string |
waitQueueSize |
DEPRECATED: Set the hive.query.isolation.slots.per.node configuration value instead. Overhead buffer for hive.query.isolation.slots.per.node. The total number of concurrent tasks the Hive query executor can process is the sum of the available CPU cores and the value you specify in this field. |
integer (int32) |
xms |
Java VM configuration for -Xms (initial and minimum heap size). |
string |
xmx |
Java VM configuration for -Xmx (maximum heap size). |
string |
xss |
Java VM configuration for -Xss (thread stack size). |
string |
ApplicationResourcesLocalStorageSize
Storage related information.
| Name | Description | Schema |
|---|---|---|
cache |
Local disk space used for writing cache data. |
string |
overhead |
Local disk space used for writing other temporary data, tools, etc. |
string |
scratch |
Local disk space used for writing scratch data. |
string |
AutoscalingOptionsCreateRequest
Auto-scaling configuration for a Virtual Warehouse.
| Name | Description | Schema |
|---|---|---|
autoSuspendTimeoutSeconds |
Auto suspend threshold for Virtual Warehouse. |
integer (int32) |
disableAutoSuspend |
Turn off auto suspend for Virtual Warehouse. |
boolean |
enableUnifiedAnalytics |
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 |
Set Desired free capacity. Either "hiveScaleWaitTimeSeconds" or "hiveDesiredFreeCapacity" can be provided. |
integer (int32) |
hiveScaleWaitTimeSeconds |
Set wait time before a scale event happens. Either "hiveScaleWaitTimeSeconds" or "hiveDesiredFreeCapacity" can be provided. |
integer (int32) |
impalaEnableCatalogHighAvailability |
DEPRECATED in favor of the top level impalaHASettings object. Enables a backup instance for Impala catalog to ensure high availability. |
boolean |
impalaEnableShutdownOfCoordinator |
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 |
impalaExecutorGroupSets |
Configures executor group sets for workload aware autoscaling. |
|
impalaHighAvailabilityMode |
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 |
DEPRECATED in favor of the top level impalaHASettings object. Number of the active coordinators. |
integer (int32) |
impalaScaleDownDelaySeconds |
Scale down threshold in seconds. If not provided defaults will apply. |
integer (int32) |
impalaScaleUpDelaySeconds |
Scale up the scaling up threshold in seconds. If not provided defaults will apply. |
integer (int32) |
impalaShutdownOfCoordinatorDelaySeconds |
DEPRECATED in favor of the top level impalaHASettings object. Delay in seconds before the shutdown of coordinator event happens. |
integer (int32) |
maxClusters |
Maximum number of available compute groups. |
integer (int32) |
minClusters |
Minimum number of available compute groups. |
integer (int32) |
AutoscalingOptionsResponse
Auto-scaling configuration for a Virtual Warehouse.
| Name | Description | Schema |
|---|---|---|
autoSuspendTimeoutSeconds |
Auto suspend threshold for Virtual Warehouse. |
integer (int32) |
disableAutoSuspend |
Turn off auto suspend for Virtual Warehouse. |
boolean |
enableUnifiedAnalytics |
DEPRECATED in favor of the top level enableUnifiedAnalytics flag. Whether the Unified Analytics is enabled. |
boolean |
hiveDesiredFreeCapacity |
Desired free capacity. |
integer (int32) |
hiveScaleWaitTimeSeconds |
Wait time before a scale event happens. |
integer (int32) |
impalaEnableCatalogHighAvailability |
DEPRECATED in favor of the top level impalaHASettings object. Denotes whether a backup instance for Impala catalog is enabled. |
boolean |
impalaEnableShutdownOfCoordinator |
DEPRECATED in favor of the top level impalaHASettings object. Whether a shutdown of the coordinator is enabled. |
boolean |
impalaExecutorGroupSets |
Configurations of executor groups sets for workload aware autoscaling. |
|
impalaHighAvailabilityMode |
DEPRECATED in favor of the top level impalaHASettings object. High Availability mode. |
enum (ACTIVE_PASSIVE, ACTIVE_ACTIVE, DISABLED) |
impalaNumOfActiveCoordinators |
DEPRECATED in favor of the top level impalaHASettings object. Number of the active coordinators. |
integer (int32) |
impalaScaleDownDelaySeconds |
Scale down threshold in seconds. |
integer (int32) |
impalaScaleUpDelaySeconds |
Scale up the scaling up threshold in seconds. |
integer (int32) |
impalaShutdownOfCoordinatorDelaySeconds |
DEPRECATED in favor of the top level impalaHASettings object. Delay in seconds before the shutdown of coordinator event happens. |
integer (int32) |
maxClusters |
Maximum number of available compute groups. |
integer (int32) |
minClusters |
Minimum number of available compute groups. |
integer (int32) |
AutoscalingOptionsUpdateRequest
Auto-scaling configuration for a Virtual Warehouse. Provide those values only that you want to update.
| Name | Description | Schema |
|---|---|---|
autoSuspendTimeoutSeconds |
Auto suspend threshold for Virtual Warehouse. |
integer (int32) |
disableAutoSuspend |
Turn off auto suspend for Virtual Warehouse. |
boolean |
hiveDesiredFreeCapacity |
Set Desired free capacity. Either "hiveScaleWaitTimeSeconds" or "hiveDesiredFreeCapacity" can be provided. |
integer (int32) |
hiveScaleWaitTimeSeconds |
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) |
impalaExecutorGroupSets |
Re-configures executor group sets for workload aware autoscaling. |
|
impalaNumOfActiveCoordinators |
DEPRECATED in favor of the top level impalaHASettings object. Number of the active coordinators. |
integer (int32) |
impalaScaleDownDelaySeconds |
Scale down threshold in seconds. |
integer (int32) |
impalaScaleUpDelaySeconds |
Scale up the scaling up threshold in seconds. |
integer (int32) |
impalaShutdownOfCoordinatorDelaySeconds |
DEPRECATED in favor of the top level impalaHASettings object. Delay in seconds before the shutdown of coordinator event happens. |
integer (int32) |
maxClusters |
Maximum number of available compute groups. Zero means, the maxClusters will not be updated.. |
integer (int32) |
minClusters |
Minimum number of available compute groups. Zero means, the minClusters will not be updated. |
integer (int32) |
AwsActivationOptions
Options for activating an AWS environment.
| Name | Description | Schema | ||
|---|---|---|---|---|
computeInstanceTypes |
|
< string > array |
||
customAmiId |
Custom AMI ID. |
string |
||
enablePrivateEKS |
Use this option to set up AWS EKS cluster in private only mode with restricted access only from internal/peered networks. Ensure you have ccmv2 setup functional to achieve this integration. |
boolean |
||
enableSpotInstances |
Whether to enable Spot instances for Virtual warehouses. It cannot be updated later. If the aws-options is not provided it defaults to false. |
boolean |
||
lbSubnetIds |
IDs of AWS subnets where the cluster load balancer should be deployed. |
< string > array |
||
nodeRoleCDWManagedPolicyArn |
Managed Policy Arn to be attached to the Node Instance Role. |
string |
||
reducedPermissionMode |
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 |
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 |
List of availability zones that the cluster is restricted to use. |
< string > array |
customAmiId |
Id of the Custom Amazon Machine Image |
string |
lbSubnetIds |
IDs of AWS subnets where the cluster load balancer should be deployed. |
< string > array |
reducedPermissionMode |
Denotes whether the Reduced Permission mode is enabled. |
boolean |
subnetIds |
IDs of AWS subnets where the cluster has been deployed. |
< string > array |
workerSubnetIds |
IDs of AWS subnets where the cluster worker nodes should be deployed. |
< string > array |
AzureActivationOptions
Options for activating an Azure environment.
| Name | Description | Schema | ||
|---|---|---|---|---|
aksPodCIDR |
Pod CIDR required for Azure CNI networking. Please refer to the following Azure documentation, https://docs.microsoft.com/en-us/azure/aks/azure-cni-overlay. |
string |
||
aksVNetIntegrationSubnetName |
Enable AKS VNet Azure Virtual Network (VNet) integration by specifying the delegated subnet name. An Azure Kubernetes Service (AKS) cluster configured with API Server VNet Integration projects the API server endpoint directly into a delegated subnet in the VNet where AKS is deployed. API Server VNet Integration enables network communication between the API server and the cluster nodes without requiring a private link or tunnel. |
string |
||
computeInstanceTypes |
|
< string > array |
||
enableAZ |
Enables Azure Availability Zones for the cluster deployment. |
boolean |
||
enablePrivateAks |
Enable Azure Private AKS mode. |
boolean |
||
enablePrivateSQL |
Enables private SQL for the cluster deployment. |
boolean |
||
enableSpotInstances |
Whether to enable spot instances for Virtual warehouses. It cannot be updated later. If the AzureActivationOptions is not provided it defaults to false. |
boolean |
||
logAnalyticsWorkspaceId |
Enable monitoring of Azure Kubernetes Service (AKS) cluster. Workspace ID for Azure log analytics. |
string |
||
outboundType |
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 |
Private DNS zone AKS resource ID. |
string |
||
privateDNSZoneSQL |
Private DNS zone ID for the PostgreSQL server. |
string |
||
privateSQLSubnetName |
Name of the delegated subnet where the private SQL should be deployed. |
string |
||
subnetId |
ID of Azure subnet where the cluster should be deployed. It is a mandatory parameter for Azure cluster creation. |
string |
||
userAssignedManagedIdentity |
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 |
|---|---|---|
aksPodCIDR |
Pod CIDR setting for Azure CNI networking. |
string |
aksVNetIntegrationSubnetName |
AKS VNet integration subnet name. If it’s an empty string, then VNet integration is disabled. |
string |
enableAZ |
Denotes whther the Azure Availability Zones for the cluster is enabled or not. |
boolean |
enablePrivateAKS |
Denotes whether the AKS cluster is in private mode. |
boolean |
enablePrivateSQL |
Denotes whether the private SQL is enabled for the cluster. |
boolean |
logAnalyticsWorkspaceId |
Workspace ID for Azure log analytics. |
string |
outboundType |
The current outbound type setting. |
string |
privateDNSZoneAKS |
The resource ID of the private DNS zone for the AKS cluster. |
string |
privateDNSZoneSQL |
Private DNS zone ID for the PostgreSQL server. |
string |
privateSQLSubnetName |
Name of the delegated subnet where the private SQL should be deployed. |
string |
subnetId |
ID of Azure subnet where the cluster is deployed. |
string |
userAssignedManagedIdentity |
The resource ID of the managed identity used by the AKS cluster. |
string |
Backup
Backup entry
| Name | Description | Schema |
|---|---|---|
backupCreationTime |
The time when the backup was created. |
string |
backupCrn |
The CRN of the backup. |
string |
backupJob |
The backup job name. |
string |
backupJobState |
The current state of the backup job. |
string |
backupName |
The display name of the backup. |
string |
backupPhase |
The phase of the backup operation. |
string |
backupUpdatedTime |
The time when the backup was updated. |
string |
errors |
The errors from backup job. |
< Message > array |
includedNamespaces |
The list of namespaces to be included in backup. |
< string > array |
warnings |
The warnings from backup job. |
< Message > array |
BackupClusterRequest
Request object for the backupCluster method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The ID of the cluster. |
string |
BackupClusterResponse
Response object for the backupCluster method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The ID of the cluster. |
string |
data |
The backup data. |
string |
md5 |
The md5 hash of the encoded data. |
string |
operationId |
The ID of the backup operation. |
string |
timestamp |
The date of the creation. |
string (date-time) |
CloudUserReference
Cloud user definition object.
| Name | Description | Schema |
|---|---|---|
userId |
A cloud based unique identifier of the user (ARN for AWS users, groupId for Azure users). |
string |
ClusterCreateDiagnosticDataDownloadOptions
DEPRECATED: Included by default, no need to specify
| Name | Description | Schema |
|---|---|---|
includeClusterInfo |
DEPRECATED: Included by default, no need to specify |
boolean |
includeIstioSystem |
DEPRECATED: Included by default, no need to specify |
boolean |
includeKubeSystem |
DEPRECATED: Included by default, no need to specify |
boolean |
includeSharedServices |
DEPRECATED: Included by default, no need to specify |
boolean |
ClusterDiagnosticDataJob
Represents a Diagnostic Data Job.
| Name | Description | Schema |
|---|---|---|
endTime |
The finish time of the Diagnostic Data Job. |
string (date-time) |
jobId |
The unique identifier of the Diagnostic Data Job. |
string |
labels |
Additional key-value pair attributes associated with the Diagnostic Data Job. |
< string, string > map |
startTime |
The start time of the Diagnostic Data Job. |
string (date-time) |
status |
The job status. |
|
url |
This URL points to a download location if the destination is DOWNLOAD. |
string |
ClusterSummaryProductSupportResponse
Support lifecycle details of the given Cluster version (see version field). Learn more at Support lifecycle site: https://www.cloudera.com/services-and-support/support-lifecycle-policy.html.
| Name | Description | Schema |
|---|---|---|
expiryDate |
Shows the expiration date of the support for this Cluster version. |
string (date-time) |
message |
Message. |
string |
status |
Status of the support lifecycle. COVERED: The Cluster version has active support. EXPIRED: The Cluster version is no-longer supported. UNKNOWN: The Cluster version is missing or incorrect. |
string |
ClusterSummaryResponse
A Cloudera Data Warehouse cluster.
| Name | Description | Schema | ||
|---|---|---|---|---|
awsOptions |
Response object of AWS related cluster options. |
|||
azureOptions |
Response object of Azure related cluster options. |
|||
cloudPlatform |
The cloud platform of the environment that was used to create this cluster. |
string |
||
computeInstanceTypes |
|
< string > array |
||
creationDate |
Creation date of cluster. |
string (date-time) |
||
creator |
The creator of the cluster. |
|||
crn |
The CRN of the cluster. |
string |
||
description |
Cluster description. |
string |
||
enablePrivateLoadBalancer |
Denotes whether the private load balancer is enabled for the cluster. |
boolean |
||
enableSpotInstances |
Denotes whether the spot instances have been enabled for the cluster. This value is only available for AWS and Azure clusters. |
boolean |
||
environmentCrn |
The CRN of the environment where the cluster is located. |
string |
||
externalBuckets |
External buckets attached to the environment. |
< ExternalBucket > array |
||
id |
The ID of the cluster. |
string |
||
name |
Name of the cluster (same as the name of the environment). |
string |
||
productSupport |
Support lifecycle details of the given Cluster version (see version field). Learn more at Support lifecycle site: https://www.cloudera.com/services-and-support/support-lifecycle-policy.html. |
|||
reservedComputeNodes |
DEPRECATED - will be removed in future releases. Number of additional reserved nodes for executors and coordinators to use during autoscaling. |
integer (int32) |
||
reservedSharedServicesNodes |
DEPRECATED - will be removed in future releases. Number of additional reserved nodes for other services in the cluster. |
integer (int32) |
||
resourcePool |
The name of the Resource Pool the cluster is in. |
string |
||
status |
Status of the cluster. Possible values are: Creating, Created, Accepted, Starting, Running, Stopping, Stopped, Updating, PreUpdate, Upgrading, PreUpgrade, Restarting, Deleting, Waiting, Failed, Error. |
string |
||
useOverlayNetwork |
Denotes whether the overlay network is being used for the cluster. |
boolean |
||
version |
The version of the deployed CDW cluster. |
string |
||
whitelistK8sClusterAccessIpCIDRs |
List of IP address CIDRs to whitelist for kubernetes cluster access. |
string |
||
whitelistWorkloadAccessIpCIDRs |
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 |
Configuration file to update. |
string |
content |
Set values for text format configuration file e.g. TEXT, JSON, YAML, XML typed file. |
string |
keyValue |
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 |
Differences between the contents. |
|
id |
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 |
Contents of a ConfigBlock. |
|
id |
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 |
Contents of a ConfigBlock. |
|
id |
ID of the ConfigBlock. Unique within an ApplicationConfig. |
string |
ConfigBlocksDiffs
Differences between two sets of ConfigBlocks.
| Name | Description | Schema |
|---|---|---|
added |
Config blocks that are only present in the new configuration. |
< ConfigBlockResp > array |
changed |
Config blocks that are different between the two configurations. |
< ConfigBlockDiff > array |
isChanged |
Has any of the config blocks changed? |
boolean |
removed |
Config blocks that are only present in the old configuration. |
< ConfigBlockResp > array |
same |
Config blocks that are the same in both configurations. |
< ConfigBlockResp > array |
ConfigContentDiff
Difference between two ConfigContents.
| Name | Description | Schema |
|---|---|---|
keyValues |
Different between keyValues of two ConfigContents. |
ConfigContentReq
Contents of a ConfigBlock.
| Name | Description | Schema |
|---|---|---|
json |
JSON type configuration. |
string |
keyValues |
Key-value type configurations. |
< string, string > map |
text |
Text type configuration. |
string |
ConfigContentResp
Contents of a ConfigBlock.
| Name | Description | Schema |
|---|---|---|
json |
JSON type configuration. |
string |
keyValues |
Key-value type configurations. |
< string, string > map |
text |
Text type configuration. |
string |
ConfigHistoryItem
An entry in the configuration history of a service.
| Name | Description | Schema |
|---|---|---|
configId |
ID of the configuration. |
string |
from |
When was this configuration used from. |
string (date-time) |
serviceId |
DBC or VW ID that this configuration belongs to. |
string |
CreateApplicationResources
The resource requirements of a component.
| Name | Description | Schema |
|---|---|---|
breakdown |
Breakdown of the service memory requirements. |
|
cpu |
Overall CPU requirements. |
number (float) |
ephemeralStorage |
Temporary storage for CDW pods, used for storing configurations and temporary data needed during a process. The lifespan of ephemeral storage is tied to the pod. |
string |
localStorageSize |
Local disk size requirements. |
|
memory |
Overall memory requirements. |
string |
CreateApplicationResourcesBreakdown
Breakdown of the service memory requirements like Xms, Xss etc.
| Name | Description | Schema |
|---|---|---|
headroom |
DEPRECATED: Java VM configuration for -Xmx (maximum heap size).Java VM overhead for Garbage Collector structures, metaspace, etc., and a safety margin to avoid out-of-memory issues. |
string |
maxDirectMemorySize |
Java VM configuration for -XX:MaxDirectMemorySize (limit for Direct Byte Buffers). |
string |
waitQueueSize |
DEPRECATED: Set the hive.query.isolation.slots.per.node configuration value instead. Overhead buffer for hive.query.isolation.slots.per.node. The total number of concurrent tasks the Hive query executor can process is the sum of the available CPU cores and the value you specify in this field. |
integer (int32) |
xms |
Java VM configuration for -Xms (initial and minimum heap size). |
string |
xmx |
Java VM configuration for -Xmx (maximum heap size). |
string |
xss |
Java VM configuration for -Xss (thread stack size). |
string |
CreateApplicationResourcesLocalStorageSize
Storage related information.
| Name | Description | Schema |
|---|---|---|
cache |
Local disk space used for writing cache data. |
string |
overhead |
Local disk space used for writing other temporary data, tools, etc. |
string |
scratch |
Local disk space used for writing scratch data. |
string |
CreateAwsClusterRequest
Request object for the createAwsCluster method.
| Name | Description | Schema | ||
|---|---|---|---|---|
computeInstanceTypes |
|
< string > array |
||
customAmiId |
Custom AMI ID. |
string |
||
customRegistryOptions |
Options for custom ACR/ECR registries. |
|||
customSubdomain |
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 |
PostgreSQL server backup retention days. |
integer (int32) |
||
enablePrivateEKS |
Use this option to set up AWS EKS cluster in private only mode with restricted access only from internal/peered networks. Ensure you have ccmv2 setup functional to achieve this integration. |
boolean |
||
enableSpotInstances |
Whether to enable Spot instances for Virtual warehouses. It cannot be updated later. Defaults to false. |
boolean |
||
environmentCrn |
The CRN of the environment for the cluster to create. |
string |
||
lbSubnetIds |
IDs of AWS subnets where the cluster load balancer should be deployed. |
< string > array |
||
nodeRoleCDWManagedPolicyArn |
Managed Policy Arn to be attached to the Node Instance Role. |
string |
||
reducedPermissionMode |
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 |
||
reservedComputeNodes |
DEPRECATED - will be removed in future releases. 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 |
DEPRECATED - will be removed in future releases. Set additional number of nodes to reserve for other services in the cluster. Adding more reserved nodes increases your cloud costs. |
integer (int32) |
||
useOverlayNetwork |
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 |
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 |
Set up worker node with public IP address. In AWS it is created in public subnets. |
boolean |
||
whitelistK8sClusterAccessIpCIDRs |
List of IP address CIDRs to whitelist for kubernetes cluster access. |
< string > array |
||
whitelistWorkloadAccessIpCIDRs |
List of IP address CIDRs to whitelist for workload access. |
< string > array |
||
workerSubnetIds |
IDs of AWS subnets where the cluster worker nodes should be deployed. |
< string > array |
CreateAwsClusterResponse
Response object for the createAwsCluster method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of new AWS cluster. |
string |
CreateAzureClusterRequest
Request object for the createAzureCluster method.
| Name | Description | Schema | ||
|---|---|---|---|---|
aksPodCIDR |
Pod CIDR required for Azure CNI networking. Please refer to the following Azure documentation, https://docs.microsoft.com/en-us/azure/aks/azure-cni-overlay. |
string |
||
aksVNETIntegrationSubnetName |
Enable AKS VNet Azure Virtual Network (VNet) integration by specifying the delegated subnet name. An Azure Kubernetes Service (AKS) cluster configured with API Server VNet Integration projects the API server endpoint directly into a delegated subnet in the VNet where AKS is deployed. API Server VNet Integration enables network communication between the API server and the cluster nodes without requiring a private link or tunnel. |
string |
||
computeInstanceTypes |
|
< string > array |
||
customRegistryOptions |
Options for custom ACR/ECR registries. |
|||
customSubdomain |
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 |
PostgreSQL server backup retention days. |
integer (int32) |
||
enableAZ |
Enables Azure Availability Zones for the cluster deployment. |
boolean |
||
enablePrivateAks |
Enable Azure Private AKS mode. |
boolean |
||
enablePrivateSQL |
Enables private SQL for the cluster deployment. |
boolean |
||
enableSpotInstances |
Whether to enable spot instances for Virtual warehouses. It cannot be updated later. Defaults to false. |
boolean |
||
environmentCrn |
The CRN of the environment for the cluster to create. |
string |
||
logAnalyticsWorkspaceId |
Enable monitoring of Azure Kubernetes Service (AKS) cluster. Workspace ID for Azure log analytics. |
string |
||
outboundType |
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 |
Private DNS zone AKS resource ID. |
string |
||
privateDNSZoneSQL |
Private DNS zone ID for the PostgreSQL server. |
string |
||
privateSQLSubnetName |
Name of the delegated subnet where the private SQL should be deployed. |
string |
||
reservedComputeNodes |
DEPRECATED - will be removed in future releases. 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 |
DEPRECATED - will be removed in future releases. Set additional number of nodes to reserve for other services in the cluster. Adding more reserved nodes increases your cloud costs. |
integer (int32) |
||
subnetName |
Name of Azure subnet where the cluster should be deployed. It is a mandatory parameter for Azure cluster creation. |
string |
||
useInternalLoadBalancer |
Set up load balancer with private IP address. An internal load balancer gets created. Make sure there is connectivity between your client network and the network VNet where CDW environment is deployed. |
boolean |
||
useOverlayNetworking |
With overlay network nodes get an IP address from the Azure virtual network subnet. Pods receive an IP address from a logically different address space to the Azure virtual network subnet of the nodes. |
boolean |
||
userAssignedManagedIdentity |
Resource ID of the managed identity used by AKS. It is a mandatory parameter for Azure cluster creation. |
string |
||
whitelistK8sClusterAccessIpCIDRs |
List of IP address CIDRs to whitelist for kubernetes cluster access. |
< string > array |
||
whitelistWorkloadAccessIpCIDRs |
List of IP address CIDRs to whitelist for workload access. |
< string > array |
CreateAzureClusterResponse
Response object for the createCluster method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of new Azure cluster. |
string |
CreateBackupRequest
Request object for the create backup request.
| Name | Description | Schema |
|---|---|---|
backupName |
Specified name for the backup. If not set, the name will be blank. |
string |
namespaceNames |
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 |
The CRN the backup. |
string |
CreateClusterDiagnosticDataJobRequest
Request object for the createClusterDiagnosticDataJob method.
| Name | Description | Schema |
|---|---|---|
bundleMetadata |
Additional user-defined metadata information that is attached to the resulting bundle-info.json when posting the bundle. |
< string, string > map |
caseNumber |
Optional support case number in case of UPLOAD_TO_CLOUDERA destination, otherwise only act as additional data. |
string |
clusterId |
ID of the Cluster. |
string |
destination |
Destination of the diagnostics collection. |
enum (UPLOAD_TO_CLOUDERA, DOWNLOAD) |
downloadOptions |
DEPRECATED: All logs are included by default. No need to specify options |
|
endTime |
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 |
Forced recreation of the diagnostic job. |
boolean |
startTime |
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 |
Identifier for each bundle collection. |
string |
labels |
Additional key-value pair attributes associated with the Diagnostic Data Job. |
< string, string > map |
status |
Status of the diagnostics collection request. |
string |
url |
This URL points to a download location if the destination is DOWNLOAD. |
string |
CreateClusterRequest
Request object for the createCluster method.
| Name | Description | Schema |
|---|---|---|
awsOptions |
Options for activating an AWS environment. |
|
azureOptions |
Options for activating an Azure environment. |
|
customRegistryOptions |
Options for custom ACR/ECR registries. |
|
customSubdomain |
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 |
PostgreSQL server backup retention days. |
integer (int32) |
enableStorageRoles |
DEPRECATED - Enable Storage Roles |
boolean |
environmentCrn |
The CRN of the environment for the cluster to create. |
string |
privateCloudOptions |
Options for activating a Private Cloud environment. |
|
reservedComputeNodes |
DEPRECATED - will be removed in future releases. 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 |
DEPRECATED - will be removed in future releases. Set additional number of nodes to reserve for other services in the cluster. Adding more reserved nodes increases your cloud costs. |
integer (int32) |
resourcePool |
The Resource Pool of the cluster. |
string |
useOverlayNetwork |
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 |
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 |
Set up worker node with public IP address. In AWS it is created in public subnets. |
boolean |
whitelistIpCIDRs |
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 |
List of IP address CIDRs to whitelist for kubernetes cluster access. |
< string > array |
whitelistWorkloadAccessIpCIDRs |
List of IP address CIDRs to whitelist for workload access. |
< string > array |
CreateClusterResponse
Response object for the createCluster method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of new cluster. |
string |
CreateDataVisualizationRequest
Request object for the createDataVisualization call.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of cluster where Cloudera Data Visualization should be created. |
string |
config |
The LDAP admin and user group configuration for Cloudera Data Visualization. |
|
imageVersion |
Version of the Cloudera Data Visualization. |
string |
name |
Name of the Cloudera Data Visualization |
string |
resourceTemplate |
The name of the available resource template to use for the Cloudera Data Visualization. |
string |
CreateDataVisualizationResponse
Response object for the createDataVisualization method.
| Name | Description | Schema |
|---|---|---|
dataVisualizationId |
ID of the new Cloudera Data Visualization. |
string |
CreateDbcDiagnosticDataJobRequest
Request object for the createDbcDiagnosticDataJob method.
| Name | Description | Schema |
|---|---|---|
bundleMetadata |
Additional user-defined metadata information which is attached to resulting bundle-info.json when posting the bundle. |
< string, string > map |
caseNumber |
Optional support case number in case of UPLOAD_TO_CLOUDERA destination, otherwise only act as additional data. |
string |
clusterId |
ID of cluster. |
string |
dbcId |
ID of the Database Catalog. |
string |
destination |
Destination of the diagnostics collection. |
enum (UPLOAD_TO_CLOUDERA, DOWNLOAD) |
downloadOptions |
DEPRECATED: All logs are included by default |
|
endTime |
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 |
Forced recreation of the diagnostic job. |
boolean |
startTime |
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 |
Identifier for each bundle collection. |
string |
labels |
Additional key-value pair attributes associated with the Diagnostic Data Job. |
< string, string > map |
status |
Status of the diagnostics collection request. |
string |
url |
This URL points to a download location if the destination is DOWNLOAD. |
string |
CreateDbcRequest
Request object for the createDbc method.
| Name | Description | Schema | ||
|---|---|---|---|---|
clusterId |
ID of cluster where Database Catalog should be created. |
string |
||
dbDas |
DEPRECATED: Current Private Cloud releases only support embedded database, the value of this field is ignored. The name of the DAS database. Not required for embedded databases. |
string |
||
dbHue |
DEPRECATED: Current Private Cloud releases only support embedded database, the value of this field is ignored. The name of the HUE database. Not required for embedded databases. |
string |
||
dbMetastore |
DEPRECATED: Current Private Cloud releases only support embedded database, the value of this field is ignored. The name of the Metastore database. |
string |
||
imageVersion |
Version of the Database Catalog. |
string |
||
isDefault |
|
boolean |
||
loadDemoData |
Load demo data into the Database Catalog? |
boolean |
||
memorySize |
Set Metastore container memory size. If not provided, small will apply. |
enum (small, medium, large) |
||
name |
Name of the Database Catalog. |
string |
CreateDbcResponse
Response object for the createDbc method.
| Name | Description | Schema |
|---|---|---|
dbcId |
ID of the new Database Catalog. |
string |
CreatePrivateClusterRequest
Request object for the createPrivateCluster method.
| Name | Description | Schema |
|---|---|---|
dbClientCredentials |
A certificate and private key pair belonging together for mutual SSL handshake when Database Catalog (aka DBC) connects to the metastore database. |
|
dbHue |
The name of the HUE database. Not required for embedded databases. |
string |
dedicatedExecutorNodes |
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. |
boolean |
delegationPassword |
DEPRECATED: As of PVC 1.5.4 we no longer use delegation user. Password of delegation user. |
string |
delegationUsername |
DEPRECATED: As of PVC 1.5.4 we no longer use delegation user. 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 |
environmentCrn |
The CRN of the environment for the cluster to create. |
string |
resourcePool |
The Resource Pool of the cluster. |
string |
securityContextConstraintName |
DEPRECATED: This option will be removed in future releases. Instead of creating a custom Security Context Constraint, we rely on the cluster default. The name of the Hive Security Context Constraint. |
string |
storageClass |
The storage class for the Local Storage Operator. |
string |
CreatePrivateClusterResponse
Response object for the createPrivateCluster method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of new Private Cloud cluster. |
string |
CreateResourceTemplateRequest
Request object for the createResourceTemplate method.
| Name | Description | Schema |
|---|---|---|
description |
Description of the template. |
string |
entityType |
Entity type for which the template will be created. (Possible values: impala, hive, trino, hue, dbc, viz). |
string |
id |
ID of the template. |
string |
name |
Name of the template. |
string |
resources |
The resource values of the template. |
< string, CreateApplicationResources > map |
CreateResourceTemplateResponse
The response object for the createResourceTemplate method.
| Name | Description | Schema |
|---|---|---|
templateId |
The id of the new template. |
string |
CreateVwDiagnosticDataJobRequest
Request object for the createVwDiagnosticDataJob method.
| Name | Description | Schema |
|---|---|---|
bundleMetadata |
Additional user-defined metadata information which is attached to resulting bundle-info.json when posting the bundle. |
< string, string > map |
caseNumber |
Optional support case number in case of UPLOAD_TO_CLOUDERA destination, otherwise only act as additional data. |
string |
clusterId |
ID of cluster. |
string |
destination |
Destination of the diagnostics collection. |
enum (UPLOAD_TO_CLOUDERA, DOWNLOAD) |
endTime |
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 |
Forced recreation of the diagnostic job. |
boolean |
hiveDownloadOptions |
DEPRECATED: All logs are included by default |
|
impalaDownloadOptions |
DEPRECATED: All logs are included by default |
|
startTime |
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 |
ID of the Virtual Warehouse. |
string |
CreateVwDiagnosticDataJobResponse
Response object for the createVwDiagnosticDataJob method.
| Name | Description | Schema |
|---|---|---|
id |
Identifier for each bundle collection. |
string |
labels |
Additional key-value pair attributes associated with the Diagnostic Data Job. |
< string, string > map |
status |
Status of the diagnostics collection request. |
string |
url |
This URL points to a download location if the destination is DOWNLOAD. |
string |
CreateVwRequest
Request object for the createVw method.
| Name | Description | Schema |
|---|---|---|
autoscaling |
Autoscaling settings for the Virtual Warehouse. |
|
availabilityZone |
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 |
ID of cluster where Virtual Warehouse should be created. |
string |
config |
Configuration settings for the Virtual Warehouse. |
|
dbcId |
ID of Database Catalog that the Virtual Warehouse should be attached to. |
string |
ebsLLAPSpillGB |
Provides EBS gp3 volume as temporary storage space for Hive LLAP cache, and improves query performance. Configurable only at Virtual Warehouse creation. Using EBS volumes incurs additional costs. |
integer (int32) |
enableUnifiedAnalytics |
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 |
DEPRECATED - Sets the authentication mode to use by Hive Server: * |
string |
hiveServerHaMode |
Set Hive Server High Availability mode in Private Cloud: * |
string |
imageVersion |
version of the Virtual Warehouse. |
string |
impalaHaSettings |
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 |
Impala specific options. It cannot be provided for Virtual Warehouse types other than Impala. |
|
impalaQueryLog |
Denotes whether the Virtual Warehouse has the Impala Query Log enabled or not. |
boolean |
instanceType |
Instance type for this Virtual Warehouse. To learn what instance types are allowed to be used for a Hive or an Impala Virtual Warehouse, please use the 'describe-allowed-instance-types' command. The command output will list the usable instance types in its 'hive' and 'impala' fields accordingly. |
string |
name |
Name of the Virtual Warehouse. |
string |
nodeCount |
Nodes per compute cluster. If specified, forces 'template' to be 'custom' |
integer (int32) |
platformJwtAuth |
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 |
Query isolation settings for the Virtual Warehouse. For Impala this value will be considered only if Unified Analytics is enabled. |
|
resourcePool |
The Resource Pool of the Virtual Warehouse. |
string |
tShirtSize |
Name of T-shirt size to use, which will determine the number of nodes. |
enum (xsmall, small, medium, large) |
tags |
Tags associated with the resources. |
< TagRequest > array |
vwType |
Type of Virtual Warehouse to be created. |
CreateVwResponse
Response object for the createVw method.
| Name | Description | Schema |
|---|---|---|
vwId |
ID of the new Virtual Warehouse. |
string |
CustomRegistryOptions
Options for custom ACR, ECR registry.
| Name | Description | Schema |
|---|---|---|
registryType |
Custom registry type. |
enum (ACR, ECR) |
repositoryUrl |
URL of the custom image repository. |
string |
DBCCreateDiagnosticDataDownloadOptions
DEPRECATED: Included by default, no need to specify
| Name | Description | Schema |
|---|---|---|
includeKubernetesResourceInfo |
DEPRECATED: Included by default, no need to specify |
boolean |
DataVisualizationSummary
A Cloudera Data Visualization.
| Name | Description | Schema |
|---|---|---|
adminGroups |
Admin groups that are allowed to access the Data Visualization. |
< string > array |
creatorCrn |
The CRN of the user who created the Cloudera Data Visualization |
string |
id |
The ID of the Cloudera Data Visualization. |
string |
imageVersion |
Current image version of the Cloudera Data Visualization |
string |
name |
The name of the Cloudera Data Visualization. |
string |
resourcePool |
The name of the Resource Pool the Cloudera Data Visualization is in. |
string |
size |
The template size for the Cloudera Data Visualization |
string |
status |
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 |
User groups that are allowed to access the Data Visualization. |
< string > array |
DbcDiagnosticDataJob
Represents a Diagnostic Data Job
| Name | Description | Schema |
|---|---|---|
endTime |
The finish time of the Diagnostic Data Job. |
string (date-time) |
jobId |
The unique identifier of the Diagnostic Data Job. |
string |
labels |
Additional key-value pair attributes associated with the Diagnostic Data Job. |
< string, string > map |
startTime |
The start time of the Diagnostic Data Job. |
string (date-time) |
status |
The job status. |
|
url |
This URL points to a download location if the destination is DOWNLOAD. |
string |
DbcSummary
A Database Catalog.
| Name | Description | Schema |
|---|---|---|
creationDate |
Creation date of Database Catalog. |
string (date-time) |
creator |
The creator of the Database Catalog. |
|
crn |
The CRN of the Database Catalog. |
string |
id |
The ID of the Database Catalog. |
string |
memorySize |
Metastore container memory size. |
string |
name |
The name of the Database Catalog. |
string |
resourcePool |
The name of the Resource Pool the Database Catalog is in. |
string |
resources |
The actual resources used by the Database Catalog. |
< string, ApplicationResources > map |
status |
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 |
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 |
The CRN of the backup. |
string |
DeleteBackupResponse
Response object for the delete backup request.
| Name | Description | Schema |
|---|---|---|
deleteBackupCrn |
The CRN of the delete backup custom resource. |
string |
DeleteClusterDiagnosticDataJobRequest
Request object for the deleteClusterDiagnosticDataJob method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of the Cluster. |
string |
jobId |
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 |
The ID of the cluster to delete. |
string |
force |
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. |
boolean |
DeleteClusterResponse
Response object for the deleteCluster method.
Type : object
DeleteDataVisualizationRequest
Request object for the deleteDataVisualization method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of the Cloudera Data Visualization’s cluster. |
string |
dataVisualizationId |
ID of the Cloudera Data Visualization to delete from the cluster. |
string |
DeleteDataVisualizationResponse
Response object for the deleteDataVisualization method.
| Name | Description | Schema |
|---|---|---|
status |
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 |
ID of cluster. |
string |
dbcId |
ID of the Database Catalog. |
string |
jobId |
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 |
ID of the Database Catalog’s cluster. |
string |
dbcId |
ID of the Database Catalog to delete. |
string |
DeleteDbcResponse
Response object for the deleteDbc method.
Type : object
DeleteResourceTemplateRequest
Request object for the deleteResourceTemplate method.
| Name | Description | Schema |
|---|---|---|
templateId |
The ID of the template. |
string |
templateVersion |
Version of the template. |
integer (int32) |
DeleteResourceTemplateResponse
The response object for the deleteResourceTemplate method.
| Name | Description | Schema |
|---|---|---|
templateId |
The id of the deleted template. |
string |
DeleteUserRequest
Request object for the deleteUser method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The ID of the cluster from which the user must be deleted. |
string |
userId |
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 |
ID of cluster. |
string |
jobId |
ID of the diagnostic job. |
string |
vwId |
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 |
ID of the Virtual Warehouse’s cluster. |
string |
vwId |
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 |
Instance type settings that are being used during cluster creation command on the AWS platform |
|
azure |
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 |
The CRN of the backup. |
string |
DescribeBackupResponse
Response object for the describe backup request.
| Name | Description | Schema |
|---|---|---|
backup |
The backup details. |
DescribeClusterDiagnosticDataJobRequest
Request object for the describeClusterDiagnosticDataJob method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of the Cluster. |
string |
jobId |
ID of the diagnostic job. |
string |
DescribeClusterDiagnosticDataJobResponse
Response object for the describeClusterDiagnosticDataJob method.
| Name | Description | Schema |
|---|---|---|
job |
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 |
The ID of the cluster to describe. |
string |
DescribeClusterResponse
Response object for the describeCluster method.
| Name | Description | Schema |
|---|---|---|
cluster |
The cluster. |
DescribeConfigDiffRequest
Request object for the describeConfigDiff method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of the cluster. |
string |
fromConfigId |
ID of the old service configuration. |
string |
toConfigId |
ID of the new service configuration. |
string |
DescribeConfigDiffResponse
Response object for the describeConfigDiff method.
| Name | Description | Schema |
|---|---|---|
config |
The service configuration. |
DescribeConfigRequest
Request object for the describeConfig method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of the cluster. |
string |
configId |
ID of the service (Database Catalog or Virtual Warehouse). |
string |
DescribeConfigResponse
Response object for the describeConfig method.
| Name | Description | Schema |
|---|---|---|
config |
The service configuration. |
DescribeDataVisualizationRequest
Request object for the describeDataVisualization method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of the Cloudera Data Visualization’s cluster. |
string |
dataVisualizationId |
ID of the Cloudera Data Visualization |
string |
DescribeDataVisualizationResponse
Response object for the describeDataVisualization method.
| Name | Description | Schema |
|---|---|---|
dataVisualization |
The Cloudera Data Visualization. |
DescribeDbcConfigRequest
Request object for the describeDbcConfig method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of the cluster. |
string |
dbcId |
ID of the Database Catalog. |
string |
DescribeDbcConfigResponse
Response object for the describeDbcConfig method.
| Name | Description | Schema |
|---|---|---|
config |
The Database Catalog configuration. |
DescribeDbcDiagnosticDataJobRequest
Request object for the describeDbcDiagnosticDataJobRequest method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of cluster. |
string |
dbcId |
ID of the Database Catalog. |
string |
jobId |
ID of the diagnostic job. |
string |
DescribeDbcDiagnosticDataJobResponse
Response object for the describeDbcDiagnosticDataJobRequest method.
| Name | Description | Schema |
|---|---|---|
job |
The job belonging to the particular Database Catalog |
DescribeDbcRequest
Request object for the describeDbc method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of the Database Catalog’s cluster. |
string |
dbcId |
ID of the Database Catalog. |
string |
DescribeDbcResponse
Response object for the describeDbc method.
| Name | Description | Schema |
|---|---|---|
dbc |
The Database Catalog. |
DescribeKubeconfigRequest
Request object for the describeKubeconfig method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The ID of the cluster to describe. |
string |
DescribeKubeconfigResponse
Response object for the describeKubeconfig method.
| Name | Description | Schema |
|---|---|---|
kubeconfig |
The kubeconfig. |
string |
DescribeRestoreRequest
Request object for the describe restore request.
| Name | Description | Schema |
|---|---|---|
restoreCrn |
The CRN of the restore. |
string |
DescribeRestoreResponse
Response object for the describe restore request.
| Name | Description | Schema |
|---|---|---|
restore |
The restore details. |
DescribeServerSettingItem
A DWX server setting.
| Name | Description | Schema |
|---|---|---|
configurationKey |
The identifier of the setting. |
string |
configurationName |
The name of the setting in human readable format. |
string |
description |
The description of the setting. |
string |
enabled |
The state of the setting. |
boolean |
requiresUpdate |
Indicates update requirements for the change to take effect. |
< DescribeServerSettingItemRequiresUpdate > array |
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. IMPALA - Means that the Impala Virtual Warehouses need the update/recreation. HIVE - Means that the Hive Virtual Warehouses need the update/recreation. TRINO - Means that the Trino Virtual Warehouses need the update/recreation. VIZ - Means that the Dataviz need the update/recreation. CDW_HUE - Means that the CDW Hues need an update/recreation.
Type : enum (ENVIRONMENT, DBC, IMPALA, HIVE, TRINO, VIZ, CDW_HUE)
DescribeServerSettingRequest
Request object for the describeServerSetting method.
Type : object
DescribeServerSettingResponse
Response object for the describeServerSetting method.
| Name | Description | Schema |
|---|---|---|
settings |
The list of the server settings. |
< DescribeServerSettingItem > array |
DescribeVwConfigRequest
Request object for the describeVwConfig method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of the cluster. |
string |
vwId |
ID of the Virtual Warehouse. |
string |
DescribeVwConfigResponse
Response object for the describeVwConfig method.
| Name | Description | Schema |
|---|---|---|
config |
The Virtual Warehouse configuration. |
DescribeVwDiagnosticDataJobRequest
Request object for the describeVwDiagnosticDataJobRequest method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of cluster. |
string |
jobId |
ID of the diagnostic job. |
string |
vwId |
ID of the Virtual Warehouse. |
string |
DescribeVwDiagnosticDataJobResponse
Response object for the describeVwDiagnosticDataJobRequest method.
| Name | Description | Schema |
|---|---|---|
job |
The job belonging to the particular Virtual Warehouse. |
DescribeVwRequest
Request object for the describeVw method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of the Virtual Warehouse’s cluster. |
string |
vwId |
ID of the Virtual Warehouse. |
string |
DescribeVwResponse
Response object for the describeVw method.
| Name | Description | Schema |
|---|---|---|
vw |
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 |
The error code. |
string |
message |
The error message. |
string |
Event
Represents a Event.
| Name | Description | Schema |
|---|---|---|
event |
The name of the event. |
string |
message |
Detailed message. |
string |
operationId |
The ID of the operation to which the event belongs. |
string |
serviceId |
The ID of the service to which the event belongs. |
string |
timestamp |
The timestamp of the event. |
string (date-time) |
EventResponse
Represents a Event
| Name | Description | Schema |
|---|---|---|
event |
The code name of the event |
string |
message |
Detailed message |
string |
timestamp |
The timestamp of the event |
string (date-time) |
ExternalBucket
External bucket details.
| Name | Description | Schema |
|---|---|---|
accessInfo |
AccessInfo of the bucket. |
|
name |
Name of the bucket. |
string |
ExternalBucketAccessInfo
External bucket definition.
| Name | Description | Schema |
|---|---|---|
accessMode |
Specifies whether the external bucket will be added in read-only or read-write mode. |
enum (READ, READWRITE) |
kmsCmkArn |
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 |
ID of the Cloudera Data Visualization’s cluster. |
string |
dataVisualizationId |
ID of the Cloudera Data Visualization. |
string |
GetDataVisualizationUpgradeVersionResponse
Response object for the getDataVisualizationUpgradeVersion method.
| Name | Description | Schema |
|---|---|---|
upgradeVersions |
Details of upgrade versions. |
GetK8sCertJKSRequest
Request object for the getK8sCertJKS method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The cluster ID of the CDW environment to get the Kubernetes certificates for. |
string |
GetK8sCertJKSResponse
The response object for the getK8sCertJKS method.
| Name | Description | Schema |
|---|---|---|
data |
Base64 encoded Java truststore. |
string (byte) |
password |
The password for the received Java truststore. |
string |
GetK8sCertPEMRequest
Request object for the getK8sCertPEM method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The cluster ID of the CDW environment to get the Kubernetes certificates for. |
string |
GetK8sCertPEMResponse
The response object for the getK8sCertPEM method.
| Name | Description | Schema |
|---|---|---|
pem |
The Kubernetes certificate in PEM format. |
string |
GetLogsRequest
Request object for the get logs request.
| Name | Description | Schema |
|---|---|---|
crn |
The CRN of the backup, restore or backup deletion. |
string |
GetLogsResponse
Response object for the get logs request.
| Name | Description | Schema |
|---|---|---|
logs |
Contains the logs of the operation. |
string |
GetUpgradeDbcVersionsRequest
Request object for the getUpgradeDbcVersions method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The ID of the Database Catalog’s cluster. |
string |
dbcId |
The ID of the Database Catalog. |
string |
GetUpgradeDbcVersionsResponse
Response object for the getUpgradeDbcVersions method.
| Name | Description | Schema |
|---|---|---|
compatibleCDPVersion |
The latest compatible CDP version. |
string |
compatibleVersion |
The latest compatible CDW version. |
string |
latestCDPVersion |
The latest available CDP version. |
string |
latestVersion |
The latest available CDW version. |
string |
GetUpgradeVwVersionsRequest
Request object for the getUpgradeVwVersions method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The ID of the Virtual Warehouse’s cluster. |
string |
vwId |
The ID of the Virtual Warehouse. |
string |
GetUpgradeVwVersionsResponse
Response object for the getUpgradeVwVersions method.
| Name | Description | Schema |
|---|---|---|
compatibleCDPVersion |
The latest compatible CDP version. |
string |
compatibleVersion |
The latest compatible CDW version. |
string |
latestCDPVersion |
The latest available CDP version. |
string |
latestVersion |
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 |
HealthCheck status text. |
string |
HiveCreateDiagnosticDataDownloadOptions
DEPRECATED: Included by default, no need to specify
| Name | Description | Schema |
|---|---|---|
includeComputeResourceInfo |
DEPRECATED: Included by default, no need to specify |
boolean |
includeErrordump |
DEPRECATED: Included by default, no need to specify |
boolean |
includeGclogs |
DEPRECATED: Included by default, no need to specify |
boolean |
includeHeapdump |
DEPRECATED: Included by default, no need to specify |
boolean |
includeHms |
DEPRECATED: Included by default, no need to specify |
boolean |
includeKubernetesResourceInfo |
DEPRECATED: Included by default, no need to specify |
boolean |
includeLogs |
DEPRECATED: Included by default, no need to specify |
boolean |
ImpalaCreateDiagnosticDataDownloadOptions
DEPRECATED: Included by default, no need to specify
| Name | Description | Schema |
|---|---|---|
includeHms |
DEPRECATED: Included by default, no need to specify |
boolean |
includeKubernetesResourceInfo |
DEPRECATED: Included by default, no need to specify |
boolean |
includeMinidump |
DEPRECATED: Included by default, no need to specify |
boolean |
includeProfile |
DEPRECATED: Included by default, no need to specify |
boolean |
includeSidecar |
DEPRECATED: Included by default, no need to specify |
boolean |
includeWorkload |
DEPRECATED: Included by default, no need to specify |
boolean |
ImpalaExecutorGroupSetCreateRequest
Configure independently scaling set of uniformly sized executor groups.
| Name | Description | Schema |
|---|---|---|
autoSuspendTimeoutSeconds |
Set auto suspend threshold. If not provided defaults will apply. |
integer (int32) |
disableAutoSuspend |
Turn off auto suspend. If not provided defaults will apply. |
boolean |
execGroupSize |
Set number of executors per executor group. |
integer (int32) |
maxExecutorGroups |
Set maximum number of executor groups allowed. |
integer (int32) |
minExecutorGroups |
Set minimum number of executor groups allowed. |
integer (int32) |
triggerScaleDownDelay |
Set scale down threshold in seconds. If not provided defaults will apply. |
integer (int32) |
triggerScaleUpDelay |
Set scale up threshold in seconds. If not provided defaults will apply. |
integer (int32) |
ImpalaExecutorGroupSetResponse
Describes configurations for an executor group set.
| Name | Description | Schema |
|---|---|---|
autoSuspendTimeoutSeconds |
Auto suspend threshold. |
integer (int32) |
disableAutoSuspend |
Denotes whether auto suspend is turned off. |
boolean |
execGroupSize |
Number of executors per executor group. |
integer (int32) |
groupSetPrefix |
Name of resource pool for this executor group set. |
string |
maxExecutorGroups |
Maximum number of executor groups allowed. |
integer (int32) |
minExecutorGroups |
Minimum number of executor groups allowed. |
integer (int32) |
triggerScaleDownDelay |
Scale down threshold in seconds. |
integer (int32) |
triggerScaleUpDelay |
Scale up threshold in seconds. |
integer (int32) |
ImpalaExecutorGroupSetUpdateRequest
Re-configure independently scaling set of uniformly sized executor groups.
| Name | Description | Schema |
|---|---|---|
autoSuspendTimeoutSeconds |
Set auto suspend threshold. If not provided defaults will apply. |
integer (int32) |
deleteGroupSet |
Delete the executor group set. |
boolean |
disableAutoSuspend |
Turn off auto suspend. If not provided defaults will apply. |
boolean |
execGroupSize |
Set number of executors per executor group. |
integer (int32) |
maxExecutorGroups |
Set maximum number of executor groups allowed. |
integer (int32) |
minExecutorGroups |
Set minimum number of executor groups allowed. |
integer (int32) |
triggerScaleDownDelay |
Set scale down threshold in seconds. If not provided defaults will apply. |
integer (int32) |
triggerScaleUpDelay |
Set scale up threshold in seconds. If not provided defaults will apply. |
integer (int32) |
ImpalaExecutorGroupSetsCreateRequest
Configure executor group sets for workload aware autoscaling.
| Name | Description | Schema |
|---|---|---|
custom1 |
Configure first optional custom executor group set for workload aware autoscaling. |
|
custom2 |
Configure second optional custom executor group set for workload aware autoscaling. |
|
custom3 |
Configure third optional custom executor group set for workload aware autoscaling. |
|
large |
Configure large executor group set for workload aware autoscaling. |
|
small |
Configure small executor group set for workload aware autoscaling. |
ImpalaExecutorGroupSetsResponse
Describes executor group sets for workload aware autoscaling.
| Name | Description | Schema |
|---|---|---|
custom1 |
Describes first custom executor group set for workload aware autoscaling. |
|
custom2 |
Describes second custom executor group set for workload aware autoscaling. |
|
custom3 |
Describes third custom executor group set for workload aware autoscaling. |
|
large |
Describes large executor group set for workload aware autoscaling. |
|
small |
Describes small executor group set for workload aware autoscaling. |
ImpalaExecutorGroupSetsUpdateRequest
Re-configure executor group sets for workload aware autoscaling.
| Name | Description | Schema |
|---|---|---|
custom1 |
Re-configure first optional custom executor group set for workload aware autoscaling. |
|
custom2 |
Re-configure second optional custom executor group set for workload aware autoscaling. |
|
custom3 |
Re-configure third optional custom executor group set for workload aware autoscaling. |
|
large |
Re-configure large executor group set for workload aware autoscaling. |
|
small |
Re-configure small executor group set for workload aware autoscaling. |
ImpalaHASettingsCreateRequest
High Availability settings for the Impala Virtual Warehouse. The values are disregarded for Hive.
| Name | Description | Schema |
|---|---|---|
enableCatalogHighAvailability |
Enables a backup instance for Impala catalog to ensure high availability. |
boolean |
enableShutdownOfCoordinator |
Enables a shutdown of the coordinator. If Unified Analytics is enabled, then this setting is explicitly disabled (ignored) and should not be provided. |
boolean |
enableStatestoreHighAvailability |
Enables a backup instance for Impala Statestore to ensure high availability. |
boolean |
highAvailabilityMode |
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 |
The number of active coordinators. |
integer (int32) |
shutdownOfCoordinatorDelaySeconds |
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 |
Denotes whether a backup instance for Impala catalog is enabled. |
boolean |
enableShutdownOfCoordinator |
Whether a shutdown of the coordinator is enabled. |
boolean |
enableStatestoreHighAvailability |
Denotes whether a backup instance for Impala Statestore is enabled. |
boolean |
highAvailabilityMode |
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 |
Number of the active coordinators. |
integer (int32) |
shutdownOfCoordinatorDelaySeconds |
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 |
The number of active coordinators. |
integer (int32) |
shutdownOfCoordinatorDelaySeconds |
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 |
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 |
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 |
Maximum scratch space used for spilling to disk. |
integer (int32) |
spillToS3Uri |
Impala spill to S3 URI. |
string |
KeyPairCredentials
Certificate and private key pair credentials, that could be used ie mutual TLS connections therefore these must belong together.
| Name | Description | Schema |
|---|---|---|
certificate |
The content of certificate PEM file. |
string |
privateKey |
The content of private key PEM file. |
string |
KeyValuesDiff
Different between keyValues of two ConfigContents.
| Name | Description | Schema |
|---|---|---|
added |
Keys that are only present in the new configuration. |
< string, string > map |
changed |
Keys with different values. |
< string, StringDiff > map |
removed |
Keys that are only present in the old configuration. |
< string, string > map |
same |
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 |
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 |
Specified name for the backup. If not present, this filter is not used. |
string |
jobStates |
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 |
List of backups. |
< SimpleBackup > array |
ListClusterDiagnosticDataJobsRequest
Request object for the listClusterDiagnosticDataJobs method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of the Cluster. |
string |
pageSize |
The size of each page. |
integer (int32) |
startingToken |
A token to specify where to start paginating. This is the nextToken from a previously truncated response. |
string |
status |
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 |
The list of jobs belonging to the particular cluster. |
< ClusterDiagnosticDataJob > array |
nextToken |
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 |
Filter returned clusters by hosting platform. |
enum (AWS, AZURE) |
clusterId |
Filter returned clusters by cluster ID. |
string |
environmentCrn |
Filter returned clusters for the belonging Environment CRN. |
string |
name |
Filter returned clusters by name. |
string |
status |
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 |
The list of clusters. |
< ClusterSummaryResponse > array |
ListDataVisualizationsRequest
Request object for the listDataVisualizations method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of cluster to list Cloudera Data Visualizations. |
string |
ListDataVisualizationsResponse
Response object for the listDataVisualizations method.
| Name | Description | Schema |
|---|---|---|
dataVisualizations |
The list of Cloudera Data Visualizations. |
< DataVisualizationSummary > array |
ListDbcConfigsRequest
Request object for the listDbcConfigs method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of the Database Catalog’s cluster. |
string |
dbcId |
ID of the Database Catalog. |
string |
ListDbcConfigsResponse
Response object for the listDbcConfigs method.
| Name | Description | Schema |
|---|---|---|
configHistory |
Configuration history of a service. |
< ConfigHistoryItem > array |
ListDbcDiagnosticDataJobsRequest
Request object for the listDbcDiagnosticDataJobsRequest method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of cluster. |
string |
dbcId |
ID of the Database Catalog. |
string |
pageSize |
The size of each page. |
integer (int32) |
startingToken |
A token to specify where to start paginating. This is the nextToken from a previously truncated response. |
string |
status |
Filter for job type |
ListDbcDiagnosticDataJobsResponse
Response object for the listDbcDiagnosticDataJobsRequest method.
| Name | Description | Schema |
|---|---|---|
jobs |
The list of the jobs belonging to the particular Database Catalog |
< DbcDiagnosticDataJob > array |
nextToken |
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 |
Provide the result in ascending order, default is descending. |
boolean |
clusterId |
ID of cluster. |
string |
dbcId |
ID of the Database Catalog. |
string |
limit |
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 |
The list of the events belonging to the particular Database Catalog |
< EventResponse > array |
ListDbcsRequest
Request object for the listDbcs method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of cluster to list. |
string |
ListDbcsResponse
Response object for the listDbcs method.
| Name | Description | Schema |
|---|---|---|
dbcs |
The list of Database Catalogs. |
< DbcSummary > array |
ListEventsRequest
Request object for the listEvents method.
| Name | Description | Schema |
|---|---|---|
ascending |
Provide the result in ascending order, default is descending. |
boolean |
limit |
Limit the number of returned rows. If not specified then the recent 20 events will be returned. The maximum is 100. |
integer (int32) |
operationId |
Filter events based on the operation ID. Either operation ID or service ID is required. |
string |
serviceId |
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 |
List of the events. |
< Event > array |
ListLatestVersionsRequest
Request object of the listLatestVersions call.
| Name | Description | Schema |
|---|---|---|
clusterId |
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 |
Map containing the latest image versions for each Virtual Warehouse found in the cluster. |
< string, string > map |
ListResourceTemplatesRequest
Request object for the listResourceTemplates method.
Type : object
ListResourceTemplatesResponse
The response object for the listResourceTemplates method.
| Name | Description | Schema |
|---|---|---|
templates |
Array of the resource templates. |
< ResourceTemplateResponse > array |
ListRestoresRequest
Request object for the list restores request.
| Name | Description | Schema |
|---|---|---|
backupCrn |
CRN of the backup. |
string |
jobStates |
The job states to filter by. |
< string > array |
ListRestoresResponse
Response object for the list restores request.
| Name | Description | Schema |
|---|---|---|
restores |
List of restores for the control plane. |
< SimpleRestore > array |
ListUsersRequest
Request object for the listUsers method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The ID of the cluster for which the users must be retrieved. |
string |
ListUsersResponse
Response object for the listUsers method.
| Name | Description | Schema |
|---|---|---|
users |
The list of users allowed to access the given cluster. |
< CloudUserReference > array |
ListVwConfigsRequest
Request object for the listVwConfigs method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of the Virtual Warehouse’s cluster. |
string |
vwId |
ID of the Virtual Warehouse. |
string |
ListVwConfigsResponse
Response object for the listVwConfigs method.
| Name | Description | Schema |
|---|---|---|
configHistory |
Configuration history of a service. |
< ConfigHistoryItem > array |
ListVwDiagnosticDataJobsRequest
Request object for the listVwDiagnosticDataJobsRequest method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of cluster. |
string |
pageSize |
The size of each page. |
integer (int32) |
startingToken |
A token to specify where to start paginating. This is the nextToken from a previously truncated response. |
string |
status |
Filter for job type |
|
vwId |
ID of the Virtual Warehouse. |
string |
ListVwDiagnosticDataJobsResponse
Response object for the listVwDiagnosticDataJobsRequest method.
| Name | Description | Schema |
|---|---|---|
jobs |
The list of the jobs belonging to the particular Virtual Warehouse. |
< VwDiagnosticDataJob > array |
nextToken |
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 |
Provide the result in ascending order, default is descending. |
boolean |
clusterId |
ID of cluster. |
string |
limit |
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 |
ID of the Virtual Warehouse. |
string |
ListVwEventsResponse
Response object for the listVwEvents method.
| Name | Description | Schema |
|---|---|---|
events |
The list of the events belonging to the particular Virtual Warehouse |
< EventResponse > array |
ListVwsRequest
Request object for the listVws method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of cluster to list. |
string |
filter |
Filter object for listVws method. |
ListVwsResponse
Response object for the listVws method.
| Name | Description | Schema |
|---|---|---|
vws |
The list of Virtual Warehouses. |
< VwSummary > array |
Message
The message object used to display warnings and errors during DRS workflows
| Name | Description | Schema |
|---|---|---|
namespace |
The namespace that has the warning/error. |
string |
text |
The text message of the warning/error. |
string |
timestamp |
The time when the warning/error is hit. |
string |
PrivateCloudActivationOptions
Options for activating a Private Cloud environment.
| Name | Description | Schema |
|---|---|---|
dbClientCredentials |
A certificate and private key pair belonging together for mutual SSL handshake when Database Catalog (aka DBC) connects to the metastore database. |
|
dbDas |
DEPRECATED: Current Private Cloud releases only support embedded database, the value of this field is ignored. The name of the DAS database. Not required for embedded databases. |
string |
dbHue |
DEPRECATED: Current Private Cloud releases only support embedded database, the value of this field is ignored. The name of the HUE database. Not required for embedded databases. |
string |
dedicatedExecutorNodes |
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. |
boolean |
delegationPassword |
DEPRECATED: As of PVC 1.5.4 we no longer use delegation user. Password of delegation user. |
string |
delegationUsername |
DEPRECATED: As of PVC 1.5.4 we no longer use delegation user. 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 |
DEPRECATED: This option will be removed in future releases. Instead of creating a custom Security Context Constraint, we rely on the cluster default. The name of the Hive Security Context Constraint. |
string |
storageClass |
The storage class for the Local Storage Operator. |
string |
QueryIsolationOptionsRequest
Configurations for Query Isolation.
| Name | Description | Schema |
|---|---|---|
maxNodesPerQuery |
Maximum Nodes Per Isolated Query. If not provided, 0 will be applied. The 0 value means the query isoltaion functionality will be disabled. |
integer (int32) |
maxQueries |
Maximum Concurrent Isolated Queries. If not provided, 0 will be applied. The 0 value means the query isoltaion functionality will be disabled. |
integer (int32) |
QueryIsolationOptionsResponse
Configurations for Query Isolation.
| Name | Description | Schema |
|---|---|---|
maxNodesPerQuery |
Maximum Nodes Per Isolated Query |
integer (int32) |
maxQueries |
Maximum Concurrent Isolated Queries |
integer (int32) |
RebuildDbcRequest
Request object for the rebuildDbc method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of the Database Catalog’s cluster. |
string |
dbcId |
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 |
ID of the Virtual Warehouse’s cluster. |
string |
vwId |
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 |
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 |
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 |
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 |
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 |
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) |
ResourceTemplateResponse
Resource template.
| Name | Description | Schema |
|---|---|---|
description |
Short description. |
string |
entityType |
The type of the entity, which can be one of the following: Hive, Impala, Hue, DataViz. |
string |
id |
Identifier of the template. |
string |
isDefault |
Denotes whether it is the default template or not. |
boolean |
name |
Name of the template. |
string |
version |
Version number. |
integer (int32) |
RestartDbcRequest
Request object for the restartDbc method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of the Database Catalog’s cluster. |
string |
dbcId |
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 |
ID of the Virtual Warehouse’s cluster. |
string |
vwId |
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 |
The CRN of the backup. |
string |
errors |
The errors from restore job. |
< Message > array |
excludedResources |
The list of resources to be excluded in restore. |
< string > array |
includedNamespaces |
The list of namespaces to be included in restore. |
< string > array |
restoreCreationTime |
The time when the restore was created. |
string |
restoreCrn |
The CRN of the restore. |
string |
restoreJob |
The restore job name. |
string |
restoreJobState |
The current state of the restore job. |
string |
restorePhase |
The phase of the restore operation. |
string |
restoreUpdatedTime |
The updated time of the restore. |
string |
successConditions |
The list of conditions to be met for a successful restore. |
< string > array |
warnings |
The warnings from restore job. |
< Message > array |
RestoreBackupRequest
Request object for the restore backup request.
| Name | Description | Schema |
|---|---|---|
backupCrn |
The CRN of the backup. |
string |
namespaceNames |
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 |
The CRN of the restore. |
string |
RestoreClusterEntityPlan
Entity status after the restore operation.
| Name | Description | Schema |
|---|---|---|
action |
The action associated with the plan. Possible actions: Create, Update, Skip |
string |
id |
The ID of the entity. |
string |
message |
The description of the plan. |
string |
ref |
The reference of the entity in the backup data. |
string |
RestoreClusterRequest
Request object for the restoreCluster method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The ID of the cluster. |
string |
data |
Backup data of configuration received by calling "backup-cluster" command. |
string |
RestoreClusterResponse
Response object for the restoreCluster method.
| Name | Description | Schema |
|---|---|---|
action |
The cluster action. Possible actions: Create, Skip |
string |
clusterId |
The ID of the cluster. |
string |
dbcRestorePlans |
Information about the restore-plan of the DbCatalogs. |
< RestoreClusterEntityPlan > array |
hiveRestorePlans |
Information about the restore-plan of the Hive Virtual Warehouses. |
< RestoreClusterEntityPlan > array |
hueRestorePlans |
Information about the restore-plan of Hue. |
< RestoreClusterEntityPlan > array |
impalaRestorePlans |
Information about the restore-plan of the Impala Virtual Warehouses. |
< RestoreClusterEntityPlan > array |
message |
The description of the cluster action. |
string |
operationId |
The ID of the restore operation. |
string |
vizRestorePlans |
Information about the restore-plan of the Data Visualization Apps. |
< RestoreClusterEntityPlan > array |
ResumeClusterRequest
Request object for resume cluster method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The ID of the cluster to resume. |
string |
ResumeClusterResponse
The response object for the resumeCluster method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The ID of the cluster to describe. |
string |
ServiceConfigDiff
Differences between two service configurations.
| Name | Description | Schema |
|---|---|---|
applicationConfigsDiffs |
Differences between the application specific configurations. |
< string, ApplicationConfigDiff > map |
commonConfigsDiff |
Differences between the common configurations. |
|
isChanged |
Has any of the configurations changed? |
boolean |
ServiceConfigReq
Configurations for a service (DBC or VW)
| Name | Description | Schema |
|---|---|---|
applicationConfigs |
Application specific configurations. |
< string, ApplicationConfigReq > map |
commonConfigs |
Configurations that are applied to every application in the service. |
|
enableSSO |
Should SSO be enabled for this VW. |
boolean |
ldapGroups |
LDAP Groupnames to be enabled for auth. |
< string > array |
ServiceConfigResp
Configurations for a service (DBC or VW)
| Name | Description | Schema |
|---|---|---|
applicationConfigs |
Application specific configurations. |
< string, ApplicationConfigResp > map |
commonConfigs |
Configurations that are applied to every application in the service. |
|
enableSSO |
Should SSO be enabled for this VW. This cannot be changed later. |
boolean |
ldapGroups |
List of LDAP Groupnames to be enabled for auth. |
< string > array |
SimpleBackup
A simple backup entry for listBackup usage
| Name | Description | Schema |
|---|---|---|
backupCreationTime |
The time when the backup was created. |
string |
backupCrn |
The CRN of the backup. |
string |
backupName |
The display name of the backup. |
string |
SimpleRestore
A simple Restore entry for listRestore Usage
| Name | Description | Schema |
|---|---|---|
backupCrn |
The CRN of the backup. |
string |
includedNamespaces |
The list of namespaces to be included in restore. |
< string > array |
restoreCreationTime |
The time when the restore was created. |
string |
restoreCrn |
The CRN of the restore. |
string |
StartVwRequest
The request object for the startVw method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The ID of the Virtual Warehouse cluster. |
string |
vwId |
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 |
The old value. |
string |
to |
The new value. |
string |
SuspendClusterRequest
Request object for suspend cluster method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The ID of the cluster to suspend. |
string |
SuspendClusterResponse
The response object for the suspendCluster method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The ID of the cluster to describe. |
string |
SuspendDbcRequest
The request object for the suspendDbc method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The ID of the Database Catalog’s cluster. |
string |
dbcId |
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 |
The ID of the Virtual Warehouse cluster. |
string |
vwId |
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 |
The tag’s name. |
string |
value |
The associated value of the tag. |
string |
TagResponse
A key/value pair attached to some resources.
| Name | Description | Schema |
|---|---|---|
key |
The tag’s name. |
string |
value |
The associated value of the tag. |
string |
UpdateApplicationResources
The resource requirements of a component.
| Name | Description | Schema |
|---|---|---|
breakdown |
Breakdown of the service memory requirements. |
|
cpu |
Overall CPU requirements. |
number (float) |
ephemeralStorage |
Temporary storage for CDW pods, used for storing configurations and temporary data needed during a process. The lifespan of ephemeral storage is tied to the pod. |
string |
localStorageSize |
Local disk size requirements. |
|
memory |
Overall memory requirements. |
string |
UpdateApplicationResourcesBreakdown
Breakdown of the service memory requirements.
| Name | Description | Schema |
|---|---|---|
headroom |
DEPRECATED: Java VM configuration for -Xmx (maximum heap size).Java VM overhead for Garbage Collector structures, metaspace, etc., and a safety margin to avoid out-of-memory issues. |
string |
maxDirectMemorySize |
Java VM configuration for -XX:MaxDirectMemorySize (limit for Direct Byte Buffers). |
string |
waitQueueSize |
DEPRECATED: Set the hive.query.isolation.slots.per.node configuration value instead. Overhead buffer for hive.query.isolation.slots.per.node. The total number of concurrent tasks the Hive query executor can process is the sum of the available CPU cores and the value you specify in this field. |
integer (int32) |
xms |
Java VM configuration for -Xms (initial and minimum heap size). |
string |
xmx |
Java VM configuration for -Xmx (maximum heap size). |
string |
xss |
Java VM configuration for -Xss (thread stack size). |
string |
UpdateApplicationResourcesLocalStorageSize
Storage related information.
| Name | Description | Schema |
|---|---|---|
cache |
Local disk space used for writing cache data. |
string |
overhead |
Local disk space used for writing other temporary data, tools, etc. |
string |
scratch |
Local disk space used for writing scratch data. |
string |
UpdateAwsClusterRequest
Request object for the updateAwsCluster method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The ID of the AWS cluster to update. |
string |
description |
Cluster description. |
string |
externalBuckets |
Cluster external bucket definition to update. |
< string, UpdateClusterExternalBucketAccessInfo > map |
observabilityConfig |
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 |
|
whitelistK8sClusterAccessIpCIDRs |
List of IP address CIDRs to whitelist for kubernetes cluster access. |
< string > array |
whitelistWorkloadAccessIpCIDRs |
List of IP address CIDRs to whitelist for workload access. |
< string > array |
UpdateAwsClusterResponse
Response object for the updateAwsCluster method.
Type : object
UpdateAzureClusterRequest
Request object for the updateAzureCluster method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The ID of the Azure cluster to update. |
string |
description |
Cluster description. |
string |
observabilityConfig |
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 |
|
renewCertificate |
Renew Azure cluster certificate. |
boolean |
whitelistK8sClusterAccessIpCIDRs |
List of IP address CIDRs to whitelist for kubernetes cluster access. |
< string > array |
whitelistWorkloadAccessIpCIDRs |
List of IP address CIDRs to whitelist for workload access. |
< string > array |
UpdateAzureClusterResponse
Response object for the updateAzureCluster method.
Type : object
UpdateClusterExternalBucketAccessInfo
Cluster external bucket definition to update.
| Name | Description | Schema |
|---|---|---|
accessMode |
Specifies whether the external bucket will be added in read-only or read-write mode. |
enum (READ, READWRITE) |
kmsCmkArn |
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 |
Create the log forwarding configuration in a valid fluentd format. Then that configuration is later inserted into a larger fluentd configuration. |
string |
proxyCABundle |
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 |
Additional properties for AWS clusters. |
|
azureUpdate |
Additional properties for Azure clusters. |
|
clusterId |
The ID of the cluster to update. |
string |
description |
Cluster description. |
string |
observabilityConfig |
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 |
|
resourcePool |
Used to set the resource pool of the Private Cloud Data Services clusters that are not enrolled for quota management. |
string |
whitelistIpCIDRs |
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 |
List of IP address CIDRs to whitelist for kubernetes cluster access. |
< string > array |
whitelistWorkloadAccessIpCIDRs |
List of IP address CIDRs to whitelist for workload access. |
< string > array |
awsUpdate
| Name | Description | Schema |
|---|---|---|
externalBuckets |
External bucket definition. |
< string, UpdateClusterExternalBucketAccessInfo > map |
azureUpdate
| Name | Description | Schema |
|---|---|---|
renewCertificate |
Renew Azure cluster certificate. |
boolean |
UpdateClusterResponse
Response object for the updateCluster method.
Type : object
UpdateDataVisualizationRequest
Request object for the updateDataVisualization method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of the Cloudera Data Visualization’s cluster. |
string |
config |
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 |
ID of the Cloudera Data Visualization. |
string |
UpdateDataVisualizationResponse
Response object for the updateDataVisualization method.
| Name | Description | Schema |
|---|---|---|
status |
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 |
ID of the cluster. |
string |
component |
Database Catalog configuration component to update. |
enum (DasEventProcessor, DatabusProducer, HueQueryProcessor, Metastore) |
dbcId |
ID of the Database Catalog. |
string |
set |
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 |
ID of the Database Catalog’s cluster. |
string |
config |
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 |
ID of the Database Catalog. |
string |
memorySize |
Set Metastore container memory size. If not provided, small will apply. |
enum (small, medium, large) |
UpdateDbcResponse
Response object for the updateDbc method.
Type : object
UpdatePrivateClusterRequest
Request object for the updatePrivateCluster method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The ID of the Private Cloud cluster to update. |
string |
dedicatedExecutorNodes |
Set it true to enable dedicated nodes exclusively for executors and coordinators, and improve performance. You can enable this only if you reserve 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. |
boolean |
delegationPassword |
DEPRECATED: As of PVC 1.5.4 we no longer use delegation user. The password to update for delegation user. Setting it to the same value as the existing password will be a no-op. |
string |
delegationUsername |
DEPRECATED: As of PVC 1.5.4 we no longer use delegation user. The user name to update for delegation user. Setting it to the same value as the existing delegation user name will be a no-op. |
string |
description |
Cluster description. |
string |
resourcePool |
Used to set the resource pool of the Private Cloud Data Services clusters that are not enrolled for quota management. |
string |
UpdatePrivateClusterResponse
Response object for the updatePrivateCluster method.
Type : object
UpdateResourceTemplateRequest
Request object for the updateResourceTemplate method.
| Name | Description | Schema |
|---|---|---|
description |
Description of the template. |
string |
name |
Name of the template. |
string |
resources |
The resource values of the template. |
< string, UpdateApplicationResources > map |
templateId |
The ID of the template. |
string |
UpdateResourceTemplateResponse
The response object for the updateResourceTemplate method.
| Name | Description | Schema |
|---|---|---|
templateId |
The id of the updated template. |
string |
UpdateServerSettingItem
A DWX server setting update.
| Name | Description | Schema |
|---|---|---|
configurationKey |
The identifier of the setting. |
string |
enabled |
The state of the setting. |
boolean |
UpdateServerSettingRequest
Request object for the updateServerSetting method.
| Name | Description | Schema |
|---|---|---|
settings |
The list of the server setting updates. |
< UpdateServerSettingItem > array |
UpdateServerSettingResponse
Response object for the updateServerSetting method.
| Name | Description | Schema |
|---|---|---|
status |
Update status. |
string |
UpdateSshKeyRequest
Request object for the updateSshKey method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The ID of the cluster to update the SSH Key. |
string |
UpdateSshKeyResponse
Response object for the updateSshKey method.
| Name | Description | Schema |
|---|---|---|
message |
A message describing the outcome of the SSH Key update process. |
string |
status |
The status of the cluster. |
string |
UpdateVwConfigRequest
Request object for the updateVwConfig method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of the cluster. |
string |
component |
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 |
Configuration files of the selected component to update. |
< ConfigBlock > array |
vwId |
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 |
Autoscaling settings for the Virtual Warehouse. |
|
clusterId |
ID of the Virtual Warehouse’s cluster. |
string |
config |
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 |
DEPRECATED - Sets the authentication mode to use by Hive Server: * |
string |
hiveServerHaMode |
If specified, modifies Hive Server High Availability mode in Private Cloud: * |
string |
impalaHaSettings |
High Availability settings update for the Impala Virtual Warehouse. |
|
impalaQueryLog |
Denotes whether the Virtual Warehouse has the Impala Query Log enabled or not. |
boolean |
nodeCount |
Nodes per compute cluster. If specified, forces 'template' to be 'custom' |
integer (int32) |
platformJwtAuth |
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 |
Query isolation settings for Hive Virtual Warehouses. |
|
resourcePool |
Used to set the resource pool of the Virtual Warehouses that are not enrolled for quota management. |
string |
tShirtSize |
Name of T-shirt size to use, which will determine the number of nodes. |
enum (xsmall, small, medium, large) |
vwId |
ID of the Virtual Warehouse. |
string |
UpdateVwResponse
Response object for the updateVw method.
Type : object
UpgradeDataVisualizationRequest
Request object for the upgradeDataVisualization method.
| Name | Description | Schema |
|---|---|---|
clusterId |
ID of the Cloudera Data Visualization’s cluster. |
string |
dataVisualizationId |
ID of the Cloudera Data Visualization. |
string |
imageVersion |
Image version of the Cloudera Data Visualization to upgrade to. |
string |
UpgradeDataVisualizationResponse
Response object for the upgradeDataVisualization method.
| Name | Description | Schema |
|---|---|---|
status |
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 |
The ID of the Database Catalog’s cluster. |
string |
dbcId |
The ID of the Database Catalog. |
string |
imageVersion |
The version to which the Database Catalog should be upgraded. |
string |
UpgradeDbcResponse
Response object of the upgradeDbc call.
| Name | Description | Schema |
|---|---|---|
message |
The Upgrade message. |
string |
serviceUnhealthy |
True, if the service is in unhealthy state, false or omitted otherwise. |
boolean |
status |
The upgrade status. Possible values are: Upgrading, Error, Failed. |
string |
timedOut |
True if the upgrade timed out, false or omitted otherwise. |
boolean |
UpgradeVersions
Details of upgrade versions.
| Name | Description | Schema |
|---|---|---|
latestVersion |
Latest available Data Visualization version. |
string |
UpgradeVwRequest
Request object for the upgradeVw method.
| Name | Description | Schema |
|---|---|---|
clusterId |
The ID of the Virtual Warehouse’s cluster. |
string |
dbcId |
The ID of Database Catalog that the Virtual Warehouse is attached to. |
string |
imageVersion |
The version to which the Virtual Warehouse should be upgraded. |
string |
vwId |
The ID of the Virtual Warehouse. |
string |
UpgradeVwResponse
Response object for the upgradeVw method.
| Name | Description | Schema |
|---|---|---|
message |
The upgrade message. |
string |
serviceUnhealthy |
True, if the service is in unhealthy state, false or omitted otherwise. |
boolean |
status |
The upgrade status. Possible values are: Upgrading, Error, Failed. |
string |
timedOut |
True if the upgrade timed out, false or omitted otherwise. |
boolean |
VizConfig
Configurations for a Cloudera Data Visualization
| Name | Description | Schema |
|---|---|---|
adminGroups |
Admin groups to allow configuration access to Data Visualization for selected users |
< string > array |
resourcePool |
The Resource Pool of the Cloudera Data Visualization. |
string |
userGroups |
User groups to allow user access to Data Visualization for selected users |
< string > array |
VwDiagnosticDataJob
Represents a Diagnostic Data Job.
| Name | Description | Schema |
|---|---|---|
endTime |
The finish time of the Diagnostic Data Job. |
string (date-time) |
jobId |
The unique identifier of the Diagnostic Data Job. |
string |
labels |
Additional key-value pair attributes associated with the Diagnostic Data Job. |
< string, string > map |
startTime |
The start time of the Diagnostic Data Job. |
string (date-time) |
status |
The job status. |
|
url |
If the request is for download, this URL points to download location. |
string |
VwFilter
Filter object for Virtual Warehouses.
| Name | Description | Schema |
|---|---|---|
compactor |
Filter Virtual Warehouses whether it is a Compactor or not. |
boolean |
dbcId |
Filter Virtual Warehouses by Database Catalog Id. |
string |
viz |
Filter the Virtual Warehouses based on whether it has Data Visualisation. |
boolean |
vwType |
Virtual Warehouse type. |
VwSummary
A Virtual Warehouse.
| Name | Description | Schema |
|---|---|---|
autoscalingOptions |
The current settings stored for autoscaling. |
|
availabilityZone |
Availability zone in which the Virtual Warehouse is running. |
string |
cdhVersion |
CDH image version. |
string |
compactor |
Denotes whether the Hive Virtual Warehouse is a compactor or not. |
boolean |
configId |
ID of the configuration. |
string |
creationDate |
Creation date of Virtual Warehouse. |
string (date-time) |
creator |
The creator of the Virtual Warehouse. |
|
crn |
The CRN of the Virtual Warehouse. |
string |
dbcId |
ID of Database Catalog that the Virtual Warehouse is attached to. |
string |
ebsLLAPSpillGB |
Provides EBS gp3 volume as temporary storage space for Hive LLAP cache, and improves query performance. Configurable only at Virtual Warehouse creation. Using EBS volumes incurs additional costs. |
integer (int32) |
enableUnifiedAnalytics |
Denotes whether the Unified Analytics is enabled. |
boolean |
endpoints |
Endpoints for accessing the Virtual Warehouse. |
|
hiveAuthenticationMode |
DEPRECATED - Authentication mode used by Hive Server: * |
string |
hiveServerHaMode |
Hive Server High Availability mode in Private Cloud: * |
string |
id |
The ID of the Virtual Warehouse. |
string |
impalaHaSettingsOptions |
Current Impala High Availability settings. |
|
impalaOptions |
Current Impala settings. |
|
impalaQueryLog |
Denotes whether the Virtual Warehouse has the Impala Query Log enabled or not. |
boolean |
instanceType |
The underlying instance type for this Virtual Warehouse. |
string |
jwtAuth |
Details related to JWT Authentication settings on this Virtual Warehouse. |
|
memoryCapacity |
Memory size of the Virtual Warehouse in MB. |
integer (int32) |
name |
The name of the Virtual Warehouse. |
string |
nodeCount |
Size of the Virtual Warehouse (node count per compute cluster). |
integer (int32) |
numOfCores |
Number of cores of the Virtual Warehouse. |
integer (int32) |
queryIsolationOptions |
The current settings stored for query-isolation. |
|
replicaStatus |
Status information on the current state of replicas in the virtual warehouse. |
|
resourcePool |
The name of the Resource Pool the Virtual Warehouse is in. |
string |
resources |
The actual resources used by the Virtual Warehouse. |
< string, ApplicationResources > map |
status |
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 |
Timestamp of the last status change of the Virtual Warehouse. |
string (date-time) |
supportedAuthMethods |
Describes which authentication methods are supported on this Virtual Warehouse. |
|
tags |
Tags associated with the resources. |
< TagResponse > array |
viz |
Denotes whether the Virtual Warehouse has Data Visualisation or not. |
boolean |
vwType |
The type of the Virtual Warehouse. |
endpoints
| Name | Description | Schema |
|---|---|---|
das |
URL of Data Analytics Studio for Hive Virtual Warehouses. |
string |
fengImpalaShell |
Command to use impala-shell for Unified Analytics |
string |
fengKerberosImpalaShell |
Command to use impala-shell for Unified Analytics with Kerberos authentication in Private Cloud. |
string |
hiveJdbc |
JDBC URL for Hive Virtual Warehouses. |
string |
hiveKerberosJdbc |
JDBC URL with Kerberos authentication for Hive Virtual Warehouses in Private Cloud. |
string |
hostname |
Hostname for clients to use when connecting to the VW. |
string |
hue |
URL of Hue for both Hive and Impala Virtual Warehouses. |
string |
impalaFENGJdbc |
FENG JDBC URL for Impala Virtual Warehouses. |
string |
impalaFengKerberosJdbc |
Unified Analytics JDBC URL with Kerberos authentication for Impala Virtual Warehouses in Private Cloud. |
string |
impalaJdbc |
JDBC URL for Impala Virtual Warehouses. |
string |
impalaKerberosJdbc |
JDBC URL for Impala Virtual Warehouses with Kerberos authentication. |
string |
impalaShell |
Command to use impala-shell for Impala Virtual Warehouses. |
string |
jwtConnectionString |
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 |
When platform JWT authentication is enabled, contains a URL where a JWT token can be generated by the CDP JWT token provider. |
string |
kerberosImpalaShell |
Command to use impala-shell for Impala Virtual Warehouses with Kerberos authentication. |
string |
port |
Port for clients to use when connecting to the VW. |
integer (int32) |
trinoCli |
Command-line client that connects to Trino Virtual Warehouse to execute SQL queries. |
string |
jwtAuth
| Name | Description | Schema |
|---|---|---|
provider |
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 |
Indicates if JWT auth is supported on this Virtual Warehouse. |
boolean |
ldap |
Indicates if username/password access to this Virtual Warehouse is supported. |
boolean |
sso |
Indicates if SSO auth is supported on this Virtual Warehouse. |
boolean |
VwType
Type of Virtual Warehouse: 'hive' or 'impala'.
Type : enum (hive, impala)