Cloudera Replication Manager Service

clusterCrn
required

CRN of the destination cluster.

string

policyId
required

ID of the HBase policy.

string

clusterCrn
optional

The CRN of the input cluster.

string

message
optional

The detailed description of the action taken.

string

status
optional

The status of the request.

string

clusterCrn
required

CRN of the cluster where the policy is.

string

policyName
required

Policy name to resume.

string

clusterCrn
optional

The CRN of the input cluster.

string

message
optional

The detailed description of the action taken.

string

requestId
optional

The ID of the request. Populated only for Ambari backend.

string

status
optional

The status of the request.

string

onAbort
required

Alert on abort.

boolean

onFailure
required

Alert on failure.

boolean

onStart
required

Alert on start.

boolean

onSuccess
required

ALert on success.

boolean

clusterUrl
optional

Cluster URL.

string

code
required

Error code.

integer (int32)

message
required

Error message.

string

requestId
optional

Request ID.

string

status
required

Error status.

string

cloudAccountProvider
optional

Cloud account provider.

enum (AWS, ADLS, WASB, ABFS, GCS)

clusterManagerType
required

Cluster Manager type.

enum (CLOUDERA_MANAGER, AMBARI)

clusterManagerUrl
required

Cluster Manager URL.

string

clusterType
required

Cluster type.

enum (CLASSIC, SDX, DISTROX)

clusterUrl
required

Cluster URL.

string

cmName
optional

Cloudera Manager name.

string

codProperties
optional

Additional properties for operational databases.

CodProperties

crn
required

Cluster CRN.

string

dataCenter
required

Cluster data center.

string

description
optional

Cluster description.

string

environmentCrn
optional

CRN of the cluster’s environment.

string

knoxUrl
optional

Knox URL if the cluster was registered with one, null otherwise.

string

location
optional

Cluster location.

Location

name
required

Cluster name.

string

replicationEngineType
required

Replication engine type.

enum (CM, DLM_ENGINE)

stackCrn
optional

Stack CRN.

string

stackMajorVersion
optional

Stack major version.

string

stackVersion
optional

Stack version.

string

totalHosts
optional

Total hosts on the cluster.

integer (int32)

uuid
optional

Cluster UUID from Cloudera Manager if the cluster has CM backend.

string

clusterCrn
required

Cluster CRN.

string

serviceStatuses
required

List of service statuses.

< ServiceInfo > array

sourceUser
optional

Source user.

string

userName
optional

Username.

string

operationalDatabaseName
optional

Name of the corresponding operational database..

string

clusterCrn
required

The CRN of the target cluster.

string

policyName
required

Name of the policy.

string

active
optional

Whether the diagnostic bundle command is active.

boolean

commandId
required

ID of the diagnostic bundle collection command issued against the CM. Polling get-command-status with this command id returns the current state of the command.

integer (int64)

name
optional

Name of the policy.

string

resultMessage
optional

Diagnostic bundle collection command result message.

string

startTime
optional

Start time of the diagnostic bundle collection command.

string

clusterCrn
required

The CRN of the destination cluster.

string

policyId
required

The ID of the HBase policy.

string

clusterCrn
optional

The CRN of the input cluster.

string

message
optional

The detailed description of the action taken.

string

status
optional

The status of the request.

string

accessKey
optional

ABFS access key.

string

clientId
optional

Client ID of an Active Directory service principal account.

string

clientSecretKey
optional

Client Key of an Active Directory service principal account.

string

clusters
required

List of cluster CRNs where the credential should be created.

< string > array

name
required

Name of the credential.

string

storageAccountName
optional

ABFS storage account name.

string

tenantId
optional

Tenant ID of an Active Directory service principal account.

string

type
required

Type of the credential. Additional required parameters by type: ACCESSKEY: storageAccountName, accessKey; CLIENTKEY: clientId, clientSecretKey, tenantId. Superfluous parameters are ignored. Providing ACCESSKEY will create an ABFS Access Key based account in Ambari. Providing CLIENTKEY will create an Azure Active Directory Service Principal account in Cloudera Manager. ACCESSKEY is only supported on Ambari, while CLIENTKEY is only supported on Cloudera Manager.

AbfsCloudCredentialType

errors
optional

The list of response errors in case of a partial failure while creating the credential.

< ApiError > array

accessKey
optional

AWS access key.

string

clusters
required

List of cluster CRNs where the credential should be created.

< string > array

name
required

Name of the credential.

string

secretKey
optional

AWS secret key.

string

type
required

