Cloudera Datalake API
The Datalake API from Cloudera — 56 operation(s) for datalake.
Operations 56
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/datalake/listRuntimes
List available Data Lake runtime versions · Lists the datalake versions
#
Ask an LLM
“Which Cloudera Runtime versions can I create a Data Lake with?”
“What datalake runtime versions are currently available?”
Tell an agent
List the available Data Lake runtime versions.
Show me which runtimes a new datalake can use.
Ask an LLM
“How do I create a Data Lake in a commercial AWS environment?”
“Can I enable Ranger RAZ and multi-AZ on a new AWS datalake?”
Tell an agent
Create AWS datalake {name} in environment {environment} with cloud configuration {config}.
Create AWS datalake {name} at scale {scale} on runtime {runtime}.
POST
/api/v1/datalake/createAWSGovCloudDatalake
Create a Data Lake on AWS GovCloud · Creates a Data Lake on AWS GovCloud
#
Ask an LLM
“What is needed to stand up a Data Lake in a US government (GovCloud) region?”
“Can a GovCloud datalake run across multiple availability zones?”
Tell an agent
Create GovCloud datalake {name} in environment {environment} with cloud configuration {config}.
Create an AWS GovCloud Data Lake {name} at scale {scale}.
Ask an LLM
“How do I create a Data Lake in an Azure environment?”
“Can I use a flexible server delegated subnet for an Azure datalake's database?”
Tell an agent
Create Azure datalake {name} in environment {environment} with cloud configuration {config}.
Create Azure datalake {name} using database type {dbType} and subnet {subnet}.
POST
/api/v1/datalake/createGCPDatalake
Create a Data Lake on Google Cloud · Creates an GCP Data Lake
#
Ask an LLM
“How do I create a Data Lake in a GCP environment?”
“Can I add recipes and tags to a new Google Cloud datalake?”
Tell an agent
Create GCP datalake {name} in environment {environment} with cloud configuration {config}.
Create a Google Cloud Data Lake {name} on runtime {runtime}.
Ask an LLM
“Which datalakes exist across my CDP environments?”
“Can I list only the Data Lakes in one environment?”
Tell an agent
List all my datalakes.
List datalakes in environment {environment}.
Ask an LLM
“How do I delete a Data Lake?”
“Can I force-delete a datalake that is stuck?”
Tell an agent destructive · confirm first
Delete datalake {name}.
Force delete datalake {name} ({force}).
POST
/api/v1/datalake/retryDatalake
Retry a Data Lake's last failed operation · Retry last failed operation on a datalake
#
Ask an LLM
“Can I retry the operation that just failed on my datalake?”
“What do I do when a Data Lake operation fails partway through?”
Tell an agent
Retry the last failed operation on datalake {name}.
Rerun the failed step on Data Lake {name}.
POST
/api/v1/datalake/startDatalakeVerticalScaling
Vertically scale a Data Lake instance group · Initiates the vertical scaling on Data Lake
#
Ask an LLM
“Can I change the instance type of a Data Lake host group?”
“How do I modify the disks of one Data Lake instance group?”
Tell an agent
Vertically scale group {group} of datalake {datalake} to instance template {template}.
Change the disks of group {group} on Data Lake {datalake} to {disks}.
Ask an LLM
“What is the status and configuration of one datalake?”
“Can I get full details for a Data Lake by name?”
Tell an agent
Describe datalake {name}.
Show me the details of Data Lake {name}.
POST
/api/v1/datalake/renewCertificate
Renew a Data Lake certificate (deprecated) · Renew certificate on Datalake cluster by name or CRN
#
Ask an LLM
“Is there an older call for renewing a datalake's certificate?”
“Which deprecated endpoint renews a Data Lake certificate?”
Tell an agent
Renew the certificate on datalake {name} using the deprecated renew-certificate call.
Use the legacy certificate renewal on Data Lake {name}.
POST
/api/v1/datalake/renewPublicCertificate
Renew a Data Lake's public certificate · Renews public certificate on Datalake cluster by name or CRN
#
Ask an LLM
“How do I renew the public certificate on my Data Lake before it expires?”
“Can I renew a datalake public certificate by CRN?”
Tell an agent
Renew the public certificate on datalake {datalake}.
Refresh the public TLS certificate for Data Lake {datalake}.
Ask an LLM
“How do I repair unhealthy nodes in a Data Lake?”
“Can I repair only specific instance groups or instances of a datalake?”
Tell an agent
Repair datalake {name}.
Repair instance groups {groups} on datalake {name}.
POST
/api/v1/datalake/restartDatalakeInstances
Restart Data Lake instances on the cloud provider · Restarts instances of a datalake on Cloud provider
#
Ask an LLM
“Can I reboot specific Data Lake VMs on the cloud provider?”
“How do I restart individual instances of a datalake?”
Tell an agent
Restart instances {instances} of datalake {name}.
Reboot the cloud VMs {instances} behind Data Lake {name}.
POST
/api/v1/datalake/getClusterServiceStatus
Get service status of a Data Lake cluster · Get cluster service status
#
Ask an LLM
“Are all the services in my Data Lake cluster healthy?”
“Which services in a datalake cluster are failing?”
Tell an agent
Get the service status of cluster {cluster}.
Check which services are down on Data Lake cluster {cluster}.
POST
/api/v1/datalake/getClusterHostStatus
Get host status of a Data Lake cluster · Get cluster host status
#
Ask an LLM
“Are all the hosts in my Data Lake cluster up?”
“Which hosts in a datalake cluster are unhealthy?”
Tell an agent
Get the host status of cluster {cluster}.
Check the health of every host in Data Lake cluster {cluster}.
POST
/api/v1/datalake/upgradeDatalake
Upgrade a Data Lake's OS or runtime · OS or data platform upgrade for the SDX cluster
#
Ask an LLM
“How do I upgrade my Data Lake to a newer runtime or OS image?”
“Can I do a dry run of a datalake upgrade first?”
Tell an agent
Upgrade datalake {name} to runtime {runtime}.
Upgrade datalake {name} to image {image} as a dry run ({dryRun}).
POST
/api/v1/datalake/prepareDatalakeUpgrade
Prepare a Data Lake for an upgrade · Prepares the Data Lake cluster for upgrade
#
Ask an LLM
“Can I run upgrade validations and download parcels before upgrading a Data Lake?”
“How do I reduce the chance of a datalake upgrade failing?”
Tell an agent
Prepare datalake {datalake} for upgrade to runtime {runtime}.
Run upgrade preparation on Data Lake {datalake} for image {image}.
POST
/api/v1/datalake/startDatabaseUpgrade
Upgrade a Data Lake's database · Upgrades the database of the Data Lake cluster
#
Ask an LLM
“How do I upgrade the database behind my Data Lake?”
“Can I choose the target database version for a datalake?”
Tell an agent
Upgrade the database of datalake {datalake} to version {version}.
Start a database upgrade on Data Lake {datalake}.
Ask an LLM
“Is there still a direct call to start a stopped Data Lake?”
“What replaced the deprecated start-datalake command?”
Tell an agent
Start datalake {name} using the deprecated start call.
Bring stopped Data Lake {name} back up.
Ask an LLM
“Is there still a direct call to stop a running Data Lake?”
“What replaced the deprecated stop-datalake command?”
Tell an agent
Stop datalake {name} using the deprecated stop call.
Shut down running Data Lake {name}.
Ask an LLM
“How do I take a backup of all the data in my Data Lake?”
“Can I skip Atlas metadata or Ranger audits when backing up a datalake?”
Tell an agent
Back up datalake {name} to {location}.
Take backup {backup} of datalake {name}, skipping Ranger audits ({skipAudits}).
POST
/api/v1/datalake/backupDatalakeStatus
Check a Data Lake backup's status · Check the status of a datalake backup operation performed
#
Ask an LLM
“Has my datalake backup finished yet?”
“Can I check a backup's progress by its name or ID?”
Tell an agent
Check the status of backup {backupId} on datalake {name}.
Get the status of backup named {backup} for Data Lake {name}.
POST
/api/v1/datalake/restoreDatalake
Restore a Data Lake from a backup · Restore the datalake from backup taken
#
Ask an LLM
“How do I restore my Data Lake from a backup I took earlier?”
“Can I include the database when restoring a datalake?”
Tell an agent
Restore datalake {name} from backup {backupId}.
Restore datalake {name} from backup named {backup} using location {location}.
POST
/api/v1/datalake/restoreDatalakeStatus
Check a Data Lake restore's status · Check the status of datalake restore operation
#
Ask an LLM
“Has my datalake restore completed?”
“Can I check a restore's progress by its restore ID?”
Tell an agent
Check the status of restore {restoreId} on datalake {name}.
Get the latest restore status for Data Lake {name}.
POST
/api/v1/datalake/listDatalakeBackups
List a Data Lake's backups · List all the backup operations that were performed on the datalake
#
Ask an LLM
“Which backups have been taken of my datalake?”
“Can I see the history of backup operations on a Data Lake?”
Tell an agent
List backups of datalake {name}.
Show every backup operation run on Data Lake {name}.
POST
/api/v1/datalake/cancelBackup
Cancel a running Data Lake backup · Cancels the specified ongoing backup operation
#
Ask an LLM
“Can I cancel a datalake backup that is still in progress?”
“What happens to pending steps when I cancel a backup?”
Tell an agent destructive · confirm first
Cancel backup {backupId}.
Force cancel running backup {backupId} ({force}).
POST
/api/v1/datalake/cancelRestore
Cancel a running Data Lake restore · Cancels the restore that was performed
#
Ask an LLM
“Can I stop a datalake restore that is in progress?”
“Which states must a restore be in before I can cancel it?”
Tell an agent destructive · confirm first
Cancel restore {restoreId}.
Force cancel running restore {restoreId} ({force}).
POST
/api/v1/datalake/replaceRecipes
Replace recipes on Data Lake instance groups · Replaces recipes for the given instance groups
#
Ask an LLM
“How do I swap the recipes attached to my Data Lake's instance groups?”
“Can I change which scripts run on a datalake host group?”
Tell an agent
Replace recipes on datalake {datalake} with {recipes}.
Set instance group recipes {recipes} on Data Lake {datalake}.
POST
/api/v1/datalake/rotateSecrets
Rotate secrets on a Data Lake · Rotates secrets for a specific Datalake
#
Ask an LLM
“How do I rotate specific secret types on my Data Lake?”
“Can I rotate the SaltStack password through the general secret rotation call?”
Tell an agent
Rotate secrets {types} on datalake {datalake}.
Rotate the {types} secrets for Data Lake {datalake}.
POST
/api/v1/datalake/rotateDbCertificate
Rotate a Data Lake's database SSL certificate · Rotates database ssl certificate for a specific Data Lake
#
Ask an LLM
“How do I rotate the database SSL certificate on my Data Lake?”
“Can I refresh the DB TLS cert of a datalake?”
Tell an agent
Rotate the database SSL certificate on datalake {name}.
Replace the DB certificate of Data Lake {name}.
POST
/api/v1/datalake/listDatalakeSecretTypes
List secret types for a Data Lake · Lists all Datalake related secret types
#
Ask an LLM
“Which secret types can I rotate on a Data Lake?”
“What secrets does my datalake have?”
Tell an agent
List secret types for datalake {datalake}.
Show rotatable secret types on Data Lake {datalake}.
POST
/api/v1/datalake/getDatalakeLogDescriptors
List log descriptors for diagnostics · Gather log descriptors that are used for diagnostics collection
#
Ask an LLM
“Which log descriptors can I include in a Data Lake diagnostics collection?”
“What logs are available when gathering datalake diagnostics?”
Tell an agent
Get the log descriptors used for Data Lake diagnostics collection.
List the logs I can add to a datalake diagnostics bundle.
POST
/api/v1/datalake/collectDatalakeDiagnostics
Start a Data Lake diagnostics collection · Start DataLake diagnostics collection
#
Ask an LLM
“How do I collect diagnostic logs from my Data Lake for a support case?”
“Can I limit a diagnostics collection to a date range or certain hosts?”
Tell an agent
Collect diagnostics for datalake {crn} to {destination} with description {description}.
Collect datalake {crn} diagnostics for support case {case} from {start} to {end}.
POST
/api/v1/datalake/listDatalakeDiagnostics
List recent Data Lake diagnostics collections · List recent Datalake diagnostics collections
#
Ask an LLM
“Which diagnostics collections have run on my Data Lake recently?”
“Can I see the status of past datalake diagnostics bundles?”
Tell an agent
List recent diagnostics collections for datalake {crn}.
Show diagnostics bundle history for Data Lake {crn}.
POST
/api/v1/datalake/cancelDatalakeDiagnostics
Cancel running Data Lake diagnostics · Cancel running Datalake diagnostics collections
#
Ask an LLM
“Can I stop a diagnostics collection that is still running on my datalake?”
“How do I abort a Data Lake log collection?”
Tell an agent destructive · confirm first
Cancel running diagnostics collections on datalake {crn}.
Abort the diagnostics bundle in progress for Data Lake {crn}.
POST
/api/v1/datalake/collectCmDiagnostics
Start Cloudera Manager diagnostics for a Data Lake · Start DataLake Cloudera Manager based diagnostics collection
#
Ask an LLM
“How do I collect Cloudera Manager based diagnostics from a Data Lake?”
“Can I filter CM diagnostics by role and cap the bundle size?”
Tell an agent
Collect Cloudera Manager diagnostics for datalake {crn} to {destination}.
Collect CM diagnostics for datalake {crn} limited to roles {roles} with size limit {limit}.
POST
/api/v1/datalake/getCmRoles
List Cloudera Manager roles for diagnostics filtering · Gather Cloudera Manager roles that can be used for filtering in CM based…
#
Ask an LLM
“Which Cloudera Manager roles can I filter a CM diagnostics bundle by?”
“What CM roles are running on my Data Lake?”
Tell an agent
Get the Cloudera Manager roles for datalake {crn}.
List CM roles I can use to filter diagnostics on Data Lake {crn}.
POST
/api/v1/datalake/getOperation
Get the status of a Data Lake operation · Used for retrieving operation status for the datalake cluster, defaulting to…
#
Ask an LLM
“What is the status of the most recent operation on my datalake?”
“Can I look up a specific historical Data Lake operation by its ID?”
Tell an agent
Get the latest operation status for datalake {name}.
Show details of operation {operation} on Data Lake {crn}.
POST
/api/v1/datalake/rotateAutoTlsCertificates
Rotate AutoTLS certificates (deprecated) · Rotate autotls certificates on the datalake's hosts
#
Ask an LLM
“Is there an older call to rotate AutoTLS certificates on datalake hosts?”
“Which deprecated endpoint rotates autotls certs?”
Tell an agent
Rotate AutoTLS certificates on datalake {name} using the deprecated call.
Use the legacy autotls rotation on Data Lake {name}.
POST
/api/v1/datalake/rotatePrivateCertificates
Rotate private certificates on Data Lake hosts · Rotates private certificates on the datalake's hosts
#
Ask an LLM
“How do I rotate the private host certificates on my Data Lake?”
“Can I renew internal TLS certificates across datalake hosts?”
Tell an agent
Rotate private certificates on datalake {datalake}.
Renew the internal host certificates of Data Lake {datalake}.
POST
/api/v1/datalake/describeDatabaseServer
Get a Data Lake's external database server · Gets external database server details
#
Ask an LLM
“What external database server is my Data Lake using?”
“Can I see the database server details for a datalake cluster CRN?”
Tell an agent
Describe the database server for datalake cluster {cluster}.
Show external database details of Data Lake cluster {cluster}.
POST
/api/v1/datalake/validateAwsCloudStorage
Validate AWS cloud storage for a Data Lake · Validates AWS cloud storage
#
Ask an LLM
“Are my S3 storage location and IAM roles set up correctly for a Data Lake?”
“Can I check the data access and Ranger audit roles before creating an AWS datalake?”
Tell an agent
Validate AWS storage {location} for cluster {cluster} with data access role {dataRole} and Ranger audit role {auditRole}.
Check instance profile {profile} and credential {credential} against AWS storage {location}.
POST
/api/v1/datalake/validateAzureCloudStorage
Validate Azure cloud storage for a Data Lake · Validates Azure cloud storage
#
Ask an LLM
“Is my ADLS storage location configured correctly for a Data Lake?”
“Can I validate Azure storage using a managed identity before creating a datalake?”
Tell an agent
Validate Azure storage {location} for cluster {cluster} with data access role {dataRole} and Ranger audit role {auditRole}.
Check Azure storage {location} using managed identity {identity}.
POST
/api/v1/datalake/resizeDatalake
Resize a Data Lake to a new shape · Resizes the given datalake to the given target size
#
Ask an LLM
“How do I resize my Data Lake from light duty to a larger shape?”
“Can I make a datalake multi-AZ as part of a resize?”
Tell an agent
Resize datalake {name} to {size}.
Validate only a resize of datalake {name} to {size} ({validationOnly}).
POST
/api/v1/datalake/scaleHorizontally
Add nodes to a Data Lake host group · Horizontally scale the Data Lake nodes, to add additional compute nodes to the…
#
Ask an LLM
“How do I add more compute nodes to a Data Lake host group?”
“Which Data Lake instance groups can be scaled out horizontally?”
Tell an agent
Scale group {group} of datalake {name} out to {count} nodes.
Set the node count of Data Lake {name} group {group} to {count}.
POST
/api/v1/datalake/recoverDatalake
Recover a Data Lake after a failed upgrade · Recover data lake to the original version after a failed upgrade
#
Ask an LLM
“My datalake upgrade failed, can I roll it back to the original version?”
“Which recovery types exist for a failed Data Lake upgrade?”
Tell an agent
Recover datalake {name} to its original version.
Recover Data Lake {name} using recovery type {type}.
Ask an LLM
“How do I assign a catalog to my Data Lake?”
“Can I change which catalog a datalake uses?”
Tell an agent
Set catalog {catalog} on datalake {datalake}.
Point Data Lake {datalake} at catalog {catalog}.
POST
/api/v1/datalake/syncComponentVersionsFromCm
Sync component versions from Cloudera Manager · Syncs component versions from CM after a failed upgrade
#
Ask an LLM
“After a failed upgrade, how do I sync my Data Lake's component versions from Cloudera Manager?”
“Can I fix mismatched component versions on a datalake?”
Tell an agent
Sync component versions from CM for datalake {name}.
Reconcile Data Lake {name}'s component versions with Cloudera Manager.
POST
/api/v1/datalake/rotateSaltPassword
Rotate the SaltStack password (deprecated) · Rotate SaltStack user password on DataLake instances
#
Ask an LLM
“Is there a dedicated call to rotate the SaltStack user password on Data Lake instances?”
“Which deprecated endpoint changes the Salt password on a datalake?”
Tell an agent
Rotate the SaltStack password on datalake {datalake} using the deprecated call.
Change the Salt user password on Data Lake {datalake} instances.
POST
/api/v1/datalake/updateOrchestratorState
Run an orchestrator state update on a Data Lake · Run orchestrator engine state update on the Data Lake cluster
#
Ask an LLM
“How do I re-apply the orchestrator engine state on my Data Lake cluster?”
“Can I refresh the Salt orchestrator state on a datalake?”
Tell an agent
Run an orchestrator state update on datalake cluster {cluster}.
Reapply orchestrator state to Data Lake cluster {cluster}.
POST
/api/v1/datalake/updateToAwsImdsV2
Switch an AWS Data Lake to IMDSv2 · Updates Data Lake AWS cluster to use IMDSv2
#
Ask an LLM
“How do I move my AWS Data Lake to IMDSv2?”
“Can a datalake be required to use the session-based instance metadata service?”
Tell an agent
Update datalake {crn} to use IMDSv2.
Enforce instance metadata v2 on AWS Data Lake {crn}.
POST
/api/v1/datalake/updateToAwsImdsV1
Switch an AWS Data Lake back to IMDSv1 · Updates Data Lake AWS cluster to use IMDSv1
#
Ask an LLM
“Can I revert my AWS Data Lake to IMDSv1?”
“What call moves a datalake back to the older instance metadata version?”
Tell an agent
Update datalake {crn} to use IMDSv1.
Roll AWS Data Lake {crn} back to instance metadata v1.
POST
/api/v1/datalake/setDefaultJavaVersion
Set a Data Lake's default Java version · Configures the default Java version for the Data Lake
#
Ask an LLM
“How do I change the default Java version on my Data Lake?”
“Will changing a datalake's Java version restart services, and can it be rolling?”
Tell an agent
Set the default Java version of datalake {crn} to {java}.
Switch Data Lake {crn} to Java {java} with a rolling restart ({rolling}).
POST
/api/v1/datalake/migrateSkus
Migrate a Data Lake to a new SKU · Migrate the Data Lake to a new SKU
#
Ask an LLM
“How do I migrate my Data Lake to a new SKU?”
“Can I force a datalake SKU migration?”
Tell an agent
Migrate datalake {name} to the new SKU.
Force the SKU migration of Data Lake {name} ({force}).
POST
/api/v1/datalake/updatePublicDnsEntries
Update a Data Lake's public DNS entries · Update public DNS entries of a Data Lake cluster by name or CRN
#
Ask an LLM
“How do I refresh the public DNS records of my Data Lake cluster?”
“Can I update datalake DNS entries by name or CRN?”
Tell an agent
Update the public DNS entries of datalake {datalake}.
Refresh public DNS records for Data Lake {datalake}.
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
Schemas & Data
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-collect-datalake-diagnostics-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-azure-datalake-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-restore-datalake-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-awsdatalake-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-gcpdatalake-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-awsgov-cloud-datalake-request-schema.json