Cloudera Data Warehouse API
The largest service in the CDP contract — activate DW clusters on an environment and manage database catalogs, virtual warehouses, backups and events. 95 operations. Marked EXPERIMENTAL by Cloudera.
Cloudera Data Warehouse API is one of 24 APIs that Cloudera publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Data Warehouse, SQL, and Analytics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 95 operations across 95 paths, and defines 286 schemas. It is described by OpenAPI 2.0, at version 0.9.163.
Requests are made against the base URL https://api.us-west-1.cdp.cloudera.com.
95 operations
95 paths
286 schemas
95 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 95
Across 95 paths, the API surfaces 95 operations — 95 POST. Each is listed below with its method, path, parameters, and response codes.
Operations 95
POST
/api/v1/dw/listClusters
List Cloudera Data Warehouse clusters.
POST
/api/v1/dw/describeCluster
Describe a Cloudera Data Warehouse cluster.
POST
/api/v1/dw/createClusterDiagnosticDataJob
Create a diagnostic job for the given cluster.
POST
/api/v1/dw/listClusterDiagnosticDataJobs
Get a list of diagnostic jobs for the given cluster.
POST
/api/v1/dw/describeClusterDiagnosticDataJob
Describes a diagnostic job for the given Cluster.
POST
/api/v1/dw/deleteClusterDiagnosticDataJob
Deletes a diagnostic job for the given cluster.
POST
/api/v1/dw/describeKubeconfig
Get Kubeconfig for a Cloudera Data Warehouse cluster.
POST
/api/v1/dw/describeAllowedInstanceTypes
Get allowed compute instance types for both AWS and Azure cluster types and their default values.
POST
/api/v1/dw/describeServerSetting
Get the DWX server settings.
POST
/api/v1/dw/updateServerSetting
Update the DWX server settings.
POST
/api/v1/dw/resetServerSettings
Restores the DWX server settings to the default values.
POST
/api/v1/dw/listEvents
Get the list of events.
POST
/api/v1/dw/updateSshKey
Update the SSH Key for a Cloudera Data Warehouse cluster
POST
/api/v1/dw/renewCertificates
Renew certificates for a Cloudera Data Warehouse public cloud cluster.
POST
/api/v1/dw/createCluster
Create a Cloudera Data Warehouse cluster.
POST
/api/v1/dw/createAwsCluster
Create an AWS cluster in the Cloudera Data Warehouse.
POST
/api/v1/dw/createAzureCluster
Create an Azure cluster in the Cloudera Data Warehouse.
POST
/api/v1/dw/createPrivateCluster
Create a a Private Cloud cluster in the Cloudera Data Warehouse.
POST
/api/v1/dw/deleteCluster
Delete a Cloudera Data Warehouse cluster.
POST
/api/v1/dw/updateCluster
Updates the Cloudera Data Warehouse cluster.
POST
/api/v1/dw/backupCluster
Creates a backup from the cluster configuration and settings.
POST
/api/v1/dw/restoreCluster
Restores the cluster from a backup data made by "backup-cluster" command.
POST
/api/v1/dw/createDataVisualization
Creates a Cloudera Data Visualization.
POST
/api/v1/dw/listDataVisualizations
Lists Cloudera Data Visualization in the provided CDW cluster.
POST
/api/v1/dw/deleteDataVisualization
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…
POST
/api/v1/dw/describeDataVisualization
Describes a Cloudera Data Visualization.
POST
/api/v1/dw/updateDataVisualization
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/getDataVisualizationUpgradeVersion
Gets latest version and latest compatible version for Cloudera Data Visualization.
POST
/api/v1/dw/upgradeDataVisualization
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/registerSecret
Registers a reference to a secret stored in the vault of the cloud provider.
POST
/api/v1/dw/createSecret
Creates a secret in the user's kubernetes cluster.
POST
/api/v1/dw/listSecrets
Lists all secrets.
POST
/api/v1/dw/deleteSecret
Deletes a secret.
POST
/api/v1/dw/createConnector
Creates a Connector
POST
/api/v1/dw/createConnectorTestJob
Test Trino Connector in a CDW cluster.
POST
/api/v1/dw/listConnectorTestJobs
List test connector jobs.
POST
/api/v1/dw/listConnectors
Lists Database Connectors.
POST
/api/v1/dw/deleteConnector
Deletes a Database connector.
POST
/api/v1/dw/updateConnector
Updates the Cloudera Data Warehouse connector.
POST
/api/v1/dw/createDbc
Create a Database Catalog.
POST
/api/v1/dw/listDbcs
List Database Catalogs.
POST
/api/v1/dw/describeDbc
Describe a Database Catalog.
POST
/api/v1/dw/deleteDbc
Delete a Database Catalog.
POST
/api/v1/dw/rebuildDbc
Rebuild a Database Catalog.
POST
/api/v1/dw/suspendDbc
Suspends a running Database Catalog.
POST
/api/v1/dw/startDbc
Start a Database Catalog.
POST
/api/v1/dw/describeDbcConfig
Describes the Database Catalog current configuration.
POST
/api/v1/dw/updateDbcConfig
Update a Database Catalog configuration.
POST
/api/v1/dw/createDbcDiagnosticDataJob
Create a diagnostic job for the given database catalog.
POST
/api/v1/dw/listDbcDiagnosticDataJobs
Get a list of diagnostic jobs for the given Database Catalog.
POST
/api/v1/dw/describeDbcDiagnosticDataJob
Describes a diagnostic job for the given Database Catalog.
POST
/api/v1/dw/deleteDbcDiagnosticDataJob
Deletes a diagnostic job for the given Database Catalog.
POST
/api/v1/dw/listDbcEvents
Get the list of events for the given Database Catalog.
POST
/api/v1/dw/createVw
Create a Virtual Warehouse.
POST
/api/v1/dw/listVws
List Virtual Warehouses.
POST
/api/v1/dw/describeVw
Describe a Virtual Warehouse.
POST
/api/v1/dw/updateVwConfig
Update a Virtual Warehouse configuration.
POST
/api/v1/dw/deleteVw
Delete a Virtual Warehouse.
POST
/api/v1/dw/rebuildVw
Rebuild a Virtual Warehouse.
POST
/api/v1/dw/startVw
Starts a suspended Virtual Warehouse.
POST
/api/v1/dw/suspendVw
Suspends a running Virtual Warehouse.
POST
/api/v1/dw/createVwDiagnosticDataJob
Create a diagnostic job for the given Virtual Warehouse.
POST
/api/v1/dw/listVwDiagnosticDataJobs
Get a list of diagnostic jobs for the given Virtual Warehouse.
POST
/api/v1/dw/describeVwDiagnosticDataJob
Describe a diagnostic jobs for the given Virtual Warehouse.
POST
/api/v1/dw/deleteVwDiagnosticDataJob
Delete a diagnostic job for the given Virtual Warehouse.
POST
/api/v1/dw/listVwEvents
Get the list of events for the given Virtual Warehouse.
POST
/api/v1/dw/listLatestVersions
Lists the latest version of the product (if available) for all catalogs in the environment.
POST
/api/v1/dw/describeVwConfig
Describes the current configuration of a Hive or Impala Virtual Warehouse.
POST
/api/v1/dw/describeConfig
Describe a service configuration.
POST
/api/v1/dw/describeConfigDiff
Get differences between two service configurations.
POST
/api/v1/dw/listDbcConfigs
Get the configuration history of a Database Catalog.
POST
/api/v1/dw/listVwConfigs
Get the configuration history of a Virtual Warehouse.
POST
/api/v1/dw/updateVw
Update the configuration of a Virtual Warehouse.
POST
/api/v1/dw/updateDbc
Update the configuration of a Database Catalog.
POST
/api/v1/dw/addUser
Adds the given user to the cluster.
POST
/api/v1/dw/deleteUser
Deletes the given user from the cluster.
POST
/api/v1/dw/listUsers
Lists the users who have access to the cluster.
POST
/api/v1/dw/upgradeDbc
Upgrades the Database Catalog to a compatible version.
POST
/api/v1/dw/upgradeVw
Upgrades the Virtual Warehouse to a compatible version.
POST
/api/v1/dw/getUpgradeVwVersions
Gets the latest version and latest compatible version for Virtual Warehouse.
POST
/api/v1/dw/getUpgradeDbcVersions
Gets the latest version and latest compatible version for Database Catalog.
POST
/api/v1/dw/healthCheck
Check the health of the API.
POST
/api/v1/dw/createBackup
Creates a backup for the data warehouse.
POST
/api/v1/dw/deleteBackup
Deletes a data warehouse backup.
POST
/api/v1/dw/describeBackup
Describes the backup.
POST
/api/v1/dw/restoreBackup
Restores backup.
POST
/api/v1/dw/describeRestore
Describes the restore.
POST
/api/v1/dw/listBackupEntities
Lists potential backup entities associated with the data warehouse.
POST
/api/v1/dw/listBackups
Lists backups.
POST
/api/v1/dw/listRestores
Lists restores.
POST
/api/v1/dw/getLogs
Gets job logs.
POST
/api/v1/dw/listResourceTemplates
Get default resource allocation templates.
POST
/api/v1/dw/createResourceTemplate
Create a resource allocation template.
POST
/api/v1/dw/updateResourceTemplate
Update a resource allocation template.
POST
/api/v1/dw/deleteResourceTemplate
Delete a resource allocation template.
Schemas 286
The contract defines 286 schemas that model the data the API accepts and returns. The most detailed are VwSummary (37 properties), CreateVwRequest (23 properties), AutoscalingOptionsCreateRequest (20 properties), CreateAzureClusterRequest (20 properties). Each schema is shown below with its type and property counts.
Error
object
An object returned on an error.
2 properties
DescribeClusterRequest
object
Request object for the describeCluster method. Use only one of environmentName, clusterCrn and clusterId.
1 property
1 required
DescribeClusterResponse
object
Response object for the describeCluster method.
1 property
DescribeKubeconfigRequest
object
Request object for the describeKubeconfig method.
1 property
1 required
DescribeKubeconfigResponse
object
Response object for the describeKubeconfig method.
1 property
DescribeAllowedInstanceTypesRequest
object
Request object for the describeAllowedInstanceTypes method.
DescribeAllowedInstanceTypesResponse
object
Response object for the describeAllowedInstanceTypes method.
2 properties
AllowedInstanceTypes
object
Allowed compute instance type values and default compute instance type value.
5 properties
AllowedInstanceTypesWithDefault
object
Allowed Virtual Warehouse compute instance types and their defaults.
2 properties
DescribeServerSettingRequest
object
Request object for the describeServerSetting method.
DescribeServerSettingResponse
object
Response object for the describeServerSetting method.
1 property
DescribeServerSettingItem
object
A DWX server setting.
5 properties
DescribeServerSettingItemRequiresUpdate
string
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…
UpdateServerSettingRequest
object
Request object for the updateServerSetting method.
1 property
UpdateServerSettingResponse
object
Response object for the updateServerSetting method.
1 property
ResetServerSettingsRequest
object
Request object for the resetServerSettings method.
ResetServerSettingsResponse
object
Response object for the resetServerSettings method.
1 property
UpdateServerSettingItem
object
A DWX server setting update.
2 properties
ListEventsRequest
object
Request object for the listEvents method.
5 properties
ListEventsResponse
object
Response object for the listEvents method.
1 property
Event
object
Represents a Event.
5 properties
UpdateSshKeyRequest
object
Request object for the updateSshKey method.
1 property
1 required
UpdateSshKeyResponse
object
Response object for the updateSshKey method.
2 properties
RenewCertificatesRequest
object
Request object for the renewCertificates method.
1 property
1 required
RenewCertificatesResponse
object
Response object for the renewCertificates method.
CreateClusterRequest
object
Request object for the createCluster method.
14 properties
1 required
CreateAwsClusterRequest
object
Request object for the createAwsCluster method.
17 properties
1 required
CreateAwsClusterNonTransparentProxyRequest
object
Activation options for an AWS environment to enable non-transparent proxy. Read more: https://docs.cloudera.com/data-warehouse/cloud/aws-environments/topics/dw…
2 properties
CreateAzureClusterRequest
object
Request object for the createAzureCluster method.
20 properties
3 required
KeyPairCredentials
object
Certificate and private key pair credentials, that could be used ie mutual TLS connections therefore these must belong together.
2 properties
2 required
CreatePrivateClusterRequest
object
Request object for the createPrivateCluster method.
5 properties
1 required
BackupClusterRequest
object
Request object for the backupCluster method.
1 property
1 required
BackupClusterResponse
object
Response object for the backupCluster method.
5 properties
RestoreClusterRequest
object
Request object for the restoreCluster method.
2 properties
2 required
RestoreClusterResponse
object
Response object for the restoreCluster method.
12 properties
RestoreClusterEntityPlan
object
Entity status after the restore operation.
4 properties
CustomRegistryOptions
object
Options for custom ACR, ECR registry.
2 properties
AwsActivationOptions
object
Options for activating an AWS environment.
8 properties
AwsActivationOptionsNonTransparentProxy
object
Activation options for an AWS environment to enable non-transparent proxy. Read more: https://docs.cloudera.com/data-warehouse/cloud/aws-environments/topics/dw…
2 properties
AzureActivationOptions
object
Options for activating an Azure environment.
12 properties
PrivateCloudActivationOptions
object
Options for activating a Private Cloud environment.
4 properties
CreateClusterResponse
object
Response object for the createCluster method.
1 property
CreateAwsClusterResponse
object
Response object for the createAwsCluster method.
1 property
CreateAzureClusterResponse
object
Response object for the createCluster method.
1 property
CreatePrivateClusterResponse
object
Response object for the createPrivateCluster method.
1 property
DeleteClusterRequest
object
Request object for the deleteCluster method.
2 properties
1 required
DeleteClusterResponse
object
Response object for the deleteCluster method.
UpdateClusterRequest
object
Request object for the updateCluster method.
8 properties
1 required
ExternalBucketAccessInfo
object
External bucket definition.
2 properties
UpdateClusterExternalBucketAccessInfo
object
Cluster external bucket definition to update.
2 properties
UpdateClusterObservabilityConfig
object
Cluster observability settings to update.
2 properties
UpdateClusterResponse
object
Response object for the updateCluster method.
ListClustersRequest
object
Request object for the listClusters method.
5 properties
ListClustersResponse
object
Response object for the listClusters method.
1 property
CreateDataVisualizationRequest
object
Request object for the createDataVisualization call.
6 properties
3 required
CreateDataVisualizationResponse
object
Response object for the createDataVisualization method.
1 property
ListDataVisualizationsRequest
object
Request object for the listDataVisualizations method.
1 property
1 required
ListDataVisualizationsResponse
object
Response object for the listDataVisualizations method.
1 property
DeleteDataVisualizationRequest
object
Request object for the deleteDataVisualization method.
2 properties
2 required
DeleteDataVisualizationResponse
object
Response object for the deleteDataVisualization method.
1 property
DescribeDataVisualizationRequest
object
Request object for the describeDataVisualization method.
2 properties
2 required
DescribeDataVisualizationResponse
object
Response object for the describeDataVisualization method.
1 property
UpdateDataVisualizationRequest
object
Request object for the updateDataVisualization method.
3 properties
2 required
UpdateDataVisualizationResponse
object
Response object for the updateDataVisualization method.
1 property
RegisterSecretRequest
object
Request object for creating secret.
4 properties
RegisterSecretResponse
object
Response object for registering secret.
1 property
CreateSecretRequest
object
Request object for creating secret.
3 properties
CreateSecretResponse
object
Response object for creating secret.
1 property
ListSecretsRequest
object
Request object for listing secrets.
1 property
1 required
ListSecretsResponse
object
Response object for listing secrets.
1 property
DeleteSecretRequest
object
Request object for deleting secret.
2 properties
2 required
DeleteSecretResponse
object
Response object for deleting secret.
1 property
Secret
object
Details of a single DWX secret.
4 properties
CreateDbcRequest
object
Request object for the createDbc method.
6 properties
2 required
CreateClusterDiagnosticDataJobRequest
object
Request object for the createClusterDiagnosticDataJob method.
7 properties
2 required
CreateClusterDiagnosticDataJobResponse
object
Response object for the createClusterDiagnosticDataJob method.
4 properties
ListClusterDiagnosticDataJobsRequest
object
Request object for the listClusterDiagnosticDataJobs method.
4 properties
1 required
ListClusterDiagnosticDataJobsResponse
object
Response object for the listClusterDiagnosticDataJobs method.
2 properties
ClusterDiagnosticDataJob
object
Represents a Diagnostic Data Job.
6 properties
DescribeClusterDiagnosticDataJobRequest
object
Request object for the describeClusterDiagnosticDataJob method.
2 properties
2 required
DescribeClusterDiagnosticDataJobResponse
object
Response object for the describeClusterDiagnosticDataJob method.
1 property
DeleteClusterDiagnosticDataJobRequest
object
Request object for the deleteClusterDiagnosticDataJob method.
2 properties
2 required
DeleteClusterDiagnosticDataJobResponse
object
Response object for the deleteClusterDiagnosticDataJob method.
CreateDbcDiagnosticDataJobRequest
object
Request object for the createDbcDiagnosticDataJob method.
8 properties
3 required
CreateDbcDiagnosticDataJobResponse
object
Response object for the createDbcDiagnosticDataJob method.
4 properties
ListDbcDiagnosticDataJobsRequest
object
Request object for the listDbcDiagnosticDataJobsRequest method.
5 properties
2 required
ListDbcDiagnosticDataJobsResponse
object
Response object for the listDbcDiagnosticDataJobsRequest method.
2 properties
DescribeDbcDiagnosticDataJobRequest
object
Request object for the describeDbcDiagnosticDataJobRequest method.
3 properties
3 required
DescribeDbcDiagnosticDataJobResponse
object
Response object for the describeDbcDiagnosticDataJobRequest method.
1 property
DeleteDbcDiagnosticDataJobRequest
object
Request object for the deleteDbcDiagnosticDataJobRequest method.
3 properties
3 required
DeleteDbcDiagnosticDataJobResponse
object
Response object for the deleteDbcDiagnosticDataJobRequest method.
DbcDiagnosticDataJob
object
Represents a Diagnostic Data Job
6 properties
DiagnosticDataJobStatus
string
Represents the possible status values of a Diagnostic Data Job.
ListDbcEventsRequest
object
Request object for the listDbcEvents method.
4 properties
2 required
ListDbcEventsResponse
object
Response object for the listDbcEvents method.
1 property
EventResponse
object
Represents a Event
3 properties
GetDataVisualizationUpgradeVersionRequest
object
Request object for the getDataVisualizationUpgradeVersion method.
2 properties
2 required
GetDataVisualizationUpgradeVersionResponse
object
Response object for the getDataVisualizationUpgradeVersion method.
1 property
UpgradeVersions
object
Details of upgrade versions.
1 property
UpgradeDataVisualizationRequest
object
Request object for the upgradeDataVisualization method.
4 properties
3 required
UpgradeDataVisualizationResponse
object
Response object for the upgradeDataVisualization method.
1 property
CreateDbcResponse
object
Response object for the createDbc method.
1 property
Connector
object
Represents the details of a connector used to integrate external systems or data sources with Cloudera Data Warehouse. A connector defines the configuration, a…
10 properties
ListConnectorsRequest
object
Request for listing connectors configured in Cloudera Data Warehouse.
1 property
1 required
ListConnectorsResponse
object
Response object for the listConnectors method. This object contains the list of all connectors configured in the specified Cloudera Data Warehouse cluster.
1 property
CreateConnectorRequest
object
Request object to create a new connector for integrating external systems or data sources with Cloudera Data Warehouse.
5 properties
2 required
CreateConnectorResponse
object
Response for the createConnector call.
1 property
CreateConnectorTestJobRequest
object
Request for the createConnectorTestJob call.
4 properties
1 required
CreateConnectorTestJobResponse
object
Response for the createConnectorTestJob call.
1 property
GetConnectorTestJob
object
Test connector job details.
6 properties
ListConnectorTestJobsRequest
object
Request for the listConnectorTestJobs call.
2 properties
1 required
ListConnectorTestJobsResponse
object
Response for the listConnectorTestJobs call.
1 property
DeleteConnectorRequest
object
Request object for the deleteConnectorById method.
2 properties
2 required
DeleteConnectorResponse
object
Response object for the deleteConnector method.
UpdateConnectorRequest
object
Request object for the updateConnector method.
6 properties
2 required
UpdateConnectorResponse
object
Response object for the updateConnector method.
ListDbcsRequest
object
Request object for the listDbcs method.
1 property
1 required
ListDbcsResponse
object
Response object for the listDbcs method.
1 property
DescribeDbcRequest
object
Request object for the describeDbc method.
2 properties
2 required
DescribeDbcResponse
object
Response object for the describeDbc method.
1 property
DeleteDbcRequest
object
Request object for the deleteDbc method.
2 properties
2 required
DeleteDbcResponse
object
Response object for the deleteDbc method.
RebuildDbcRequest
object
Request object for the rebuildDbc method.
2 properties
2 required
RebuildDbcResponse
object
Response object for the rebuildDbc method.
SuspendDbcRequest
object
The request object for the suspendDbc method.
2 properties
2 required
SuspendDbcResponse
object
The response object for the suspendDbc method.
StartDbcRequest
object
Request object for the restartDbc method.
3 properties
2 required
StartDbcResponse
object
Response object for the restartDbc method.
VwType
string
Type of Virtual Warehouse: 'hive', 'impala', 'trino'.
AutoscalingOptionsCreateRequest
object
Auto-scaling configuration for a Virtual Warehouse.
20 properties
ImpalaOptionsCreateRequest
object
Impala specific options. It cannot be provided for Virtual Warehouse types other than Impala.
2 properties
ImpalaOptionsResponse
object
Impala specific settings.
2 properties
ImpalaHASettingsCreateRequest
object
High Availability settings for the Impala Virtual Warehouse. The values are disregarded for Hive.
7 properties
AutoscalingOptionsUpdateRequest
object
Auto-scaling configuration for a Virtual Warehouse. Provide those values only that you want to update.
11 properties
ImpalaHASettingsUpdateRequest
object
High Availability settings update options for the Impala Virtual Warehouse.
3 properties
AutoscalingOptionsResponse
object
Auto-scaling configuration for a Virtual Warehouse.
14 properties
ImpalaHASettingsOptionsResponse
object
Impala High Availability settings for a Virtual Warehouse.
7 properties
ImpalaHighAvailabilityMode
string
Set Impala High Availability mode. If not provided, the default will apply. DISABLED - Disables Impala coordinator and Database Catalog high availability. ACTI…
QueryIsolationOptionsRequest
object
Configurations for Query Isolation.
2 properties
QueryIsolationOptionsResponse
object
Configurations for Query Isolation.
2 properties
Quota
object
Quota for the Virtual Warehouse.
2 properties
QuotaRequest
object
Quota in requests for the Virtual Warehouse.
2 properties
ReplicaStatus
object
Status information on the current state of replicas in the virtual warehouse.
4 properties
CreateVwRequest
object
Request object for the createVw method.
23 properties
4 required
TagRequest
object
A key/value pair that can be attached to some resources.
2 properties
2 required
CreateVwResponse
object
Response object for the createVw method.
1 property
VwFilter
object
Filter object for Virtual Warehouses.
4 properties
ListVwsRequest
object
Request object for the listVws method.
2 properties
1 required
ListVwsResponse
object
Response object for the listVws method.
1 property
DescribeVwRequest
object
Request object for the describeVw method.
2 properties
2 required
DescribeVwResponse
object
Response object for the describeVw method.
1 property
UpdateVwConfigRequest
object
Request object for the updateVwConfig method.
4 properties
3 required
UpdateVwConfigResponse
object
Response object for the updateVwConfig method.
RebuildVwRequest
object
Request object for the rebuildVw method.
2 properties
2 required
RebuildVwResponse
object
Response object for the rebuildVw method.
1 property
DeleteVwRequest
object
Request object for the deleteVw method.
2 properties
2 required
DeleteVwResponse
object
Response object for the deleteVw method.
1 property
ActorResponse
object
A CDP actor (user or machine user).
4 properties
AwsOptionsResponse
object
Response object of the cluster AWS settings.
8 properties
AwsOptionsNonTransparentProxyResponse
object
Non-transparent proxy settings. Read more: https://docs.cloudera.com/data-warehouse/cloud/aws-environments/topics/dw-aws-use-non-transparent-proxy.html
2 properties
AzureOptionsResponse
object
Response object of the cluster Azure settings.
11 properties
CreateVwDiagnosticDataJobRequest
object
Request object for the createVwDiagnosticDataJob method.
8 properties
3 required
CreateVwDiagnosticDataJobResponse
object
Response object for the createVwDiagnosticDataJob method.
4 properties
ListVwDiagnosticDataJobsRequest
object
Request object for the listVwDiagnosticDataJobsRequest method.
5 properties
2 required
ListVwDiagnosticDataJobsResponse
object
Response object for the listVwDiagnosticDataJobsRequest method.
2 properties
DescribeVwDiagnosticDataJobRequest
object
Request object for the describeVwDiagnosticDataJobRequest method.
3 properties
3 required
DescribeVwDiagnosticDataJobResponse
object
Response object for the describeVwDiagnosticDataJobRequest method.
1 property
DeleteVwDiagnosticDataJobRequest
object
Request object for the deleteVwDiagnosticDataJobRequest method.
3 properties
3 required
DeleteVwDiagnosticDataJobResponse
object
Response object for the deleteVwDiagnosticDataJobRequest method.
VwDiagnosticDataJob
object
Represents a Diagnostic Data Job.
6 properties
ListVwEventsRequest
object
Request object for the listVwEvents method.
4 properties
2 required
ListVwEventsResponse
object
Response object for the listVwEvents method.
1 property
ExternalBucket
object
External bucket details.
2 properties
ClusterSummaryResponse
object
A Cloudera Data Warehouse cluster.
20 properties
ClusterSummaryProductSupportResponse
object
Support lifecycle details of the given Cluster version (see version field). Learn more at Support lifecycle site: https://www.cloudera.com/services-and-support…
3 properties
DataVisualizationSummary
object
A Cloudera Data Visualization.
9 properties
DbcSummary
object
A Database Catalog.
10 properties
VwSummary
object
A Virtual Warehouse.
37 properties
ConnectorData
object
Information about a connector associated with a Virtual Warehouse.
2 properties
TagResponse
object
A key/value pair attached to some resources.
2 properties
2 required
DescribeDbcConfigRequest
object
Request object for the describeDbcConfig method.
2 properties
2 required
DescribeDbcConfigResponse
object
Response object for the describeDbcConfig method.
1 property
UpdateDbcConfigRequest
object
Request object for the updateDbcConfig method.
4 properties
3 required
ConfigBlock
object
Set values for a configuration file of a service.
3 properties
UpdateDbcConfigResponse
object
Response object for the updateDbcConfig method.
DescribeVwConfigRequest
object
Request object for the describeVwConfig method.
2 properties
2 required
DescribeVwConfigResponse
object
Response object for the describeVwConfig method.
1 property
DescribeConfigRequest
object
Request object for the describeConfig method.
2 properties
2 required
DescribeConfigResponse
object
Response object for the describeConfig method.
1 property
DescribeConfigDiffRequest
object
Request object for the describeConfigDiff method.
3 properties
3 required
DescribeConfigDiffResponse
object
Response object for the describeConfigDiff method.
1 property
ListDbcConfigsRequest
object
Request object for the listDbcConfigs method.
2 properties
2 required
ListDbcConfigsResponse
object
Response object for the listDbcConfigs method.
1 property
ListVwConfigsRequest
object
Request object for the listVwConfigs method.
2 properties
2 required
ListVwConfigsResponse
object
Response object for the listVwConfigs method.
1 property
UpdateVwRequest
object
Request object for the updateVw method.
15 properties
2 required
UpdateVwResponse
object
Response object for the updateVw method.
2 properties
UpdateDbcRequest
object
Request object for the updateDbc method.
4 properties
2 required
UpdateDbcResponse
object
Response object for the updateDbc method.
ConfigHistoryItem
object
An entry in the configuration history of a service.
3 properties
ConfigContentResp
object
Contents of a ConfigBlock.
3 properties
ConfigContentReq
object
Contents of a ConfigBlock.
3 properties
StringDiff
object
Difference between two strings.
2 properties
2 required
KeyValuesDiff
object
Different between keyValues of two ConfigContents.
4 properties
VizConfig
object
Configurations for a Cloudera Data Visualization
2 properties
ConfigContentDiff
object
Difference between two ConfigContents.
1 property
ConfigBlockResp
object
A piece of configuration stored in the same place (e.g. same file or environment variables).
2 properties
ConfigBlockReq
object
A piece of configuration stored in the same place (e.g. same file or environment variables).
2 properties
2 required
ConfigBlockDiff
object
Differences between two ConfigBlocks.
2 properties
ConfigBlocksDiffs
object
Differences between two sets of ConfigBlocks.
5 properties
1 required
ApplicationConfigResp
object
Configurations for an application inside a service.
1 property
ApplicationConfigReq
object
Configurations for an application inside a service.
1 property
ApplicationConfigDiff
object
Differences between two ApplicationConfigs.
2 properties
1 required
ServiceConfigResp
object
Configurations for a service (DBC or VW)
4 properties
ServiceConfigReq
object
Configurations for a service (DBC or VW)
4 properties
ServiceConfigDiff
object
Differences between two service configurations.
3 properties
StartVwRequest
object
The request object for the startVw method.
3 properties
2 required
StartVwResponse
object
The response object for the startVw method.
SuspendVwRequest
object
The request object for the suspendVw method.
2 properties
2 required
SuspendVwResponse
object
The response object for the suspendVw method.
2 properties
AddUserRequest
object
Request object for the addUser method.
2 properties
2 required
AddUserResponse
object
Response object for the addUser method.
DeleteUserRequest
object
Request object for the deleteUser method.
2 properties
2 required
DeleteUserResponse
object
Response object for the deleteUser method.
ListUsersRequest
object
Request object for the listUsers method.
1 property
1 required
ListUsersResponse
object
Response object for the listUsers method.
1 property
ImpalaExecutorGroupSetsCreateRequest
object
Configure executor group sets for workload aware autoscaling.
5 properties
ImpalaExecutorGroupSetsUpdateRequest
object
Re-configure executor group sets for workload aware autoscaling.
5 properties
ImpalaExecutorGroupSetsResponse
object
Describes executor group sets for workload aware autoscaling.
5 properties
ImpalaExecutorGroupSetCreateRequest
object
Configure independently scaling set of uniformly sized executor groups.
7 properties
ImpalaExecutorGroupSetUpdateRequest
object
Re-configure independently scaling set of uniformly sized executor groups.
8 properties
ImpalaExecutorGroupSetResponse
object
Describes configurations for an executor group set.
8 properties
CloudUserReference
object
Cloud user definition object.
1 property
1 required
ListLatestVersionsResponse
object
Response object of the listLatestVersions call.
1 property
ListLatestVersionsRequest
object
Request object of the listLatestVersions call.
1 property
1 required
UpgradeDbcRequest
object
Request object for the upgradeDbc method.
3 properties
3 required
UpgradeDbcResponse
object
Response object of the upgradeDbc call.
4 properties
UpgradeVwRequest
object
Request object for the upgradeVw method.
5 properties
4 required
UpgradeVwResponse
object
Response object for the upgradeVw method.
5 properties
GetUpgradeVwVersionsRequest
object
Request object for the getUpgradeVwVersions method.
2 properties
2 required
GetUpgradeVwVersionsResponse
object
Response object for the getUpgradeVwVersions method.
4 properties
GetUpgradeDbcVersionsRequest
object
Request object for the getUpgradeDbcVersions method.
2 properties
2 required
GetUpgradeDbcVersionsResponse
object
Response object for the getUpgradeDbcVersions method.
4 properties
HealthCheckRequest
object
Request object for the healthCheck method.
HealthCheckResponse
object
Response object for the healthCheck method.
1 property
CreateBackupRequest
object
Request object for the create backup request.
2 properties
CreateBackupResponse
object
Response object for the create backup request.
1 property
1 required
DeleteBackupRequest
object
Request object for the delete backup request.
1 property
1 required
DeleteBackupResponse
object
Response object for the delete backup request.
1 property
1 required
DescribeBackupRequest
object
Request object for the describe backup request.
1 property
1 required
DescribeBackupResponse
object
Response object for the describe backup request.
1 property
1 required
ListBackupsRequest
object
Request object for the list backups request.
3 properties
ListBackupsResponse
object
Response object for the list backups request.
1 property
1 required
Message
object
The message object used to display warnings and errors during DRS workflows
3 properties
SimpleBackup
object
A simple backup entry for listBackup usage
3 properties
Backup
object
Backup entry
10 properties
RestoreBackupRequest
object
Request object for the restore backup request.
3 properties
1 required
RestoreBackupResponse
object
Response object for the restore backup request.
3 properties
1 required
DescribeRestoreRequest
object
Request object for the describe restore request.
1 property
1 required
DescribeRestoreResponse
object
Response object for the describe restore request.
1 property
1 required
ListRestoresRequest
object
Request object for the list restores request.
2 properties
ListRestoresResponse
object
Response object for the list restores request.
1 property
1 required
SimpleRestore
object
A simple Restore entry for listRestore Usage
4 properties
Restore
object
Restore entry
12 properties
GetLogsRequest
object
Request object for the get logs request.
1 property
1 required
GetLogsResponse
object
Response object for the get logs request.
1 property
1 required
ListBackupEntitiesRequest
object
Request object for the list backup entities request.
ListBackupEntitiesResponse
object
Response object for the list backup entities request.
1 property
1 required
ListResourceTemplatesRequest
object
Request object for the listResourceTemplates method.
ListResourceTemplatesResponse
object
The response object for the listResourceTemplates method.
1 property
CreateResourceTemplateRequest
object
Request object for the createResourceTemplate method.
5 properties
CreateResourceTemplateResponse
object
The response object for the createResourceTemplate method.
1 property
CreateApplicationResources
object
The resource requirements of a component.
5 properties
CreateApplicationResourcesBreakdown
object
Breakdown of the service memory requirements like Xms, Xss etc.
4 properties
CreateApplicationResourcesLocalStorageSize
object
Storage related information.
3 properties
UpdateResourceTemplateRequest
object
Request object for the updateResourceTemplate method.
4 properties
UpdateResourceTemplateResponse
object
The response object for the updateResourceTemplate method.
1 property
UpdateApplicationResources
object
The resource requirements of a component.
5 properties
UpdateApplicationResourcesBreakdown
object
Breakdown of the service memory requirements.
4 properties
UpdateApplicationResourcesLocalStorageSize
object
Storage related information.
3 properties
DeleteResourceTemplateRequest
object
Request object for the deleteResourceTemplate method.
2 properties
DeleteResourceTemplateResponse
object
The response object for the deleteResourceTemplate method.
1 property
ApplicationResources
object
The resource requirements of a component.
5 properties
ApplicationResourcesBreakdown
object
Breakdown of the service memory requirements.
4 properties
ApplicationResourcesLocalStorageSize
object
Storage related information.
3 properties
ResourceTemplateResponse
object
Resource template.
6 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Cloudera 12
Other APIs Cloudera publishes across the network.
Cloudera Audit Service API
Cloudera Private Links API
Cloudera Compute Service API
Cloudera Consumption API
Cloudera Data Catalog API
Cloudera Data Hub API
Cloudera Datalake API
Cloudera Data Engineering API
Cloudera DataFlow API
Cloudera DataFlow Workload API
Cloudera Control Plane Data Recovery API
Cloudera Environments API
#Data Warehouse#SQL#Analytics
Where this information came from
This is an independent, third-party profile of Cloudera Data Warehouse API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.