Type of the credential. Additional required parameters by type: IAM: none; ACCESSKEY: accessKey, secretKey. Superfluous parameters are ignored. Providing IAM will create an IAM Role-based Authentication account in Cloudera Manager. Providing ACCESSKEY will create an AWS Access Key Authentication account in Cloudera Manager.

AwsCloudCredentialType

errors
optional

The list of response errors in case of a partial failure while creating the credential.

< ApiError > array

clusterCrn
required

CRN of the destination cluster.

string

policyDefinition
required

Policy definition.

HbasePolicyDefinition

policyName
required

Name of the new policy.

string

clusterCrn
optional

The CRN of the input cluster.

string

message
optional

The detailed description of the action taken.

string

status
optional

The status of the request.

string

clusterCrn
required

CRN of the cluster where the policy will be created.

string

policyDefinition
required

Policy definition.

PolicyDefinition

policyName
required

Name of the new policy.

string

clusterCrn
optional

The CRN of the input cluster.

string

message
optional

The detailed description of the action taken.

string

requestId
optional

The ID of the request. Populated only for Ambari backend.

string

status
optional

The status of the request.

string

credentials
required

Cloud credential details.

< CredentialDetails > array

results
required

Number of cloud credentials in the response.

integer (int64)

totalResults
required

Total number cloud credentials.

integer (int64)

authType
required

Authentication type.

string

configs
optional

Configurations.

< string, string > map

creationTime
required

Creation time.

string (date-time)

customConfigs
optional

Custom configurations.

< CustomConfigs > array

id
required

Credential id.

string

lastModifiedTime
required

Last modified time.

string (date-time)

name
required

Credential name.

string

provider
required

Credential provider.

string

clusterCrn
required

Cluster CRN.

string

clusterUrl
required

Cluster URL.

string

credentials
required

Cloud credentials.

CredentialCollection

replicationEngineType
required

Replication engine type.

enum (CM, DLMENGINE)

confidential
required

Whether the value is confidential.

boolean

name
required

Name.

string

value
required

Value.

string

name
required

Name of the cloud credential to delete.

string

errors
optional

The list of response errors in case of a partial failure while deleting the credential.

< ApiError > array

clusterCrn
required

CRN of the destination cluster.

string

force
optional

Option to force delete an Hbase policy. It should be used if the normal delete fails (e.g. when the source cluster is unreachable).

boolean

policyId
required

ID of the HBase policy.

string

clusterCrn
optional

The CRN of the input cluster.

string

message
optional

The detailed description of the action taken.

string

status
optional

The status of the request.

string

clusterCrn
required

CRN of the cluster where the policy is.

string

policyName
required

Policy name to delete.

string

clusterCrn
optional

The CRN of the input cluster.

string

message
optional

The detailed description of the action taken.

string

requestId
optional

The ID of the request. Populated only for Ambari backend.

string

status
optional

The status of the request.

string

clusterCrn
required

The CRN of the target cluster.

string

commandId
required

The command ID from the response of collect-diagnostic-bundle command.

string

bundleFile
optional

Base64 encoded content of the diagnostic bundle zip file. A script like this can be used to save the response as file 'cat response.json | jq -r '.bundleFile' | base64 -D > bundle.zip'
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"

string (byte)

code
optional

The error code.

string

message
optional

The error message.

string

abortOnError
required

Abort policy on error.

boolean

abortOnSnapshotDiffFailures
required

Abort policy if there are snapshot diff failures.

boolean

skipChecksumChecks
required

Skip checksum checks.

boolean

skipListingChecksumChecks
required

Skip checksum checks for copy-listing.

boolean

clusterCrn
required

The CRN of the cluster.

string

clusterCrn
optional

The CRN of the cluster.

string

cmApiVersion
optional

Cloudera Manager API version.

integer (int32)

dmx
optional

Configuration related to DMX.

dmx

featureSupport
optional

A map of available features and whether they are supported on the cluster.

< string, boolean > map

services
optional

A list of service configurations.

< ServiceConfiguration > array

underlyingFsForHive
optional

Underlying file system for Hive.

enum (HDFS, S3, WASB, ABFS, GCS)

hbaseSuspend
optional

Suspend type for HBase policies.

HbaseSuspendType

clusterCrn
required

The CRN of the target cluster.

string

commandId
required

ID of a CM command on the cluster.

string

active
optional

Whether the command is still active.

boolean

bundleStatus
optional

The current status of the command.

enum (IN_PROGRESS, DOWNLOADABLE_WITH_URL, DOWNLOADABLE_WITH_CLI, FAILED)

bundleStatusMessage
optional

Further information about the current command status.

string

commandId
required

Id of the CM command.

integer (int64)

endTime
optional

End time of the CM command.

string

name
optional

Name of the policy.

string

resultDataUrl
optional

