Cloudera Replication Manager API is one of 24 APIs that Cloudera publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Replication, Migration, and Disaster Recovery. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
24 operations
across 24 paths,
and defines 85 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.
The identity and technical contract details declared by the specification.
Error
object
An object returned on an error.
2 properties
ListClustersRequest
object
Request to list clusters.
ListClustersResponse
object
Response object for list clusters request.
2 properties
2 required
ListClusterServiceStatusesRequest
object
Request object to list cluster statuses.
ListClusterServiceStatusesResponse
object
Response object for listing of cluster statuses.
1 property
ListAllCredentialsRequest
object
Request object for listing all cloud credentials on all clusters.
ListAllCredentialsResponse
object
Response object for list credentials request.
2 properties
2 required
GetCredentialsRequest
object
Request object to retrieve specific cloud credentials.
3 properties
1 required
GetCredentialsResponse
object
Response for credential request.
1 property
DeleteCredentialRequest
object
Request object for deleting a credential.
1 property
1 required
DeleteCredentialResponse
object
Response object for delete credential operation.
1 property
CreateAwsCredentialRequest
object
Request object for creating AWS IAM or Access & Secret Key cloud credentials.
5 properties
3 required
CreateAwsCredentialResponse
object
Response object for creating AWS credentials.
1 property
CreateAbfsCredentialRequest
object
Request object for creating ABFS cloud credentials. Currently supported cloud credentials: ABFS Access Key for Ambari clusters, ABFS Client Secret for CM clust…
8 properties
3 required
CreateAbfsCredentialResponse
object
Response object for creating ABFS credentials.
1 property
GetClusterConfigRequest
object
Request object for getClusterConfig.
1 property
1 required
GetClusterConfigResponse
object
Response object for getClusterConfig.
6 properties
ServiceConfiguration
object
Configuration related to a service.
2 properties
HbaseSuspendType
string
Describes how suspend and resume affects HBase policies on the cluster. 'ALL' means that suspend/resume affects all HBase policies with the same source and des…
ListPoliciesRequest
object
Request object for listing all policies.
ListPoliciesResponse
object
Response object for a list policies request.
3 properties
3 required
DeletePolicyRequest
object
Delete a replication policy.
2 properties
2 required
DeletePolicyResponse
object
Response object for deletePolicy.
4 properties
CreatePolicyRequest
object
Create a replication policy.
3 properties
3 required
CreatePolicyResponse
object
Response object for createPolicy.
4 properties
CreateHbasePolicyRequest
object
Create an HBase replication policy.
3 properties
3 required
CreateHbasePolicyResponse
object
Response object for createHbasePolicy.
3 properties
UpdateHbasePolicyRequest
object
Update HBase replication policy request.
3 properties
3 required
UpdateHbasePolicyDefinition
object
HBase policy update request definition.
3 properties
UpdateHbasePolicyResponse
object
Response object for updateHbasePolicy.
4 properties
ContinueHbaseSetupRequest
object
Continue an HBase setup for Classic Cluster source.
2 properties
2 required
ContinueHbaseSetupResponse
object
Response object for continueHbaseSetup.
3 properties
ActivateHbasePolicyRequest
object
Activate an HBase replication policy.
2 properties
2 required
ActivateHbasePolicyResponse
object
Response object for activateHbasePolicy.
3 properties
SuspendHbasePolicyRequest
object
Suspend an HBase replication policy.
2 properties
2 required
SuspendHbasePolicyResponse
object
Response object for suspendHbasePolicy.
3 properties
DeleteHbasePolicyRequest
object
Request object to delete an HBase replication policy.
3 properties
2 required
DeleteHbasePolicyResponse
object
Response object for deleteHbasePolicy.
3 properties
ListPairedHbaseClustersRequest
object
Request to list all paired HBase cluster CRNs.
ListPairedHbaseClustersResponse
object
Response object for listPairedHbaseClusters.
3 properties
VerifyHbaseClusterPairRequest
object
Request to verify a cluster pairing for HBase policy creation prerequisites.
2 properties
2 required
VerifyHbaseClusterPairResponse
object
Response object for verifyHbaseClusterPair.
5 properties
SuspendPolicyRequest
object
Suspend a replication policy.
2 properties
2 required
SuspendPolicyResponse
object
Response object for suspendPolicy.
4 properties
ActivatePolicyRequest
object
Activate a replication policy.
2 properties
2 required
ActivatePolicyResponse
object
Response object for resumePolicy.
4 properties
DownloadDiagnosticBundleRequest
object
Request to download the diagnostic bundle for the given cluster and command id.
2 properties
2 required
DownloadDiagnosticBundleResponse
object
Response object for download-diagnostic-bundle. On certain clusters this response will show if the download is only available directly from CM.
1 property
CollectDiagnosticBundleRequest
object
Triggers a diagnostic bundle collect command for the given cluster and policyName.
2 properties
2 required
CollectDiagnosticBundleResponse
object
Response object for collect-diagnostic-bundle.
5 properties
1 required
GetCommandStatusRequest
object
Get the current status of any CM command.
2 properties
2 required
GetCommandStatusResponse
object
Response object for get command status.
10 properties
1 required
ApiError
object
API error.
5 properties
3 required
ClusterServiceStatuses
object
Describes the status of services running on a cluster.
2 properties
2 required
Cluster
object
Describes a Datalake, Datahub or Classic cluster.
20 properties
8 required
Location
object
Location object.
5 properties
5 required
CodProperties
object
Additional properties for operational databases.
1 property
CustomConfigs
object
Custom key/value configurations.
3 properties
3 required
CredentialsResponse
object
Response object for cloud credentials.
4 properties
4 required
CredentialCollection
object
Cloud Credentials listing.
3 properties
3 required
CredentialDetails
object
Cloud credential details for by-name or by-id cloud credential request.
8 properties
6 required
ServiceInfo
object
Service status definition.
2 properties
2 required
Policy
object
Replication policy definition.
22 properties
8 required
PolicyInstanceResponse
object
Policy execution details.
10 properties
4 required
PolicyReportDetails
object
Policy report details.
2 properties
2 required
PolicyReport
object
Policy report.
2 properties
TargetDetails
object
Target details.
2 properties
1 required
PolicyDefinition
object
Policy creation request definition.
21 properties
4 required
SourceDataset
object
Extra properties for the source dataset.
2 properties
HdfsArguments
object
Extra properties for HDFS.
9 properties
ErrorHandling
object
Error handling behavior.
4 properties
4 required
Preserve
object
Properties to preserve after replication.
4 properties
4 required
Alert
object
Cloudera Manager alerting behavior.
4 properties
4 required
HiveArguments
object
Hive replication arguments.
4 properties
HiveDatabaseAndTables
object
Hive replication scope.
3 properties
1 required
CmPolicySubmitUser
object
CM Policy submit user.
2 properties
HbasePolicyDefinition
object
HBase policy definition.
10 properties
4 required
HbasePolicyArguments
object
HBase replication parameters.
3 properties
HbaseDatabaseArguments
object
HBase database replication arguments.
1 property
MachineUser
object
Username and password for the machine user.
3 properties
3 required
HbaseCrnPairs
object
HBase CRN pairs.
1 property
VerificationSteps
object
Verification steps.
2 properties
AwsCloudCredentialType
string
AWS cloud credential type.
AbfsCloudCredentialType
string
ABFS cloud credential type.
RestartType
string
Type of restart for a cluster.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Cloudera publishes across the network.