Cloudera Datalake API
Provision the datalake that carries an environment’s shared metadata, security and governance context, and back it up, restore it and cancel those runs. 56 operations.
Cloudera Datalake 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 Lake, Backup, and Governance. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 56 operations across 56 paths, and defines 167 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.
56 operations
56 paths
167 schemas
56 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 56
Across 56 paths, the API surfaces 56 operations — 56 POST. Each is listed below with its method, path, parameters, and response codes.
Operations 56
POST
/api/v1/datalake/listRuntimes
Lists the datalake versions.
POST
/api/v1/datalake/createAWSDatalake
Creates an AWS datalake.
POST
/api/v1/datalake/createAWSGovCloudDatalake
Creates a Data Lake on AWS GovCloud.
POST
/api/v1/datalake/createAzureDatalake
Creates an Azure datalake.
POST
/api/v1/datalake/createGCPDatalake
Creates an GCP Data Lake.
POST
/api/v1/datalake/listDatalakes
Lists datalakes.
POST
/api/v1/datalake/deleteDatalake
Deletes a datalake.
POST
/api/v1/datalake/retryDatalake
Retry last failed operation on a datalake.
POST
/api/v1/datalake/startDatalakeVerticalScaling
Initiates the vertical scaling on Data Lake.
POST
/api/v1/datalake/describeDatalake
Describes a datalake.
POST
/api/v1/datalake/renewCertificate
Renew certificate on Datalake cluster by name or CRN
POST
/api/v1/datalake/renewPublicCertificate
Renews public certificate on Datalake cluster by name or CRN.
POST
/api/v1/datalake/repairDatalake
Repairs a datalake.
POST
/api/v1/datalake/restartDatalakeInstances
Restarts instances of a datalake on Cloud provider.
POST
/api/v1/datalake/getClusterServiceStatus
Get cluster service status.
POST
/api/v1/datalake/getClusterHostStatus
Get cluster host status.
POST
/api/v1/datalake/upgradeDatalake
OS or data platform upgrade for the SDX cluster.
POST
/api/v1/datalake/prepareDatalakeUpgrade
Prepares the Data Lake cluster for upgrade.
POST
/api/v1/datalake/startDatabaseUpgrade
Upgrades the database of the Data Lake cluster.
POST
/api/v1/datalake/startDatalake
Start Datalake
POST
/api/v1/datalake/stopDatalake
Stop Datalake
POST
/api/v1/datalake/backupDatalake
Create backup of datalake.
POST
/api/v1/datalake/backupDatalakeStatus
Check the status of a datalake backup operation performed.
POST
/api/v1/datalake/restoreDatalake
Restore the datalake from backup taken.
POST
/api/v1/datalake/restoreDatalakeStatus
Check the status of datalake restore operation.
POST
/api/v1/datalake/listDatalakeBackups
List all the backup operations that were performed on the datalake.
POST
/api/v1/datalake/cancelBackup
Cancels the specified ongoing backup operation.
POST
/api/v1/datalake/cancelRestore
Cancels the restore that was performed.
POST
/api/v1/datalake/replaceRecipes
Replaces recipes for the given instance groups.
POST
/api/v1/datalake/rotateSecrets
Rotates secrets for a specific Datalake
POST
/api/v1/datalake/rotateDbCertificate
Rotates database ssl certificate for a specific Data Lake
POST
/api/v1/datalake/listDatalakeSecretTypes
Lists all Datalake related secret types.
POST
/api/v1/datalake/getDatalakeLogDescriptors
Gather log descriptors that are used for diagnostics collection.
POST
/api/v1/datalake/collectDatalakeDiagnostics
Start DataLake diagnostics collection
POST
/api/v1/datalake/listDatalakeDiagnostics
List recent Datalake diagnostics collections
POST
/api/v1/datalake/cancelDatalakeDiagnostics
Cancel running Datalake diagnostics collections
POST
/api/v1/datalake/collectCmDiagnostics
Start DataLake Cloudera Manager based diagnostics collection
POST
/api/v1/datalake/getCmRoles
Gather Cloudera Manager roles that can be used for filtering in CM based diagnostics collection.
POST
/api/v1/datalake/getOperation
Used for retrieving operation status for the datalake cluster, defaulting to the most recent operation. Provide an operationId to view details of a specific historical operation.
POST
/api/v1/datalake/rotateAutoTlsCertificates
Rotate autotls certificates on the datalake's hosts
POST
/api/v1/datalake/rotatePrivateCertificates
Rotates private certificates on the datalake's hosts.
POST
/api/v1/datalake/describeDatabaseServer
Gets external database server details.
POST
/api/v1/datalake/validateAwsCloudStorage
Validates AWS cloud storage.
POST
/api/v1/datalake/validateAzureCloudStorage
Validates Azure cloud storage.
POST
/api/v1/datalake/resizeDatalake
Resizes the given datalake to the given target size.
POST
/api/v1/datalake/scaleHorizontally
Horizontally scale the Data Lake nodes, to add additional compute nodes to the cluster.
POST
/api/v1/datalake/recoverDatalake
Recover data lake to the original version after a failed upgrade.
POST
/api/v1/datalake/setCatalog
Sets a catalog for a DataLake.
POST
/api/v1/datalake/syncComponentVersionsFromCm
Syncs component versions from CM after a failed upgrade.
POST
/api/v1/datalake/rotateSaltPassword
Rotate SaltStack user password on DataLake instances.
POST
/api/v1/datalake/updateOrchestratorState
Run orchestrator engine state update on the Data Lake cluster.
POST
/api/v1/datalake/updateToAwsImdsV2
Updates Data Lake AWS cluster to use IMDSv2.
POST
/api/v1/datalake/updateToAwsImdsV1
Updates Data Lake AWS cluster to use IMDSv1.
POST
/api/v1/datalake/setDefaultJavaVersion
Configures the default Java version for the Data Lake.
POST
/api/v1/datalake/migrateSkus
Migrate the Data Lake to a new SKU.
POST
/api/v1/datalake/updatePublicDnsEntries
Update public DNS entries of a Data Lake cluster by name or CRN.
Schemas 167
The contract defines 167 schemas that model the data the API accepts and returns. The most detailed are DatalakeDetails (21 properties), CollectDatalakeDiagnosticsRequest (17 properties), Instance (16 properties), CreateAzureDatalakeRequest (15 properties). Each schema is shown below with its type and property counts.
Error
object
An object returned on an error.
2 properties
ClouderaManagerDetails
object
Cloudera Manager details.
3 properties
2 required
ProductVersion
object
Product version.
2 properties
2 required
AWSConfiguration
object
AWS configuration.
1 property
AzureConfiguration
object
Azure configuration.
1 property
GCPConfiguration
object
GCP configuration.
1 property
StartDatalakeVerticalScalingRequest
object
The request object for Data Lake vertical scaling.
4 properties
2 required
StartDatalakeVerticalScalingResponse
object
The response object for Data Lake vertical scaling.
2 properties
InstanceTemplate
object
Instance template that specifies the core information for the vertical scale.
1 property
DiskOptions
object
Attached disk configuration(s).
2 properties
AddDisks
object
Attached volume configuration.
4 properties
4 required
ModifyDisks
object
Attached volume configuration.
3 properties
1 required
DatalakeDetails
object
Details about a datalake
21 properties
2 required
InstanceGroup
object
The type of the instance group which also contains the actual instance(s)
4 properties
2 required
Instance
object
Object which holds some details of an instance for the given cluster.
16 properties
2 required
DatalakeInstanceStatus
string
The status of the instance.
DatalakeInstanceType
string
The type of the instance.
AttachedVolumeDetail
object
The attached volume configuration.
3 properties
Endpoints
object
Object which holds the exposed endpoints for the given cluster.
1 property
1 required
Endpoint
object
Object which holds the exposed endpoint.
6 properties
6 required
Datalake
object
Information about a datalake.
10 properties
2 required
DatalakeResourceTagRequest
object
Tag for a datalake resource.
2 properties
2 required
DatalakeResourceGCPTagRequest
object
A label that can be attached to GCP Data Lake resources. Please refer to Google documentation for the rules https://cloud.google.com/compute/docs/labeling-reso…
2 properties
2 required
DatalakeResourceTag
object
Tag for a datalake resource.
2 properties
2 required
ListRuntimesRequest
object
Request object for list datalake runtime versions.
ListRuntimesResponse
object
Response object for list datalake runtime versions.
1 property
1 required
Runtime
object
An advertised datalake runtime version.
2 properties
2 required
AWSConfigurationRequest
object
Request object for AWS configuration.
2 properties
2 required
AzureConfigurationRequest
object
Request object for Azure configuration.
2 properties
2 required
GCPConfigurationRequest
object
Request object for GCP configuration.
2 properties
2 required
CreateAWSDatalakeRequest
object
Request object for create AWS datalake request.
14 properties
3 required
CreateAWSDatalakeResponse
object
Response object for create AWS datalake request.
2 properties
1 required
CreateAWSGovCloudDatalakeRequest
object
Request object for createing AWS Data Lake request on GovCloud.
12 properties
3 required
CreateAWSGovCloudDatalakeResponse
object
Response object for creating AWS Data Lake request on GovCloud.
2 properties
1 required
CreateAzureDatalakeRequest
object
Request object for create Azure datalake request.
15 properties
3 required
CreateAzureDatalakeResponse
object
Response object for create Azure datalake request.
2 properties
1 required
CreateGCPDatalakeRequest
object
Request object for create GCP Data Lake request.
11 properties
3 required
CreateGCPDatalakeResponse
object
Response object for create GCP Data Lake request.
2 properties
1 required
DatalakeScaleType
string
Represents the available datalake scales. Defaults to LIGHTDUTY if not set.
DatalakeLoadBalancerSkuType
string
Represents the Azure load balancer SKU type. The current default is BASIC. To disable the load balancer, use type NONE.
ListDatalakesRequest
object
Request object for list datalakes request.
2 properties
ListDatalakesResponse
object
Response object for list datalakes request.
1 property
1 required
DeleteDatalakeRequest
object
Request object for delete datalake request.
2 properties
1 required
DeleteDatalakeResponse
object
Response object for delete datalake request.
1 property
RetryDatalakeResponse
object
Response object for retry datalake request.
1 property
RetryDatalakeRequest
object
Request object for retry datalake request.
1 property
1 required
DescribeDatalakeRequest
object
Request object for describe datalake request.
1 property
1 required
DescribeDatalakeResponse
object
Response object for describe datalake request.
1 property
1 required
RenewCertificateRequest
object
Request object for renew datalake certificate request, deprecated.
1 property
1 required
RepairDatalakeRequest
object
Request object for repair datalake request.
4 properties
1 required
RepairDatalakeResponse
object
Response object for repair datalake request.
1 property
RepairInstancesRequest
object
Details for repair instances.
1 property
RestartDatalakeInstancesRequest
object
Request object for restart datalake instances request.
2 properties
2 required
RestartDatalakeInstancesResponse
object
Response object for restart datalake instances request.
1 property
GetClusterServiceStatusRequest
object
Request object to get service status.
1 property
1 required
GetClusterServiceStatusResponse
object
Response object to get service status.
1 property
1 required
ServiceStatus
object
Information about a cluster service.
4 properties
HealthCheck
object
The result of a health check.
2 properties
GetClusterHostStatusRequest
object
Request object to get host status.
1 property
1 required
GetClusterHostStatusResponse
object
Response object for getting host status.
1 property
1 required
HostStatus
object
Information about cluster host status.
3 properties
StartDatalakeRequest
object
Request object to start a datalake, deprecated.
1 property
1 required
StartDatalakeResponse
object
Response object of starting a datalake, deprecated.
RotateDbCertificateRequest
object
Request object to rotate ssl certificate a datalake.
1 property
1 required
RotateDbCertificateResponse
object
Response object to rotate ssl certificate a datalake.
1 property
StopDatalakeRequest
object
Request object to stop a datalake, deprecated.
1 property
1 required
StopDatalakeResponse
object
Response object of stopping a datalake, deprecated.
BackupDatalakeRequest
object
Request object to perform a backup of datalake.
10 properties
1 required
BackupDatalakeResponse
object
Response object to a request made for backup of datalake.
12 properties
9 required
BackupDatalakeStatusRequest
object
Request object to get the status of datalake backup. Returns the status of the latest backup that matches the provided input.
3 properties
1 required
BackupDatalakeStatusResponse
object
Response object to get the status of datalake backup status request.
13 properties
9 required
RestoreDatalakeRequest
object
Request to restore datalake from backup. Restore does not restore the database by default.
11 properties
1 required
RestoreDatalakeResponse
object
Response object to a request to perform restore of datalake.
13 properties
10 required
RestoreDatalakeStatusRequest
object
Request object to get the status of a restore operation.
2 properties
1 required
RestoreDatalakeStatusResponse
object
Response object with information on last restore operation on a datalake.
13 properties
10 required
ListDatalakeBackupsRequest
object
Request object to get the list of backup operations performed on a datalake.
1 property
1 required
ListDatalakeBackupsResponse
object
Response object with the list of backup operations performed on a datalake.
1 property
CancelBackupRequest
object
The request to cancel a backup operation.
2 properties
1 required
CancelBackupResponse
object
Response to the cancel backup request.
1 property
1 required
CancelRestoreRequest
object
Details of the restore that has to be cancelled.
2 properties
1 required
CancelRestoreResponse
object
Response to restore invalidation request.
1 property
1 required
DatalakeBackup
object
Backup object with details of backup performed.
10 properties
10 required
InternalBackupRestoreState
object
Object representing the state of each service running a backup.
4 properties
4 required
AdminOperationsBackupRestoreState
object
The state of Cloudera Manager admin operations.
5 properties
4 required
HbaseBackupRestoreState
object
The state of each HBase backup/restore operation.
2 properties
2 required
SolrBackupRestoreState
object
The state of each Solr backup/restore operation.
8 properties
4 required
DatabaseBackupRestoreState
object
The state of the database backup/restore operation.
1 property
1 required
BackupRestoreOperationStatus
object
Contains the status and failure reason of an operation.
4 properties
1 required
ImageComponentVersions
object
Versions of the image components
6 properties
ImageInfo
object
Basic information about an image.
5 properties
UpgradeDatalakeRequest
object
Request object to upgrade datalake.
13 properties
1 required
UpgradeDatalakeResponse
object
Response object for upgrade datalake request.
4 properties
PrepareDatalakeUpgradeRequest
object
Request object to prepare Data Lake upgrade. This command indicates the upgrade preparation for a specific image or a selected runtime version. Important to no…
3 properties
1 required
PrepareDatalakeUpgradeResponse
object
Response object for prepare Data Lake upgrade request.
4 properties
StartDatabaseUpgradeRequest
object
Request object for Data Lake database upgrade.
3 properties
1 required
StartDatabaseUpgradeResponse
object
Response object to Data Lake database upgrade.
2 properties
DatalakeVmLogRequest
object
Log descriptor, contains a path and label pair. Used for diagnostics collections.
2 properties
2 required
DatalakeVmLogResponse
object
Log descriptor, contains a path and label pair. Used for diagnostics collections.
2 properties
CollectDatalakeDiagnosticsRequest
object
Request object for collecting DataLake diagnostics.
17 properties
3 required
CollectDatalakeDiagnosticsResponse
object
Response object for collecting DataLake diagnostics.
1 property
ListDatalakeDiagnosticsRequest
object
Request object for listing recent Datalake diagnostics collections.
1 property
1 required
ListDatalakeDiagnosticsResponse
object
Response object for listing recent Datalake diagnostics collections.
1 property
DatalakeDiagnosticsCollectionResponse
object
Response object for diagnostic collection flow details.
6 properties
DatalakeDiagnosticsCollectionDetailsResponse
object
Response object for diagnostic collection collection details.
7 properties
CancelDatalakeDiagnosticsRequest
object
Request object for cancel running Datalake diagnostics collections.
1 property
1 required
CancelDatalakeDiagnosticsResponse
object
Response object for cancel running Datalake diagnostics collections.
CollectCmDiagnosticsRequest
object
Request object for collecting DataLake diagnostics.
11 properties
2 required
CollectCmDiagnosticsResponse
object
Response object for collecting DataLake diagnostics.
1 property
GetCmRolesRequest
object
Request object for obtaining Cloudera Manger roles. (that can be used for filtering in CM based diagnostics collection)
1 property
1 required
GetCmRolesResponse
object
Response object for obtaining Cloudera Manger roles. (that can be used for filtering in CM based diagnostics collection)
1 property
GetDatalakeLogDescriptorsRequest
object
Request object for obtaining log descriptors. (that are used for diagnostics collection)
GetDatalakeLogDescriptorsResponse
object
Response object for obtaining log descriptors. (useful for diagnostics collection filtering)
1 property
GetOperationRequest
object
Request object for tracking the latest (current/last) operation on the datalake resource.
3 properties
GetOperationResponse
object
Response object for tracking the latest (current/last) operation on the datalake resource.
5 properties
RotateAutoTlsCertificatesRequest
object
Request object to rotate autotls certificates on datalake's hosts, deprecated.
1 property
1 required
RotateAutoTlsCertificatesResponse
object
Response object to rotate autotls certificates on datalake's hosts, deprecated.
1 property
RenewCertificateResponse
object
Response object for renew certificate request, deprecated.
1 property
DescribeDatabaseServerRequest
object
Request object for obtaining Database Server details.
1 property
DescribeDatabaseServerResponse
object
Response object for obtaining Database Server details.
14 properties
DatabaseServerSslConfig
object
SSL configuration for the database server
3 properties
ImageRequest
object
The image request for the datalake. When the 'runtime' parameter is set, only the 'os' parameter can be provided. Otherwise, you can use 'catalog name' and/or…
3 properties
ValidateAwsCloudStorageRequest
object
Request object for AWS cloud storage validation.
8 properties
7 required
ValidateAwsCloudStorageResponse
object
AWS cloud storage validation response.
2 properties
ValidateAzureCloudStorageRequest
object
Request object for Azure cloud storage validation.
11 properties
6 required
ValidateAzureCloudStorageResponse
object
Azure cloud storage validation response.
2 properties
ResizeDatalakeRequest
object
Datalake resize request.
8 properties
2 required
ResizeDatalakeResponse
object
Datalake resize response.
9 properties
ScaleHorizontallyRequest
object
Data Lake horizontal scaling request.
3 properties
3 required
ScaleHorizontallyResponse
object
Data Lake horizontal scaling response
2 properties
ReplaceRecipesRequest
object
The request for replacing recipes.
2 properties
2 required
ReplaceRecipesResponse
object
The response for replacing recipes.
2 properties
RotateSecretsRequest
object
Request object for starting secret rotation for datalake.
2 properties
2 required
RotateSecretsResponse
object
Response object for rotating secrets.
1 property
ListDatalakeSecretTypesRequest
object
Request for listing possible secret values for Datalake.
1 property
1 required
ListDatalakeSecretTypesResponse
object
Response object for showing the secret types and descriptions.
1 property
1 required
SecretTypeResponse
object
Response object for showing the secret types and descriptions
2 properties
InstanceGroupRecipeRequest
object
Represents an instance group - recipe pair (by names) request.
2 properties
1 required
InstanceGroupRecipeResponse
object
Represents an instance group - recipe pair (by names) response.
2 properties
1 required
RecoverDatalakeRequest
object
Datalake recover request.
2 properties
1 required
RecoverDatalakeResponse
object
Datalake recover response.
1 property
SetCatalogRequest
object
The request object to set catalog for a DataLake.
2 properties
2 required
SetCatalogResponse
object
The response object to set catalog for a DataLake request.
SyncComponentVersionsFromCmRequest
object
Datalake sync CM component versions request.
1 property
1 required
SyncComponentVersionsFromCmResponse
object
Datalake sync CM component versions response.
1 property
RotatePrivateCertificatesRequest
object
Request object to rotate private certificates on datalake's hosts.
1 property
1 required
RotatePrivateCertificatesResponse
object
Response object to rotate private certificates on datalake's hosts.
1 property
RenewPublicCertificateRequest
object
Request object to renew the public certificate for Datalake.
1 property
1 required
RenewPublicCertificateResponse
object
Response object for renew public certificate request.
1 property
SdxInstanceGroupRequest
object
Request object for host group level custom configurations.
2 properties
1 required
RotateSaltPasswordRequest
object
Request object for rotating SaltStack user password on DataLake instances (Deprecated).
1 property
1 required
RotateSaltPasswordResponse
object
Response object for rotating SaltStack user password on DataLake instances (Deprecated).
1 property
UpdateOrchestratorStateRequest
object
Request object for running orchestrator engine state update on the Data Lake cluster.
1 property
1 required
UpdateOrchestratorStateResponse
object
Response object for running orchestrator engine state update on the Data Lake cluster.
1 property
UpdateToAwsImdsV2Request
object
Request object for updating Data Lake to use AWS IMDSv2.
1 property
1 required
UpdateToAwsImdsV2Response
object
Response object for updating Data Lake to AWS IMDSv2.
1 property
UpdateToAwsImdsV1Request
object
Request object for updating Data Lake to use AWS IMDSv1.
1 property
1 required
UpdateToAwsImdsV1Response
object
Response object for updating Data Lake to AWS IMDSv1.
1 property
CustomInstanceType
object
Request object for modified instance type.
2 properties
CustomInstanceDisk
object
Request object for modified instance disk.
2 properties
CustomDatabaseComputeStorage
object
Request object for modified database storage properties.
2 properties
SetDefaultJavaVersionRequest
object
Request object for setting the default Java version on the Data Lake cluster.
3 properties
2 required
SetDefaultJavaVersionResponse
object
Response object for setting the default Java version on the Data Lake cluster.
1 property
MigrateSkusRequest
object
Request object for migrating SKUs.
2 properties
1 required
MigrateSkusResponse
object
Response object for migrating SKUs.
1 property
UpdatePublicDnsEntriesRequest
object
Request object for updating public DNS entries.
1 property
1 required
UpdatePublicDnsEntriesResponse
object
Response object for updating public DNS entries.
1 property
CertificateExpirationState
string
Indicates the certificate expiration status on the cluster.
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 Data Engineering API
Cloudera DataFlow API
Cloudera DataFlow Workload API
Cloudera Control Plane Data Recovery API
Cloudera Data Warehouse API
Cloudera Environments API
#Data Lake#Backup#Governance
Where this information came from
This is an independent, third-party profile of Cloudera Datalake 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.