Some commands have result data URL for downloading the diagnostic bundle. On certain CM versions the bundle download is only available through this URL, but not with download-diagnostic-bundle operation.

string

resultMessage
optional

Result message of the command.

string

startTime
optional

Start time of the CM command.

string

success
optional

Whether the diagnostic collection is successful.

boolean

clusterCrn
required

CRN of the cluster where the credential is.

string

credentialId
optional

Id of the credential. If both name and Id are specified, the Id is considered.

string

credentialName
optional

Name of the credential. If both name and Id are specified, the Id is considered.

string

credentials
optional

List of credentials.

< CredentialDetails > array

pairedCrns
optional

The list of CRNs which are peers of each other.

< string > array

replicationStrategy
optional

Whether to replicate all tables or only the ones where the replication scope has been set. Defaults to ALL_TABLES.

enum (ALL_TABLES, TABLES_WITH_REPLICATION_SCOPE_SET)

cloudCredential
optional

Cloud credentials to use to replicate the initial snapshot if the credential location is specified as 'EXTERNAL_ACCOUNT'.

string

databaseArguments
optional

Optional parameters used for HBase database replication.

HbaseDatabaseArguments

tables
optional

List of tables to be replicated. The key should be in "namespace:tablename" format. If this list is empty, then the whole database will be replicated.

< string > array

description
optional

Description of the policy.

string

distcpMaxMaps
optional

Maximum Map jobs to use for initial snapshot.

integer (int64)

hbasePolicyArguments
required

HBase policy arguments.

HbasePolicyArguments

initialSnapshot
required

If set to true, the current data in the table will be replicated before the HBase replication peer gets enabled. If set to false, only the data changed after the policy creation will be replicated.

boolean

machineUser
optional

Machine user details to use for the replication. If not specified, an internal machine user will be created and synchronized to the required environments.

MachineUser

queueName
optional

YARN queue name to use for initial snapshot if not default.

string

sourceCluster
required

Name of source cluster in the format: "dataCenterName$cluster name", for example "DC-Europe$My Source 42."

string

sourceRestartType
optional

Type of restart for the source cluster. This is only accepted if the source is not a Classic Cluster and the destination has restart-type support. Default is ROLLING_RESTART.

RestartType

targetCluster
required

Name of destination cluster in the format: "dataCenterName$cluster name", for example "DC-US$My Destination 17".

string

targetRestartType
optional

Type of restart for the destination cluster. This is only accepted if the cluster has restart-type support. Default is ROLLING_RESTART.

RestartType

alert
optional

Alerting behavior.

Alert

deletePolicy
optional

Deletion behavior.

enum (KEEP_DELETED_FILES, DELETE_TO_TRASH, DELETE_PERMANENTLY)

errorHandling
optional

Error handling strategy.

ErrorHandling

exclusionFilters
optional

Exclusion filters in glob format.

< string > array

logPath
optional

Job log path.

string

mapReduceService
optional

Name of the mapreduce service.

string

path
optional

HDFS path. Mandatory for HDFS policies, otherwise optional.

string

preserve
optional

Properties to preserve.

Preserve

replicationStrategy
optional

Replication strategy.

enum (DYNAMIC, STATIC)

databasesAndTables
optional

Scope of the replication.

< HiveDatabaseAndTables > array

numThreads
optional

Number of threads to use during replication.

integer (int64)

sentryPermissions
optional

Include or exclude Sentry permissions.

enum (INCLUDE, EXCLUDE)

skipUrlPermissions
optional

Skip URL permissions.

boolean

database
required

Database to replicate.

string

tablesExcludeRegex
optional

Regex to match excluded tables.

string

tablesIncludeRegex
optional

Regex to match included tables.

string

credentials
required

List of credentials by cluster.

< CredentialsResponse > array

unreachableClusters
required

List of errors for unreachable clusters.

< ApiError > array

statuses
optional

List of statuses by cluster.

< ClusterServiceStatuses > array

clusters
required

List of clusters.

< Cluster > array

unreachableClusters
required

List of errors for unreachable clusters.

< ApiError > array

crnsMissingHbaseService
optional

Cluster CRNs where the HBase service was missing and pairing status could not be determined.

< string > array

pairings
optional

The list of CRN pairings.

< HbaseCrnPairs > array

unreachableClusters
optional

The list of errors for unreachable clusters.

< ApiError > array

policies
required

List of policies.

< Policy > array

policyErrors
required

List of policy errors.

< ApiError > array

unreachableClusters
required

List of errors for unreachable clusters.

< ApiError > array

city
required

City.

string

country
required

Country.

string

id
required

Location ID.

integer (int64)

latitude
required

Latitude.

