Cloudera

Cloudera Dw API

The Dw API from Cloudera — 95 operation(s) for dw.

GitHub OpenAPI

Operations 95

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/v1/dw/listClusters List Data Warehouse clusters · List Cloudera Data Warehouse clusters #
Ask an LLM
“Which Cloudera Data Warehouse clusters are running in my environments?”
“Can I filter my CDW clusters by status or cloud platform?”
Tell an agent
List my Data Warehouse clusters.
Show CDW clusters in environment {environmentCrn} with status {status}.
POST /api/v1/dw/describeCluster Get details of one Data Warehouse cluster · Describe a Cloudera Data Warehouse cluster #
Ask an LLM
“What are the settings and state of a specific CDW cluster?”
“Is my Data Warehouse cluster up and which environment is it in?”
Tell an agent
Describe Data Warehouse cluster {clusterId}.
Show me the full details of CDW cluster {clusterId}.
POST /api/v1/dw/createClusterDiagnosticDataJob Collect cluster-level diagnostic logs and metrics · Create a diagnostic job for the given cluster #
Ask an LLM
“How do I gather logs and metrics from a whole CDW cluster for a support case?”
“Can a cluster diagnostic bundle be limited to a time window and tagged with a case number?”
Tell an agent
Start a cluster diagnostic job for {clusterId} sending the bundle to {destination}.
Collect cluster {clusterId} diagnostics from {startTime} to {endTime} for support case {caseNumber}, uploading to {destination}.
POST /api/v1/dw/listClusterDiagnosticDataJobs List diagnostic jobs for a cluster · Get a list of diagnostic jobs for the given cluster #
Ask an LLM
“What cluster-level diagnostic bundles have been collected for my CDW cluster?”
“Can I see only the cluster diagnostic jobs that are still running?”
Tell an agent
List the cluster-level diagnostic jobs for {clusterId}.
Show cluster {clusterId} diagnostic jobs with status {status}.
POST /api/v1/dw/describeClusterDiagnosticDataJob Get one cluster diagnostic job · Describes a diagnostic job for the given Cluster #
Ask an LLM
“Has the cluster diagnostic bundle I requested finished?”
“What metadata does a single cluster-level diagnostic job carry?”
Tell an agent
Describe cluster diagnostic job {jobId} on cluster {clusterId}.
Check the progress of cluster-wide diagnostics job {jobId} for {clusterId}.
POST /api/v1/dw/deleteClusterDiagnosticDataJob Delete a cluster diagnostic job · Deletes a diagnostic job for the given cluster #
Ask an LLM
“Can I delete a cluster-level diagnostic job even while it's still running?”
“How do I remove an old cluster diagnostic bundle job?”
Tell an agent destructive · confirm first
Delete cluster diagnostic job {jobId} on cluster {clusterId}.
Cancel and remove the cluster-wide diagnostics job {jobId} from {clusterId}.
POST /api/v1/dw/describeKubeconfig Get the kubeconfig for a cluster · Get Kubeconfig for a Cloudera Data Warehouse cluster #
Ask an LLM
“How can I get kubectl access to the Kubernetes behind my CDW cluster?”
“Where do I download the kubeconfig file for a Data Warehouse cluster?”
Tell an agent
Get the kubeconfig for cluster {clusterId}.
Give me a kubeconfig so I can run kubectl against {clusterId}.
POST /api/v1/dw/describeAllowedInstanceTypes List allowed compute instance types · Get allowed compute instance types for both AWS and Azure cluster types and… #
Ask an LLM
“Which compute instance types can a CDW cluster use on AWS and Azure?”
“What's the default instance type for Data Warehouse compute?”
Tell an agent
List the allowed instance types for Data Warehouse clusters.
Show the default and permitted compute node sizes for AWS and Azure.
POST /api/v1/dw/describeServerSetting Show the DWX server settings · Get the DWX server settings #
Ask an LLM
“What server settings are currently enabled in my DWX Private Cloud?”
“Which Data Warehouse server feature toggles are on right now?”
Tell an agent
Show the current DWX server settings.
List which DWX server toggles are switched on.
POST /api/v1/dw/updateServerSetting Turn DWX server settings on or off · Update the DWX server settings #
Ask an LLM
“How do I enable or disable a DWX server setting?”
“Do some server setting changes require recreating a Virtual Warehouse?”
Tell an agent
Update the DWX server settings to {settings}.
Switch these DWX server toggles: {settings}.
POST /api/v1/dw/resetServerSettings Reset DWX server settings to defaults · Restores the DWX server settings to the default values #
Ask an LLM
“Can I put all DWX server settings back to their default values?”
“What happens to my custom server toggles if I reset them?”
Tell an agent destructive · confirm first
Reset the DWX server settings to their defaults.
Undo all my DWX server setting changes and restore the factory values.
POST /api/v1/dw/listEvents List events for an operation or service · Get the list of events #
Ask an LLM
“What events happened during a particular Data Warehouse operation?”
“Can I see the event history for a Data Visualization app or cluster by its service ID?”
Tell an agent
List events for operation {operationId}.
Show the last {limit} events for service {serviceId}, oldest first set to {ascending}.
POST /api/v1/dw/updateSshKey Update a cluster's SSH key · Update the SSH Key for a Cloudera Data Warehouse cluster #
Ask an LLM
“How do I rotate the SSH key on a CDW cluster?”
“Can I change the SSH key for a Data Warehouse cluster after it's created?”
Tell an agent
Update the SSH key for cluster {clusterId}.
Rotate the SSH key on Data Warehouse cluster {clusterId}.
POST /api/v1/dw/renewCertificates Renew certificates on a public cloud cluster · Renew certificates for a Cloudera Data Warehouse public cloud cluster #
Ask an LLM
“My CDW public cloud cluster certificates are expiring; how do I renew them?”
“Can I refresh TLS certificates on a Data Warehouse cluster?”
Tell an agent
Renew the certificates on cluster {clusterId}.
Refresh expiring certs for public cloud CDW cluster {clusterId}.
POST /api/v1/dw/createCluster Activate a Data Warehouse cluster (generic) · Create a Cloudera Data Warehouse cluster #
Ask an LLM
“How do I activate Cloudera Data Warehouse on an environment with one generic call?”
“Can I restrict cluster access to certain IP ranges when activating Data Warehouse?”
Tell an agent
Create a Data Warehouse cluster in environment {environmentCrn}.
Activate CDW on {environmentCrn} with a private load balancer set to {usePrivateLoadBalancer} and allowed CIDRs {whitelistIpCIDRs}.
POST /api/v1/dw/createAwsCluster Create an AWS Data Warehouse cluster · Create an AWS cluster in the Cloudera Data Warehouse #
Ask an LLM
“What does it take to stand up a CDW cluster on AWS with private EKS?”
“Can my AWS Data Warehouse cluster use spot instances or a custom AMI?”
Tell an agent
Create an AWS Data Warehouse cluster in environment {environmentCrn}.
Spin up an AWS CDW cluster in {environmentCrn} on worker subnets {workerSubnetIds} with spot instances {enableSpotInstances}.
POST /api/v1/dw/createAzureCluster Create an Azure Data Warehouse cluster · Create an Azure cluster in the Cloudera Data Warehouse #
Ask an LLM
“What do I need to create a CDW cluster on Azure, like a managed identity and subnet?”
“Can an Azure Data Warehouse cluster run on a private AKS cluster?”
Tell an agent
Create an Azure Data Warehouse cluster in {environmentCrn} using identity {userAssignedManagedIdentity} on subnet {subnetName}.
Spin up an AKS-backed CDW cluster in {environmentCrn} on subnet {subnetName} with identity {userAssignedManagedIdentity} and private AKS {enablePrivateAks}.
POST /api/v1/dw/createPrivateCluster Create a Private Cloud Data Warehouse cluster · Create a a Private Cloud cluster in the Cloudera Data Warehouse #
Ask an LLM
“How do I activate Data Warehouse on a Private Cloud environment?”
“Can I pick a storage class or dedicated executor nodes for a Private Cloud CDW cluster?”
Tell an agent
Create a Private Cloud Data Warehouse cluster in {environmentCrn}.
Activate on-prem CDW in {environmentCrn} using storage class {storageClass}.
POST /api/v1/dw/deleteCluster Delete a Data Warehouse cluster · Delete a Cloudera Data Warehouse cluster #
Ask an LLM
“How do I tear down a whole Cloudera Data Warehouse cluster?”
“Can I force-delete a CDW cluster that's stuck?”
Tell an agent destructive · confirm first
Delete Data Warehouse cluster {clusterId}.
Force the deletion of CDW cluster {clusterId} with force {force}.
POST /api/v1/dw/updateCluster Update a Data Warehouse cluster's settings · Updates the Cloudera Data Warehouse cluster #
Ask an LLM
“Can I change the allowed IP ranges on an existing CDW cluster?”
“Where do I update a cluster's description or observability config?”
Tell an agent
Update cluster {clusterId} to allow CIDRs {whitelistIpCIDRs}.
Change the description of Data Warehouse cluster {clusterId} to {description}.
POST /api/v1/dw/backupCluster Export a cluster's configuration as backup data · Creates a backup from the cluster configuration and settings #
Ask an LLM
“How do I export a cluster's configuration, including its Virtual Warehouses and Data Viz apps?”
“Can I capture CDW cluster settings so I can restore them later?”
Tell an agent
Back up the configuration of cluster {clusterId}.
Export the settings of {clusterId} and its catalogs and warehouses as backup data.
POST /api/v1/dw/restoreCluster Restore a cluster from exported configuration · Restores the cluster from a backup data made by "backup-cluster" command #
Ask an LLM
“How do I recreate my Virtual Warehouses and Data Viz apps from a cluster configuration export?”
“What does restoring a cluster from backup-cluster data bring back?”
Tell an agent
Restore cluster {clusterId} from backup data {data}.
Rebuild the warehouses and catalog config on {clusterId} using the exported settings {data}.
POST /api/v1/dw/createDataVisualization Create a Data Visualization app · Creates a Cloudera Data Visualization #
Ask an LLM
“How do I add a Cloudera Data Visualization app to my warehouse cluster?”
“Can I choose an image version or resource template for a new Data Viz app?”
Tell an agent
Create a Data Visualization app named {name} on cluster {clusterId} with config {config}.
Deploy Data Viz {name} on {clusterId} using config {config} and image {imageVersion}.
POST /api/v1/dw/listDataVisualizations List Data Visualization apps in a cluster · Lists Cloudera Data Visualization in the provided CDW cluster #
Ask an LLM
“Which Data Visualization apps are running on my CDW cluster?”
“What dashboards apps exist in a given warehouse cluster?”
Tell an agent
List the Data Visualization apps on cluster {clusterId}.
Show all Data Viz instances in {clusterId}.
POST /api/v1/dw/deleteDataVisualization Delete a Data Visualization app · Asynchronous operation that deletes a Cloudera Data Visualization. #
Ask an LLM
“How do I remove a Data Visualization app from a cluster?”
“Can I still check a Data Viz app's status while it's being deleted?”
Tell an agent destructive · confirm first
Delete Data Visualization {dataVisualizationId} on cluster {clusterId}.
Tear down the Data Viz app {dataVisualizationId} in {clusterId}.
POST /api/v1/dw/describeDataVisualization Get details and status of a Data Visualization app · Describes a Cloudera Data Visualization #
Ask an LLM
“What state is my Data Visualization app in after an update or upgrade?”
“Which config and version is a specific Data Viz app running?”
Tell an agent
Describe Data Visualization {dataVisualizationId} on cluster {clusterId}.
Check the current status of Data Viz app {dataVisualizationId} in {clusterId}.
POST /api/v1/dw/updateDataVisualization Change a Data Visualization app's configuration · Asynchronous operation that updates the configuration of a Cloudera Data… #
Ask an LLM
“Can I reconfigure a running Data Visualization app?”
“Is changing a Data Viz app's settings asynchronous?”
Tell an agent
Update Data Visualization {dataVisualizationId} on {clusterId} with config {config}.
Apply new settings {config} to Data Viz app {dataVisualizationId} in cluster {clusterId}.
POST /api/v1/dw/getDataVisualizationUpgradeVersion Check upgrade versions for a Data Visualization app · Gets latest version and latest compatible version for Cloudera Data… #
Ask an LLM
“Is there a newer compatible version for my Data Visualization app?”
“What's the latest Data Viz version I could upgrade to?”
Tell an agent
Get the upgrade versions for Data Visualization {dataVisualizationId} on {clusterId}.
Tell me the latest compatible Data Viz release for app {dataVisualizationId} in {clusterId}.
POST /api/v1/dw/upgradeDataVisualization Upgrade a Data Visualization app · Asynchronous operation that upgrades a Cloudera Data Visualization to a… #
Ask an LLM
“How do I move a Data Visualization app to a newer image version?”
“Can I change the resource pool while upgrading a Data Viz app?”
Tell an agent
Upgrade Data Visualization {dataVisualizationId} on {clusterId} to version {imageVersion}.
Move Data Viz app {dataVisualizationId} in {clusterId} to image {imageVersion} in resource pool {resourcePool}.
POST /api/v1/dw/registerSecret Register a cloud vault secret reference · Registers a reference to a secret stored in the vault of the cloud provider #
Ask an LLM
“How do I point CDW at a secret already stored in my cloud provider's vault?”
“Can I reference an Azure Key Vault secret for an external data source connection?”
Tell an agent
Register vault secret {secretName} for cluster {clusterId}.
Reference secret {secretName} from Azure vault {azureVaultName} on cluster {clusterId}.
POST /api/v1/dw/createSecret Create a secret in the cluster's Kubernetes · Creates a secret in the user's kubernetes cluster #
Ask an LLM
“How do I store a password for an external data source directly in my CDW Kubernetes cluster?”
“Can I create a new Kubernetes secret value through the Data Warehouse API?”
Tell an agent
Create a Kubernetes secret {secretName} on cluster {clusterId} with value {secretValue}.
Store the credential {secretValue} as k8s secret {secretName} in {clusterId}.
POST /api/v1/dw/listSecrets List secrets for a cluster · Lists all secrets #
Ask an LLM
“Which secrets are registered for external data sources on my cluster?”
“What cloud provider secrets has CDW recorded in this environment?”
Tell an agent
List the secrets on cluster {clusterId}.
Show every stored secret name for {clusterId}.
POST /api/v1/dw/deleteSecret Delete a stored secret · Deletes a secret #
Ask an LLM
“How do I remove a secret I no longer need for a data source?”
“Can I delete a secret by name from a CDW cluster?”
Tell an agent destructive · confirm first
Delete secret {secretName} from cluster {clusterId}.
Remove the {secretName} secret on {clusterId}.
POST /api/v1/dw/createConnector Create a database connector · Creates a Connector #
Ask an LLM
“How do I add a Trino connector to an external database in my CDW cluster?”
“What template and config does a new database connector need?”
Tell an agent
Create connector {name} from template {template} on cluster {clusterId}.
Add a new database connector {name} using template {template} with config {config}.
POST /api/v1/dw/createConnectorTestJob Test a Trino connector · Test Trino Connector in a CDW cluster #
Ask an LLM
“Can I check that a Trino connector actually reaches its data source before using it?”
“How do I run a connection test for a connector config I haven't saved yet?”
Tell an agent
Test connector {connectorId} on cluster {clusterId}.
Run a connection test on {clusterId} for connector {connectorName} with config {config}.
POST /api/v1/dw/listConnectorTestJobs List connector test jobs · List test connector jobs #
Ask an LLM
“Did my Trino connector tests pass?”
“Where can I see the results of past connector test runs?”
Tell an agent
List connector test jobs on cluster {clusterId}.
Show the result of connector test {jobId} in {clusterId}.
POST /api/v1/dw/listConnectors List database connectors in a cluster · Lists Database Connectors #
Ask an LLM
“Which database connectors are configured on my CDW cluster?”
“What external sources can my warehouse query through connectors?”
Tell an agent
List the database connectors on cluster {clusterId}.
Show all connectors defined in {clusterId}.
POST /api/v1/dw/deleteConnector Delete a database connector · Deletes a Database connector #
Ask an LLM
“How do I remove a database connector from a cluster?”
“Can I delete a connector my warehouses no longer use?”
Tell an agent destructive · confirm first
Delete connector {connectorId} from cluster {clusterId}.
Remove database connector {connectorId} in {clusterId}.
POST /api/v1/dw/updateConnector Edit an existing database connector · Updates the Cloudera Data Warehouse connector #
Ask an LLM
“Can I rename or change the config of a connector I already created?”
“How do I switch an existing connector to a different template?”
Tell an agent
Update connector {connectorId} on {clusterId} with config {config}.
Rename existing connector {connectorId} in {clusterId} to {name}.
POST /api/v1/dw/createDbc Create a Database Catalog (deprecated) · Create a Database Catalog #
Ask an LLM
“Can I still create an extra Database Catalog even though it's deprecated?”
“Is it possible to load demo data when making a new Database Catalog?”
Tell an agent
Create Database Catalog {name} on cluster {clusterId}.
Make a new catalog {name} in {clusterId} with demo data {loadDemoData}.
POST /api/v1/dw/listDbcs List Database Catalogs in a cluster · List Database Catalogs #
Ask an LLM
“Which Database Catalogs exist on my CDW cluster?”
“What's the ID of the default Database Catalog in a cluster?”
Tell an agent
List the Database Catalogs on cluster {clusterId}.
Show every DBC in {clusterId}.
POST /api/v1/dw/describeDbc Get details of a Database Catalog · Describe a Database Catalog #
Ask an LLM
“Is my Database Catalog running or suspended?”
“What version and status does a specific DBC report?”
Tell an agent
Describe Database Catalog {dbcId} on cluster {clusterId}.
Show the status of DBC {dbcId} in {clusterId}.
POST /api/v1/dw/deleteDbc Delete a Database Catalog · Delete a Database Catalog #
Ask an LLM
“How do I permanently remove a Database Catalog?”
“Can I delete a DBC I created by mistake?”
Tell an agent destructive · confirm first
Delete Database Catalog {dbcId} from cluster {clusterId}.
Remove DBC {dbcId} in {clusterId}.
POST /api/v1/dw/rebuildDbc Rebuild a broken Database Catalog · Rebuild a Database Catalog #
Ask an LLM
“My Database Catalog is in an erroneous state; can I rebuild it?”
“Is it safe to rebuild a running DBC?”
Tell an agent
Rebuild Database Catalog {dbcId} on cluster {clusterId}.
Fix inconsistent DBC {dbcId} in {clusterId} by rebuilding it.
POST /api/v1/dw/suspendDbc Suspend a running Database Catalog · Suspends a running Database Catalog #
Ask an LLM
“How do I pause a Database Catalog to save resources?”
“What happens if I suspend a DBC that's already suspended?”
Tell an agent
Suspend Database Catalog {dbcId} on cluster {clusterId}.
Pause DBC {dbcId} in {clusterId}.
POST /api/v1/dw/startDbc Start a Database Catalog · Start a Database Catalog #
Ask an LLM
“How do I bring a suspended Database Catalog back up?”
“Can I force a refresh when starting a DBC?”
Tell an agent
Start Database Catalog {dbcId} on cluster {clusterId}.
Resume DBC {dbcId} in {clusterId} with force refresh {forceRefresh}.
POST /api/v1/dw/describeDbcConfig Show a Database Catalog's current configuration · Describes the Database Catalog current configuration #
Ask an LLM
“What configuration is my Database Catalog using right now?”
“Which config values are set on a DBC's components?”
Tell an agent
Show the current configuration of Database Catalog {dbcId} on {clusterId}.
Dump the live config settings of DBC {dbcId} in cluster {clusterId}.
POST /api/v1/dw/updateDbcConfig Change a Database Catalog component's config · Update a Database Catalog configuration #
Ask an LLM
“How do I change a configuration file for one component of a Database Catalog?”
“Can I set specific config values on a DBC component like the metastore?”
Tell an agent
Update the {component} config of Database Catalog {dbcId} on {clusterId} to {set}.
Set component {component} values on DBC {dbcId} in cluster {clusterId}.
POST /api/v1/dw/createDbcDiagnosticDataJob Collect diagnostics for a Database Catalog · Create a diagnostic job for the given database catalog #
Ask an LLM
“How do I gather logs and metrics from a Database Catalog for troubleshooting?”
“Can I attach a support case number to a DBC diagnostic bundle?”
Tell an agent
Start a diagnostic job for Database Catalog {dbcId} on {clusterId} sending to {destination}.
Collect DBC {dbcId} logs in {clusterId} for case {caseNumber}, uploaded to {destination}.
POST /api/v1/dw/listDbcDiagnosticDataJobs List diagnostic jobs for a Database Catalog · Get a list of diagnostic jobs for the given Database Catalog #
Ask an LLM
“What diagnostic bundles have been collected for my Database Catalog?”
“Can I filter DBC diagnostic jobs by status?”
Tell an agent
List diagnostic jobs for Database Catalog {dbcId} on {clusterId}.
Show DBC {dbcId} diagnostics jobs in {clusterId} with status {status}.
POST /api/v1/dw/describeDbcDiagnosticDataJob Get one Database Catalog diagnostic job · Describes a diagnostic job for the given Database Catalog #
Ask an LLM
“Has the diagnostic bundle for my Database Catalog finished collecting?”
“What status is a specific DBC diagnostic job in?”
Tell an agent
Describe diagnostic job {jobId} for Database Catalog {dbcId} on {clusterId}.
Check DBC {dbcId} diagnostics job {jobId} in cluster {clusterId}.
POST /api/v1/dw/deleteDbcDiagnosticDataJob Delete a Database Catalog diagnostic job · Deletes a diagnostic job for the given Database Catalog #
Ask an LLM
“Can I delete a Database Catalog diagnostic job that's still running?”
“How do I clean up old DBC diagnostic jobs?”
Tell an agent destructive · confirm first
Delete diagnostic job {jobId} for Database Catalog {dbcId} on {clusterId}.
Remove DBC {dbcId} diagnostics job {jobId} from {clusterId}.
POST /api/v1/dw/listDbcEvents List events for a Database Catalog · Get the list of events for the given Database Catalog #
Ask an LLM
“What has happened to my Database Catalog recently?”
“Can I see a DBC's event history newest or oldest first?”
Tell an agent
List events for Database Catalog {dbcId} on {clusterId}.
Show the last {limit} events of DBC {dbcId} in {clusterId}.
POST /api/v1/dw/createVw Create a Virtual Warehouse · Create a Virtual Warehouse #
Ask an LLM
“How do I create a new Hive or Impala Virtual Warehouse?”
“Can I set a t-shirt size, node count and autoscaling when making a Virtual Warehouse?”
Tell an agent
Create a {vwType} Virtual Warehouse named {name} on catalog {dbcId} in cluster {clusterId}.
Spin up {vwType} warehouse {name} in {clusterId} on DBC {dbcId} at size {tShirtSize}.
POST /api/v1/dw/listVws List Virtual Warehouses in a cluster · List Virtual Warehouses #
Ask an LLM
“Which Virtual Warehouses exist on my CDW cluster?”
“Can I filter the list of Virtual Warehouses?”
Tell an agent
List the Virtual Warehouses on cluster {clusterId}.
Show warehouses in {clusterId} matching filter {filter}.
POST /api/v1/dw/describeVw Get details of a Virtual Warehouse · Describe a Virtual Warehouse #
Ask an LLM
“Is my Virtual Warehouse running, and what size is it?”
“What are the endpoints and status of a specific Virtual Warehouse?”
Tell an agent
Describe Virtual Warehouse {vwId} on cluster {clusterId}.
Show me the status of warehouse {vwId} in {clusterId}.
POST /api/v1/dw/updateVwConfig Change a Virtual Warehouse component's config · Update a Virtual Warehouse configuration #
Ask an LLM
“How do I edit a configuration file for one component of a Virtual Warehouse?”
“Can I set specific values in a Hive or Impala component config?”
Tell an agent
Update the {component} config of Virtual Warehouse {vwId} on {clusterId} to {set}.
Set component {component} values on warehouse {vwId} in cluster {clusterId}.
POST /api/v1/dw/deleteVw Delete a Virtual Warehouse · Delete a Virtual Warehouse #
Ask an LLM
“How do I permanently remove a Virtual Warehouse?”
“Can I delete a Hive or Impala warehouse I no longer need?”
Tell an agent destructive · confirm first
Delete Virtual Warehouse {vwId} from cluster {clusterId}.
Remove warehouse {vwId} in {clusterId}.
POST /api/v1/dw/rebuildVw Rebuild a broken Virtual Warehouse · Rebuild a Virtual Warehouse #
Ask an LLM
“My Virtual Warehouse is stuck in an error state; can I rebuild it?”
“Is rebuilding a stopped Virtual Warehouse safe?”
Tell an agent
Rebuild Virtual Warehouse {vwId} on cluster {clusterId}.
Fix inconsistent warehouse {vwId} in {clusterId} by rebuilding it.
POST /api/v1/dw/startVw Start a suspended Virtual Warehouse · Starts a suspended Virtual Warehouse #
Ask an LLM
“How do I wake up a suspended Virtual Warehouse?”
“What happens if I start a warehouse that's already running?”
Tell an agent
Start Virtual Warehouse {vwId} on cluster {clusterId}.
Resume warehouse {vwId} in {clusterId} with force refresh {forceRefresh}.
POST /api/v1/dw/suspendVw Suspend a running Virtual Warehouse · Suspends a running Virtual Warehouse #
Ask an LLM
“Can I pause a Virtual Warehouse to stop paying for its compute?”
“Does suspending an already suspended warehouse do anything?”
Tell an agent
Suspend Virtual Warehouse {vwId} on cluster {clusterId}.
Pause warehouse {vwId} in {clusterId}.
POST /api/v1/dw/createVwDiagnosticDataJob Collect diagnostics for a Virtual Warehouse · Create a diagnostic job for the given Virtual Warehouse #
Ask an LLM
“How do I collect Hive or Impala logs from a Virtual Warehouse for a support ticket?”
“Can I limit a Virtual Warehouse diagnostic bundle to a time range?”
Tell an agent
Start a diagnostic job for Virtual Warehouse {vwId} on {clusterId} sending to {destination}.
Collect warehouse {vwId} logs in {clusterId} from {startTime} to {endTime}, uploaded to {destination}.
POST /api/v1/dw/listVwDiagnosticDataJobs List diagnostic jobs for a Virtual Warehouse · Get a list of diagnostic jobs for the given Virtual Warehouse #
Ask an LLM
“What diagnostic bundles exist for my Virtual Warehouse?”
“Can I page through a warehouse's diagnostic jobs?”
Tell an agent
List diagnostic jobs for Virtual Warehouse {vwId} on {clusterId}.
Show warehouse {vwId} diagnostics jobs in {clusterId} with status {status}.
POST /api/v1/dw/describeVwDiagnosticDataJob Get one Virtual Warehouse diagnostic job · Describe a diagnostic jobs for the given Virtual Warehouse #
Ask an LLM
“Is the diagnostic bundle for my Virtual Warehouse ready?”
“What's the status of one warehouse diagnostic job?”
Tell an agent
Describe diagnostic job {jobId} for Virtual Warehouse {vwId} on {clusterId}.
Check warehouse {vwId} diagnostics job {jobId} in cluster {clusterId}.
POST /api/v1/dw/deleteVwDiagnosticDataJob Delete a Virtual Warehouse diagnostic job · Delete a diagnostic job for the given Virtual Warehouse #
Ask an LLM
“Can I delete a Virtual Warehouse diagnostic job while it's running?”
“How do I remove an old warehouse diagnostic bundle job?”
Tell an agent destructive · confirm first
Delete diagnostic job {jobId} for Virtual Warehouse {vwId} on {clusterId}.
Remove warehouse {vwId} diagnostics job {jobId} from {clusterId}.
POST /api/v1/dw/listVwEvents List events for a Virtual Warehouse · Get the list of events for the given Virtual Warehouse #
Ask an LLM
“What's happened to my Virtual Warehouse lately, like scaling or restarts?”
“Can I read a warehouse's events in ascending order?”
Tell an agent
List events for Virtual Warehouse {vwId} on {clusterId}.
Show the last {limit} events of warehouse {vwId} in {clusterId}.
POST /api/v1/dw/listLatestVersions List the latest product versions for catalogs · Lists the latest version of the product (if available) for all catalogs in the… #
Ask an LLM
“Is a newer Data Warehouse release available for the catalogs in my environment?”
“What's the newest version across all my Database Catalogs?”
Tell an agent
List the latest available versions for catalogs on cluster {clusterId}.
Show the newest product release for every catalog in {clusterId}.
POST /api/v1/dw/describeVwConfig Show a Virtual Warehouse's current configuration · Describes the current configuration of a Hive or Impala Virtual Warehouse #
Ask an LLM
“What configuration is my Hive or Impala Virtual Warehouse running with?”
“Which config values are set on a warehouse's components right now?”
Tell an agent
Show the current configuration of Virtual Warehouse {vwId} on {clusterId}.
Dump the live config settings of warehouse {vwId} in cluster {clusterId}.
POST /api/v1/dw/describeConfig Get one saved service configuration by ID · Describe a service configuration #
Ask an LLM
“Can I look at a specific historical configuration version by its config ID?”
“What did a service configuration contain at a particular revision?”
Tell an agent
Describe service configuration {configId} on cluster {clusterId}.
Show me config revision {configId} in {clusterId}.
POST /api/v1/dw/describeConfigDiff Compare two service configurations · Get differences between two service configurations #
Ask an LLM
“What changed between two versions of a warehouse or catalog configuration?”
“Can I diff an old service config against the current one?”
Tell an agent
Diff configuration {fromConfigId} against {toConfigId} on cluster {clusterId}.
Show what changed from config {fromConfigId} to {toConfigId} in {clusterId}.
POST /api/v1/dw/listDbcConfigs Get a Database Catalog's configuration history · Get the configuration history of a Database Catalog #
Ask an LLM
“How has my Database Catalog's configuration changed over time?”
“Where can I find past config versions of a DBC?”
Tell an agent
List the configuration history of Database Catalog {dbcId} on {clusterId}.
Show previous config revisions for DBC {dbcId} in cluster {clusterId}.
POST /api/v1/dw/listVwConfigs Get a Virtual Warehouse's configuration history · Get the configuration history of a Virtual Warehouse #
Ask an LLM
“How has my Virtual Warehouse configuration changed over time?”
“Where can I find past config versions of a warehouse?”
Tell an agent
List the configuration history of Virtual Warehouse {vwId} on {clusterId}.
Show previous config revisions for warehouse {vwId} in cluster {clusterId}.
POST /api/v1/dw/updateVw Resize or reconfigure a Virtual Warehouse · Update the configuration of a Virtual Warehouse #
Ask an LLM
“Can I change a Virtual Warehouse's size or node count after it's created?”
“How do I adjust autoscaling or attach connectors to an existing warehouse?”
Tell an agent
Resize Virtual Warehouse {vwId} on {clusterId} to t-shirt size {tShirtSize}.
Set autoscaling on warehouse {vwId} in {clusterId} to {autoscaling}.
POST /api/v1/dw/updateDbc Change a Database Catalog's resources or config · Update the configuration of a Database Catalog #
Ask an LLM
“Can I move a Database Catalog to a different resource template?”
“Where do I update the overall settings of an existing DBC?”
Tell an agent
Switch Database Catalog {dbcId} on {clusterId} to resource template {resourceTemplateId}.
Apply catalog settings {config} to DBC {dbcId} in cluster {clusterId}.
POST /api/v1/dw/addUser Give an existing user access to a cluster · Adds the given user to the cluster #
Ask an LLM
“How do I grant someone access to my Data Warehouse cluster?”
“Does a user have to exist before I add them to a cluster?”
Tell an agent
Add user {userId} to cluster {clusterId}.
Grant {userId} access to Data Warehouse cluster {clusterId}.
POST /api/v1/dw/deleteUser Remove a user's access to a cluster · Deletes the given user from the cluster #
Ask an LLM
“How do I revoke a user's access to a CDW cluster?”
“Does removing someone from a cluster delete their user account?”
Tell an agent destructive · confirm first
Remove user {userId} from cluster {clusterId}.
Revoke {userId}'s access to Data Warehouse cluster {clusterId}.
POST /api/v1/dw/listUsers List users with access to a cluster · Lists the users who have access to the cluster #
Ask an LLM
“Who has access to my Data Warehouse cluster?”
“Which users have been added to a CDW cluster?”
Tell an agent
List the users on cluster {clusterId}.
Show everyone who can access {clusterId}.
POST /api/v1/dw/upgradeDbc Upgrade a Database Catalog · Upgrades the Database Catalog to a compatible version #
Ask an LLM
“How do I upgrade my Database Catalog to a newer compatible version?”
“Can I choose which image version a DBC upgrades to?”
Tell an agent
Upgrade Database Catalog {dbcId} on {clusterId} to version {imageVersion}.
Move DBC {dbcId} in cluster {clusterId} onto image {imageVersion}.
POST /api/v1/dw/upgradeVw Upgrade a Virtual Warehouse · Upgrades the Virtual Warehouse to a compatible version #
Ask an LLM
“How do I upgrade a Virtual Warehouse to a newer compatible release?”
“Can I pick a resource pool when upgrading a warehouse?”
Tell an agent
Upgrade Virtual Warehouse {vwId} on catalog {dbcId} in {clusterId} to version {imageVersion}.
Move warehouse {vwId} (DBC {dbcId}, cluster {clusterId}) onto image {imageVersion}.
POST /api/v1/dw/getUpgradeVwVersions Check upgrade versions for a Virtual Warehouse · Gets the latest version and latest compatible version for Virtual Warehouse #
Ask an LLM
“Is there a newer compatible version for my Virtual Warehouse?”
“What's the latest release a warehouse could be upgraded to?”
Tell an agent
Get the upgrade versions for Virtual Warehouse {vwId} on {clusterId}.
Tell me the latest compatible release for warehouse {vwId} in {clusterId}.
POST /api/v1/dw/getUpgradeDbcVersions Check upgrade versions for a Database Catalog · Gets the latest version and latest compatible version for Database Catalog #
Ask an LLM
“Is there a newer compatible version for my Database Catalog?”
“What's the latest release a DBC could be upgraded to?”
Tell an agent
Get the upgrade versions for Database Catalog {dbcId} on {clusterId}.
Tell me the latest compatible release for DBC {dbcId} in {clusterId}.
POST /api/v1/dw/healthCheck Check the Data Warehouse API is healthy · Check the health of the API #
Ask an LLM
“Is the Cloudera Data Warehouse API up?”
“Can I ping the DW service to confirm it's responding?”
Tell an agent
Run a health check on the Data Warehouse API.
Ping the DW service and tell me if it's responding.
POST /api/v1/dw/createBackup Take an on-demand data warehouse backup · Creates a backup for the data warehouse #
Ask an LLM
“How do I back up the data warehouse including Kubernetes objects and persistent volumes?”
“Can I limit an on-demand backup to certain namespaces?”
Tell an agent
Create a data warehouse backup named {backupName}.
Back up namespaces {namespaceNames} now as {backupName}.
POST /api/v1/dw/deleteBackup Delete a data warehouse backup · Deletes a data warehouse backup #
Ask an LLM
“How do I remove an old data warehouse backup?”
“Does deleting a backup happen immediately?”
Tell an agent destructive · confirm first
Delete data warehouse backup {backupCrn}.
Remove the backup {backupCrn} permanently.
POST /api/v1/dw/describeBackup Get details of a data warehouse backup · Describes the backup #
Ask an LLM
“Did my data warehouse backup complete successfully?”
“What does a particular backup contain and when was it taken?”
Tell an agent
Describe data warehouse backup {backupCrn}.
Show the state of backup {backupCrn}.
POST /api/v1/dw/restoreBackup Restore the data warehouse from a backup · Restores backup #
Ask an LLM
“How do I roll the data warehouse back to an earlier backup?”
“Can I restore only some namespaces from a backup?”
Tell an agent
Restore the data warehouse from backup {backupCrn}.
Restore namespaces {namespaceNames} from backup {backupCrn} with rebuild {rebuild}.
POST /api/v1/dw/describeRestore Check a data warehouse restore · Describes the restore #
Ask an LLM
“Has my data warehouse restore finished?”
“What happened during a particular restore operation?”
Tell an agent
Describe restore {restoreCrn}.
Show the progress of data warehouse restore {restoreCrn}.
POST /api/v1/dw/listBackupEntities List what can be included in a backup · Lists potential backup entities associated with the data warehouse #
Ask an LLM
“Which namespaces and entities can I include in a data warehouse backup?”
“What parts of the data warehouse are eligible for backup?”
Tell an agent
List the potential backup entities for the data warehouse.
Show which namespaces I could back up.
POST /api/v1/dw/listBackups List data warehouse backups · Lists backups #
Ask an LLM
“What backups exist for my data warehouse?”
“Can I include automatic backups or filter backups by job state?”
Tell an agent
List my data warehouse backups.
Show backups in state {jobStates}, including automatic ones set to {includeAutomaticBackups}.
POST /api/v1/dw/listRestores List data warehouse restores · Lists restores #
Ask an LLM
“Which restore operations have been run on my data warehouse?”
“Can I see all restores that came from one backup?”
Tell an agent
List data warehouse restores.
Show the restores made from backup {backupCrn}.
POST /api/v1/dw/getLogs Get logs for a backup or restore job · Gets job logs #
Ask an LLM
“Where can I read the logs of a backup or restore job?”
“Why did my data warehouse backup job fail?”
Tell an agent
Get the job logs for {crn}.
Show me the log output of job {crn}.
POST /api/v1/dw/listResourceTemplates List resource allocation templates · Get default resource allocation templates #
Ask an LLM
“What default CPU and memory templates does CDW offer?”
“Which resource templates can I assign to warehouses and catalogs?”
Tell an agent
List the resource allocation templates.
Show the predefined CPU and memory templates.
POST /api/v1/dw/createResourceTemplate Create a resource allocation template · Create a resource allocation template #
Ask an LLM
“Can I define my own CPU and memory template for Virtual Warehouses?”
“How do I create a custom resource template for a given entity type?”
Tell an agent
Create a resource template named {name} for {entityType} with resources {resources}.
Add a custom CPU and memory template {name} described as {description}.
POST /api/v1/dw/updateResourceTemplate Update a resource allocation template · Update a resource allocation template #
Ask an LLM
“Can I change the CPU or memory values in an existing resource template?”
“How do I rename a resource template I already made?”
Tell an agent
Update resource template {templateId} with resources {resources}.
Rename existing template {templateId} to {name}.
POST /api/v1/dw/deleteResourceTemplate Delete a resource allocation template · Delete a resource allocation template #
Ask an LLM
“How do I remove a custom resource template?”
“Can I delete one specific version of a resource template?”
Tell an agent destructive · confirm first
Delete resource template {templateId}.
Remove version {templateVersion} of template {templateId}.

Documentation

📖
Documentation
https://docs.cloudera.com/cdp-public-cloud/cloud/api/topics/mc-api-overview.html
📖
APIReference
https://cloudera.github.io/cdp-dev-docs/api-docs/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/openapi/cloudera-dw-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-vw-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-azure-cluster-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-update-vw-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-aws-cluster-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-cluster-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-update-cluster-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cloudera:cloudera-dw-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cloudera-dw-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 0.9.163
  title: Cloudera Data Warehouse [EXPERIMENTAL] Dw API
  license:
    name: Apache 2.0
  description: Install and manage Cloudera Data Warehouse clusters.
  termsOfService: https://www.cloudera.com/legal/commercial-terms-and-conditions.html
tags:


# --- truncated at 32 KB (287 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/openapi/cloudera-dw-api-openapi.yml