Cloudera Data Hub API
Create, scale, stop, start and delete Data Hub workload clusters on AWS, Azure, GCP and AWS GovCloud, plus the cluster templates, definitions and recipes they are built from. 75 operations.
Cloudera Data Hub 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 Hub, Clusters, and Workloads. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 75 operations across 75 paths, and defines 217 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.
75 operations
75 paths
217 schemas
75 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 75
Across 75 paths, the API surfaces 75 operations — 75 POST. Each is listed below with its method, path, parameters, and response codes.
Operations 75
POST
/api/v1/datahub/deleteInstances
Deletes instances for the specified cluster.
POST
/api/v1/datahub/listClusters
Lists workload clusters.
POST
/api/v1/datahub/listScalingActivities
Lists Scaling activities for a cluster.
POST
/api/v1/datahub/describeScalingActivity
Describes the Scaling Activity using Cluster CRN or Cluster NAME and operation ID.
POST
/api/v1/datahub/listClusterLifecycleEvents
Lists Workload cluster lifecycle events.
POST
/api/v1/datahub/createAWSCluster
Creates an AWS workload cluster.
POST
/api/v1/datahub/createAWSGovCloudCluster
Creates an AWS Data Hub cluster for GovCloud.
POST
/api/v1/datahub/createAzureCluster
Creates an Azure workload cluster.
POST
/api/v1/datahub/createGCPCluster
Creates a GCP workload cluster.
POST
/api/v1/datahub/deleteCluster
Deletes a workload cluster.
POST
/api/v1/datahub/describeCluster
Describes a workload cluster.
POST
/api/v1/datahub/getClusterServiceStatus
Get cluster service status.
POST
/api/v1/datahub/getClusterHostStatus
Get cluster host status.
POST
/api/v1/datahub/stopCluster
Stops a workload cluster.
POST
/api/v1/datahub/startCluster
Starts a stopped workload cluster.
POST
/api/v1/datahub/retryCluster
Retries creation of a failed workload cluster.
POST
/api/v1/datahub/renewCertificate
Renew certificate on datahub cluster by name or CRN
POST
/api/v1/datahub/renewPublicCertificate
Renews public certificate on a Datahub cluster by name or CRN.
POST
/api/v1/datahub/repairCluster
Repairs a cluster.
POST
/api/v1/datahub/restartClusterInstances
Restarts instances of a cluster on Cloud provider.
POST
/api/v1/datahub/rotateDbCertificate
Rotates database ssl certificate for a specific Data Hub
POST
/api/v1/datahub/syncCluster
Synchronizes the state of a cluster with the cloud provider and Cloudera Manager.
POST
/api/v1/datahub/scaleCluster
Scales a cluster by adding or removing cluster nodes.
POST
/api/v1/datahub/listRecipes
Lists recipes. A recipe is a script that runs on all nodes of a specified instance group.
POST
/api/v1/datahub/deleteRecipes
Deletes recipes. A recipe is a script that runs on all nodes of a specified instance group.
POST
/api/v1/datahub/createRecipe
Creates recipe. A recipe is a script that runs on all nodes of a specified instance group.
POST
/api/v1/datahub/describeRecipe
Describes recipe. A recipe is a script that runs on all nodes of a specified instance group.
POST
/api/v1/datahub/replaceRecipes
Replaces recipes for the given instance groups.
POST
/api/v1/datahub/listClusterDefinitions
Lists cluster definitions. A cluster definition is a reusable template in JSON format that can be used for creating multiple Data Hub clusters with identical cloud provider settings.
POST
/api/v1/datahub/deleteClusterDefinitions
Deletes cluster definitions. A cluster definition is a reusable template in JSON format that can be used for creating multiple Data Hub clusters with identical cloud provider settings.
POST
/api/v1/datahub/createClusterDefinition
Creates a cluster definition. A cluster definition is a reusable template in JSON format that can be used for creating multiple Data Hub clusters with identical cloud provider settings.
POST
/api/v1/datahub/describeClusterDefinition
Describes a cluster definition. A cluster definition is a reusable template in JSON format that can be used for creating multiple Data Hub clusters with identical cloud provider settings.
POST
/api/v1/datahub/listClusterTemplates
Lists cluster templates. A cluster template is a reusable template in JSON format that can be used for creating multiple Data Hub clusters with identical Cloudera Runtime settings.
POST
/api/v1/datahub/deleteClusterTemplates
Deletes cluster templates. A cluster template is a reusable template in JSON format that can be used for creating multiple Data Hub clusters with identical Cloudera Runtime settings.
POST
/api/v1/datahub/createClusterTemplate
Creates a cluster template. A cluster template is a reusable template in JSON format that can be used for creating multiple Data Hub clusters with identical Cloudera Runtime settings.
POST
/api/v1/datahub/describeClusterTemplate
Describes a cluster template. A cluster template is a reusable template in JSON format that can be used for creating multiple Data Hub clusters with identical Cloudera Runtime settings.
POST
/api/v1/datahub/createCustomConfigurations
Creates custom configurations. Custom Configurations are sets of properties or name-value pairs that belong to any of the services present in cluster templates. These can be used to override and/or a…
POST
/api/v1/datahub/deleteCustomConfigurations
Deletes custom configurations. Custom Configurations are sets of properties or name-value pairs that belong to any of the services present in cluster templates. These can be used to override and/or a…
POST
/api/v1/datahub/describeCustomConfigurations
Describes custom configurations. Custom Configurations are sets of properties or name-value pairs that belong to any of the services present in cluster templates. These can be used to override and/or…
POST
/api/v1/datahub/listCustomConfigurations
Lists custom configurations. Custom Configurations are sets of properties or name-value pairs that belong to any of the services present in cluster templates. These can be used to override and/or app…
POST
/api/v1/datahub/migrateZookeeperToKraft
Migrate from Zookeeper to KRaft broker.
POST
/api/v1/datahub/finalizeZookeeperToKraftMigration
Finalize the migration from Zookeeper to KRaft broker.
POST
/api/v1/datahub/rollbackZookeeperToKraftMigration
Rollback the migration from Zookeeper to KRaft broker.
POST
/api/v1/datahub/createAutoScaleRules
Create Auto Scaling rules for a DataHub cluster
POST
/api/v1/datahub/updateAutoScaleRules
Modify AutoScaling for a DataHub cluster
POST
/api/v1/datahub/describeAutoScaleRules
Describe the AutoScaling policies for a DataHub cluster
POST
/api/v1/datahub/deleteAutoScaleRules
Delete AutoScaling policies for a DataHub cluster
POST
/api/v1/datahub/listAutoScaleHistory
List AutoScale history activity for a DataHub cluster.
POST
/api/v1/datahub/getDatahubLogDescriptors
Gather log descriptors that are used for diagnostics collection.
POST
/api/v1/datahub/collectDatahubDiagnostics
Start DataHub diagnostics collection
POST
/api/v1/datahub/listDatahubDiagnostics
List recent Datahub diagnostics collections
POST
/api/v1/datahub/cancelDatahubDiagnostics
Cancel running Datahub diagnostics collections
POST
/api/v1/datahub/collectCmDiagnostics
Start Datahub Cloudera Manager based diagnostics collection
POST
/api/v1/datahub/getCmRoles
Gather Cloudera Manager roles that can be used for filtering in CM based diagnostics collection.
POST
/api/v1/datahub/rotateSecrets
Rotates secrets for a specific datahub
POST
/api/v1/datahub/listDatahubSecretTypes
Lists all Datahub related secret types.
POST
/api/v1/datahub/rotateAutoTlsCertificates
Rotate autotls certificates on the datahub's hosts
POST
/api/v1/datahub/rotatePrivateCertificates
Rotates private certificates on the hosts of Datahub.
POST
/api/v1/datahub/upgradeCluster
Upgrades the OS or data platform on a datahub cluster.
POST
/api/v1/datahub/startClusterVerticalScaling
Initiates the vertical scaling on Data Hub cluster.
POST
/api/v1/datahub/prepareClusterUpgrade
Running upgrade related validations and prepares the required parcels for the upgrade.
POST
/api/v1/datahub/startDatabaseUpgrade
Upgrades the database of the Data Hub cluster.
POST
/api/v1/datahub/setCatalog
Sets a catalog for a DataHub.
POST
/api/v1/datahub/syncComponentVersionsFromCm
Syncs component versions from CM after a failed upgrade.
POST
/api/v1/datahub/getOperation
Get the latest (in progress or finished) operation for the datahub cluster.
POST
/api/v1/datahub/getVmTypes
Creates a recommendation that advises virtual machine types for the given cluster template based on the given properties.
POST
/api/v1/datahub/startInstances
Starts instances of a particular host group in the Data Hub cluster.
POST
/api/v1/datahub/stopInstances
Stops instances of particular host group in the Data Hub cluster.
POST
/api/v1/datahub/rotateSaltPassword
Rotate SaltStack user password on Data Hub instances.
POST
/api/v1/datahub/updateOrchestratorState
Run orchestrator engine state update on the Data Hub cluster.
POST
/api/v1/datahub/updateToAwsImdsV2
Updates Data Hub AWS cluster to use IMDSv2.
POST
/api/v1/datahub/updateToAwsImdsV1
Updates Data Hub AWS cluster to use IMDSv1.
POST
/api/v1/datahub/setDefaultJavaVersion
Configures the default Java version for the Data Hub.
POST
/api/v1/datahub/migrateSkus
Migrate Data Hub cluster SKUs.
POST
/api/v1/datahub/updatePublicDnsEntries
Update public DNS entries of a Data Hub cluster by name or CRN.
Schemas 217
The contract defines 217 schemas that model the data the API accepts and returns. The most detailed are ClusterLdapDetails (22 properties), ClusterLifecycleEvents (22 properties), CreateAWSClusterRequest (20 properties), CreateAzureClusterRequest (18 properties). Each schema is shown below with its type and property counts.
Error
object
An object returned on an error.
2 properties
ImageRequest
object
The details of the image used for cluster instances.
3 properties
ImageDetails
object
The details of the image used for cluster instances.
5 properties
Cluster
object
Information about a cluster.
18 properties
2 required
ClusterExtension
object
Cluster extensions for Data Hub cluster.
1 property
ClouderaManagerDetails
object
Cloudera Manager details.
2 properties
1 required
InstanceGroup
object
The type of the instance group which also contains the actual instance(s)
5 properties
2 required
StartClusterVerticalScalingRequest
object
The request object for Data Hub vertical scaling.
4 properties
2 required
StartClusterVerticalScalingResponse
object
The response object for Data Hub cluster vertical scaling.
2 properties
InstanceTemplate
object
Instance template configuration(s).
1 property
DiskOptions
object
Attached disk configuration(s).
3 properties
AddDisks
object
Attached volume configuration.
4 properties
4 required
ModifyDisks
object
Root or additional volume properties to modify.
3 properties
1 required
Instance
object
Object which holds some details of an instance for the given cluster.
16 properties
3 required
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
ScalingActivitySummary
object
Information about a Scaling activity.
5 properties
5 required
ClusterSummary
object
Information about a cluster.
12 properties
2 required
Recipe
object
Information about a recipe.
6 properties
2 required
RecipeSummary
object
Information about a recipe.
4 properties
2 required
ClusterDefinition
object
Information about a cluster definition.
7 properties
2 required
ClusterDefinitionSummary
object
Information about a cluster definition.
8 properties
2 required
ClusterTemplate
object
Information about a cluster template.
7 properties
2 required
ClusterTemplateSummary
object
Information about a cluster template.
7 properties
2 required
CustomConfigurations
object
Information about custom configurations.
5 properties
3 required
CustomConfigurationProperty
object
Information about Custom Configuration Property.
4 properties
3 required
DeleteInstancesRequest
object
Request object for deleting multiple instance from a cluster
3 properties
2 required
DeleteInstancesResponse
object
Response object for instance deletion.
2 properties
1 required
ListClusterLifecycleEventsRequest
object
Request object for listing cluster events.
3 properties
1 required
ListClusterLifecycleEventsResponse
object
Response object for fetching cluster events request.
2 properties
1 required
ClusterLifecycleEvents
object
Related events for the stack.
22 properties
StackStatus
string
Status of the stack.
ClusterLdapDetails
object
Details of the LDAP attached to cluster.
22 properties
ClusterRdsDetails
object
Details of the RDS attached to cluster.
17 properties
ListClustersRequest
object
Request object for list clusters request.
1 property
ListClustersResponse
object
Response object for list clusters request.
1 property
1 required
ListScalingActivitiesRequest
object
Request object for List scaling Activities request.
7 properties
1 required
ListScalingActivitiesResponse
object
Response object for list scaling activities request.
2 properties
1 required
DescribeScalingActivityRequest
object
Request object for describing a particular scaling activity using clusterCrn or clusterName and operationId.
2 properties
2 required
DescribeScalingActivityResponse
object
Response object for describe scaling activity request.
1 property
1 required
AttachedVolumeRequest
object
Configurations for additional attached volumes.
3 properties
3 required
VolumeEncryptionRequest
object
Configurations for volume encryption.
2 properties
InstanceGroupRequest
object
Configurations for instance group
10 properties
5 required
AzureInstanceGroupRequest
object
Configurations for instance group
9 properties
6 required
GCPInstanceGroupRequest
object
Configurations for instance group
9 properties
6 required
DatahubDatabaseType
string
Database type for datahub. Currently supported values: NONE, NONHA, HA
DatahubLoadBalancerSkuType
string
Represents the Azure load balancer SKU type. The current default is BASIC. To disable the load balancer, use type NONE.
CreateAWSClusterRequest
object
Request object for create AWS cluster request.
20 properties
CreateAWSClusterResponse
object
Response object for create AWS cluster request.
2 properties
1 required
CreateAWSGovCloudClusterRequest
object
Request object for creating AWS Data Hub cluster request on GovCloud.
15 properties
CreateAWSGovCloudClusterResponse
object
Response object for create AWS cluster request on GovCloud.
2 properties
1 required
CreateAzureClusterRequest
object
Request object for create Azure cluster request.
18 properties
CreateAzureClusterResponse
object
Response object for create Azure cluster request.
2 properties
1 required
CreateGCPClusterRequest
object
Request object for create GCP cluster request.
14 properties
CreateGCPClusterResponse
object
Response object for create GCP cluster request.
2 properties
1 required
DeleteClusterRequest
object
Request object for delete cluster request.
2 properties
1 required
DeleteClusterResponse
object
Response object for delete cluster request.
1 property
DescribeClusterRequest
object
Request object for describe cluster request.
1 property
1 required
DescribeClusterResponse
object
Response object for describe cluster request.
1 property
1 required
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
RotateDbCertificateRequest
object
Request object to rotate ssl certificate a datahub.
1 property
1 required
RotateDbCertificateResponse
object
Response object to rotate ssl certificate a datahub.
1 property
RepairInstancesRequest
object
Details for repair instances.
2 properties
StartClusterRequest
object
Request object for start cluster request.
1 property
1 required
StartClusterResponse
object
Response object for start cluster request.
1 property
StopClusterRequest
object
Request object for stop cluster request.
1 property
1 required
StopClusterResponse
object
Response object for stop cluster request.
1 property
RetryClusterRequest
object
Request object for retry cluster request.
1 property
1 required
RetryClusterResponse
object
Response object for retry cluster request.
RenewCertificateRequest
object
Request object for renew datahub certificate request, deprecated.
1 property
1 required
RepairClusterRequest
object
Request object for repair cluster request.
4 properties
1 required
RepairClusterResponse
object
Response object for repair cluster request.
1 property
RestartClusterInstancesRequest
object
Request object for restart cluster instances request.
2 properties
2 required
RestartClusterInstancesResponse
object
Response object for restart cluster instances request.
1 property
SyncClusterRequest
object
Request object for sync cluster request.
1 property
1 required
SyncClusterResponse
object
Response object for sync cluster request.
ScaleClusterRequest
object
Request object for scale cluster request.
5 properties
3 required
ScaleClusterResponse
object
Response object for scale cluster request.
1 property
CreateRecipeRequest
object
Request object for create recipe request.
4 properties
3 required
CreateRecipeResponse
object
Response object for create recipe request.
1 property
1 required
DeleteRecipesRequest
object
Request object for delete recipe request.
1 property
1 required
DeleteRecipesResponse
object
Response object for delete recipe request.
1 property
1 required
DescribeRecipeRequest
object
Request object for describe recipe request.
1 property
1 required
DescribeRecipeResponse
object
Response object for describe recipe request.
1 property
1 required
ListRecipesRequest
object
Request object for list recipes request.
ListRecipesResponse
object
Response object for list recipes request.
1 property
1 required
ReplaceRecipesRequest
object
The request for replacing recipes.
2 properties
2 required
ReplaceRecipesResponse
object
The response for replacing recipes.
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
CreateClusterDefinitionRequest
object
Request object for create cluster definition request.
3 properties
2 required
CreateClusterDefinitionResponse
object
Response object for create cluster definition request.
1 property
1 required
DeleteClusterDefinitionsRequest
object
Request object for delete cluster definition request.
1 property
1 required
DeleteClusterDefinitionsResponse
object
Response object for delete cluster definition request.
1 property
1 required
DescribeClusterDefinitionRequest
object
Request object for describe cluster definition request.
1 property
1 required
DescribeClusterDefinitionResponse
object
Response object for describe cluster definition response.
1 property
1 required
ListClusterDefinitionsRequest
object
Request object for list cluster definitions request.
ListClusterDefinitionsResponse
object
Response object for list cluster definition response.
1 property
1 required
CreateClusterTemplateRequest
object
Request object for create cluster template request.
4 properties
2 required
CreateClusterTemplateResponse
object
Response object for create cluster template request.
1 property
1 required
DeleteClusterTemplatesRequest
object
Request object for delete cluster templates request.
1 property
1 required
DeleteClusterTemplatesResponse
object
Response object for delete cluster templates request.
1 property
1 required
DescribeClusterTemplateRequest
object
Request object for describe cluster template request.
1 property
1 required
DescribeClusterTemplateResponse
object
Response object for describe cluster template request.
1 property
1 required
ListClusterTemplatesRequest
object
Request object for list cluster templates request.
ListClusterTemplatesResponse
object
Response object for list cluster templates request.
1 property
1 required
CreateCustomConfigurationsRequest
object
The request object for creating custom configurations request.
3 properties
2 required
CreateCustomConfigurationsResponse
object
The response object for create custom configurations request.
1 property
1 required
CustomConfigurationPropertyRequest
object
The request object for the custom configuration property request.
4 properties
3 required
DeleteCustomConfigurationsRequest
object
The request object for the delete custom configurations request.
1 property
1 required
DeleteCustomConfigurationsResponse
object
The response object for the delete custom configurations request.
1 property
1 required
DescribeCustomConfigurationsRequest
object
The request object for the describe custom configurations request.
1 property
1 required
DescribeCustomConfigurationsResponse
object
The response object for the describe custom configurations request.
1 property
1 required
ListCustomConfigurationsRequest
object
The request object for the list custom configurations request.
2 properties
ListCustomConfigurationsResponse
object
The response object for the list custom configurations request.
2 properties
1 required
MigrateZookeeperToKraftRequest
object
Request object to migrate Zookeeper to KRaft.
1 property
1 required
MigrateZookeeperToKraftResponse
object
Response object to migrate Zookeeper to KRaft.
2 properties
FinalizeZookeeperToKraftMigrationRequest
object
Request object to finalize the migration of Zookeeper to KRaft.
1 property
1 required
FinalizeZookeeperToKraftMigrationResponse
object
Response object to finalization of the Zookeeper to KRaft migration.
2 properties
RollbackZookeeperToKraftMigrationRequest
object
Request object to rollback the migration from Zookeeper to KRaft broker.
1 property
1 required
RollbackZookeeperToKraftMigrationResponse
object
Response object to rollback the migration from Zookeeper to KRaft broker.
2 properties
DatahubResourceTagRequest
object
Tag for a datahub resource.
2 properties
2 required
GCPDatahubResourceTagRequest
object
A label that can be attached to GCP Data Hub resources. Please refer to Google documentation for the rules https://cloud.google.com/compute/docs/labeling-resou…
2 properties
2 required
DatahubResourceTag
object
Tag for a datahub resource.
2 properties
2 required
AutoScaleRulesResponse
object
Autoscale configuration
3 properties
3 required
CreateAutoScaleRulesRequest
object
Autoscale configuration request
3 properties
2 required
CreateAutoScaleRulesResponse
object
The AutoScale rules for the cluster.
1 property
UpdateAutoScaleRulesRequest
object
Autoscale Modification request
3 properties
1 required
UpdateAutoScaleRulesResponse
object
The AutoScale rules for the cluster.
1 property
DescribeAutoScaleRulesRequest
object
Request object to describe the AutoScale rules for a DataHub cluster.
1 property
1 required
DescribeAutoScaleRulesResponse
object
The response object which describes the AutoScale rules for a DataHub cluster.
1 property
DeleteAutoScaleRulesRequest
object
Delete request.
1 property
1 required
DeleteAutoScaleRulesResponse
object
Response object for DeleteAutoScalesRulesRequest
AutoScalePolicyRequest
object
An individual AutoScale Policy
3 properties
1 required
AutoScalePolicyResponse
object
An individual AutoScale Policy
3 properties
1 required
AutoScaleScheduleRequest
object
Schedule for AutoScaling
1 property
AutoScaleScheduleResponse
object
Schedule for AutoScaling
1 property
IndividualScheduleRequest
object
An individual schedule based policy
3 properties
1 required
IndividualScheduleResponse
object
An individual schedule based policy
3 properties
2 required
AutoScaleLoadRequest
object
Configuration for Load Based Scaling
3 properties
1 required
AutoScaleLoadResponse
object
Configuration for Load Based Scaling
3 properties
2 required
AutoScaleLoadRequestConfiguration
object
Configuration for load based scaling
3 properties
2 required
AutoScaleLoadResponseConfiguration
object
Configuration for load based scaling
3 properties
2 required
ListAutoScaleHistoryRequest
object
Request object to retrieve the AutoScale history for a DataHub cluster.
2 properties
1 required
ListAutoScaleHistoryResponse
object
The response object which describes the AutoScale rules for a DataHub cluster.
1 property
IndividualAutoScaleHistoryResponse
object
An object representing a single AutoScale history event for a DataHub cluster.
2 properties
DatahubVmLogRequest
object
Log descriptor, contains a path and label pair. Used for diagnostics collections.
2 properties
2 required
DatahubVmLogResponse
object
Log descriptor, contains a path and label pair. Used for diagnostics collections.
2 properties
CollectDatahubDiagnosticsRequest
object
Request object for collecting DataHub diagnostics.
17 properties
3 required
CollectDatahubDiagnosticsResponse
object
Response object for collecting DataHub diagnostics.
1 property
ListDatahubDiagnosticsRequest
object
Request object for listing recent Datahub diagnostics collections.
1 property
1 required
ListDatahubDiagnosticsResponse
object
Response object for listing recent Datahub diagnostics collections.
1 property
DatahubDiagnosticsCollectionResponse
object
Response object for diagnostic collection flow details.
6 properties
DatahubDiagnosticsCollectionDetailsResponse
object
Response object for diagnostic collection details.
7 properties
CancelDatahubDiagnosticsRequest
object
Request object for cancel running Datahub diagnostics collections.
1 property
1 required
CancelDatahubDiagnosticsResponse
object
Response object for cancel running Datahub diagnostics collections.
GetDatahubLogDescriptorsRequest
object
Request object for obtaining log descriptors. (that are used for diagnostics collection)
CollectCmDiagnosticsRequest
object
Request object for collecting Datahub diagnostics.
11 properties
2 required
CollectCmDiagnosticsResponse
object
Response object for collecting Datahub 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
GetDatahubLogDescriptorsResponse
object
Response object for obtaining log descriptors. (useful for diagnostics collection filtering)
1 property
GetVmTypesRequest
object
Request object for fetching the available virtual machine types based on the given parameters.
5 properties
3 required
GetVmTypesResponse
object
Response object from the VM type fetch operation.
2 properties
VmTypeResponseWithMetadata
object
Response object containing vm types and its metadata.
2 properties
GetOperationRequest
object
Request object for tracking the latest (current/last) operation on the datahub resource.
3 properties
GetOperationResponse
object
Response object for tracking the latest (current/last) operation on the datahub resource.
5 properties
RotateSecretsRequest
object
Request object for starting secret rotation for datahub.
2 properties
2 required
RotateSecretsResponse
object
Response object for rotating secrets.
1 property
ListDatahubSecretTypesRequest
object
Request for listing possible secret values for Datahub.
1 property
1 required
ListDatahubSecretTypesResponse
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
RotateAutoTlsCertificatesRequest
object
Request object to rotate autotls certificates on datahub's hosts, deprecated.
1 property
1 required
RotateAutoTlsCertificatesResponse
object
Response object to rotate autotls certificates on datahub's hosts, deprecated.
1 property
RenewCertificateResponse
object
Response object for renew certificate request, deprecated.
1 property
ImageComponentVersions
object
Versions of the image components.
4 properties
ImageInfo
object
Basic information about an image.
5 properties
UpgradeClusterRequest
object
Request object to upgrade datahub.
8 properties
1 required
UpgradeClusterResponse
object
Response object for upgrade datahub request.
4 properties
PrepareClusterUpgradeRequest
object
Request object to Data Hub upgrade preparation. This command indicates the upgrade preparation for a specific image or a selected runtime version. Important to…
3 properties
1 required
PrepareClusterUpgradeResponse
object
Response object for upgrade Data Hub request.
4 properties
StartDatabaseUpgradeRequest
object
Request object for Data Hub database upgrade.
3 properties
1 required
StartDatabaseUpgradeResponse
object
Response object to Data Hub database upgrade.
2 properties
SetCatalogRequest
object
The request object to set catalog for a DataHub.
2 properties
2 required
SetCatalogResponse
object
The response object to set catalog for a DataHub request.
SyncComponentVersionsFromCmRequest
object
Datahub sync CM component versions request.
1 property
1 required
SyncComponentVersionsFromCmResponse
object
Datahub sync CM component versions response.
1 property
RotatePrivateCertificatesRequest
object
Request object to rotate private certificates on the hosts of Datahub.
1 property
1 required
RotatePrivateCertificatesResponse
object
Response object to rotate private certificates on the hosts of Datahub.
1 property
RenewPublicCertificateRequest
object
Request object for renewing the Datahub public certificate.
1 property
1 required
RenewPublicCertificateResponse
object
Response object for renew public certificate request.
1 property
StartInstancesRequest
object
Request object to start instances of a host group on a Data Hub.
3 properties
2 required
StartInstancesResponse
object
Response object to start instances of a host group on Data Hub.
1 property
StopInstancesRequest
object
Request object to stop instances of a host group on a Data Hub.
3 properties
2 required
StopInstancesResponse
object
Response object to a stop instances of a host group on a Data Hub.
1 property
RotateSaltPasswordRequest
object
Request object for rotating SaltStack user password on Data Hub instances (Deprecated).
1 property
1 required
RotateSaltPasswordResponse
object
Response object for rotating SaltStack user password on Data Hub instances (Deprecated).
1 property
UpdateOrchestratorStateRequest
object
Request object for running orchestrator engine state update on the Data Hub cluster.
1 property
1 required
UpdateOrchestratorStateResponse
object
Response object for running orchestrator engine state update on the Data Hub cluster.
1 property
UpdateToAwsImdsV2Request
object
Request object for updating Data Hub to use AWS IMDSv2.
1 property
1 required
UpdateToAwsImdsV2Response
object
Response object for updating Data Hub to AWS IMDSv2.
1 property
UpdateToAwsImdsV1Request
object
Request object for updating Data Hub to use AWS IMDSv1.
1 property
1 required
UpdateToAwsImdsV1Response
object
Response object for updating Data Hub to AWS IMDSv1.
1 property
SetDefaultJavaVersionRequest
object
Request object for setting the default Java version on the Data Hub cluster.
3 properties
2 required
SetDefaultJavaVersionResponse
object
Response object for setting the default Java version on the Data Hub 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 Datalake 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 Hub#Clusters#Workloads
Where this information came from
This is an independent, third-party profile of Cloudera Data Hub 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.