number (double)

longitude
required

Longitude.

number (double)

createUser
required

This option has no effect if the machine user already exists. Otherwise if 'true', a new machine user is created. If 'false', an error is returned indicating that the user does not exist.

boolean

password
required

Password.

string

user
required

Username.

string

creationTime
optional

Policy creation time.

string (date-time)

customProperties
optional

Custom replication properties.

< string, string > map

description
optional

Policy description.

string

endTime
required

End time of policy run or when it repeats.

string (date-time)

executionType
optional

Policy execution type.

string

frequency
required

Frequency in seconds when the policy runs.

integer (int64)

jobs
required

List of policy runs.

< PolicyInstanceResponse > array

name
required

Policy name.

string

nextRun
optional

Next expected run of the policy.

string

plugins
optional

Plugins.

< string > array

policyId
required

Policy id.

string

report
required

Policy report.

PolicyReport

sourceCluster
optional

Source cluster of replication.

string

sourceClusterCrn
optional

CRN of the source cluster.

string

sourceDataset
optional

Source dataset of replication.

< string > array

startTime
optional

Policy start time.

string (date-time)

status
required

Current status of the policy.

string

target
optional

Replication target details.

TargetDetails

targetCluster
optional

Target cluster of replication if not cloud.

string

targetClusterCrn
optional

CRN of the target cluster.

string

targetDataset
optional

Target dataset of replication.

< string > array

type
required

Policy type.

string

cloudCredential
optional

Cloud credentials to use if replicating to Cloud.

string

cloudEncryptionAlgorithm
optional

The type of cloud encryption algorithm. Can be used only for HDP/Ambari managed clusters. Supported values are AES256,SSE-KMS.

string

cloudEncryptionKey
optional

Cloud encryption key.

string

cmPolicySubmitUser
optional

CM policy submit user.

CmPolicySubmitUser

description
optional

Description of the policy.

string

distcpMapBandwidth
optional

Maximum bandwidth to use for replication.

integer (int64)

distcpMaxMaps
optional

Maximum Map jobs to use for replication.

integer (int64)

enableSnapshotBasedReplication
optional

Enable snapshot based replication.

boolean

endTime
optional

End time.

string (date-time)

frequencyInSec
required

Policy’s frequency in seconds.

integer (int64)

hiveExternalTableBaseDirectory
optional

Hive external table base directory.

string

name
required

Name of the new policy.

string

plugins
optional

Plugins.

< string > array

queueName
optional

YARN queue name if not default.

string

sourceCluster
optional

Name of source cluster in the format: "dataCenterName$cluster name", for example "DC-Europe$My Source 42.

string

sourceDataset
required

Source dataset to replicate.

SourceDataset

startTime
optional

Start time.

string (date-time)

targetCluster
optional

Name of destination cluster in the format: "dataCenterName$cluster name", for example "DC-US$My Destination 17".

string

targetDataset
optional

Dataset to replicate to.

string

tdeSameKey
optional

TDE same key.

boolean

type
required

Policy replication type.

enum (FS, HIVE, HBASE)

completedSteps
optional

Number of completed steps.

integer (int32)

endTime
optional

Command end time.

string (date-time)

id
required

Policy instance command id.

string

jobType
optional

Job type.

string

message
optional

Output of the policy command.

string

policyId
required

Policy id.

string

startTime
required

Command start time.

string (date-time)

status
required

Policy command status.

string

totalSteps
optional

Total number of steps.

integer (int32)

trackingInfo
optional

JSON data to track polciy status.

string

lastFailedInstance
optional

Last failed instance.

PolicyReportDetails

lastSucceededInstance
optional

Last successful instance.

PolicyReportDetails

endTime
required

End time.

string (date-time)

status
required

Status of the command.

string

blockSize
required

Block size.

boolean

extendedAttributes
required

Extended attributes.

boolean

permissions
required

Permissions.

boolean

replicationCount
required

Replication count.

boolean

configs
optional

Service configuration map.

< string, string > map

name
optional

The name of the service.

string

serviceName
required

Service name.

string

status
required

Service status.

string

hdfsArguments
optional

HDFS arguments for HDFS and Hive replication.

HdfsArguments

hiveArguments
optional

Arguments for Hive replication, null if HDFS replication.

HiveArguments

clusterCrn
required

CRN of the destination cluster.

string

policyId
required

ID of the HBase policy.

string

clusterCrn
optional

The CRN of the input cluster.

string

message
optional

The detailed description of the action taken.

string

status
optional

The status of the request.

string

clusterCrn
required

CRN of the cluster where the policy is.

string

policyName
required

Policy name to suspend.

string

clusterCrn
optional