Overview
Create and manage replication policies using Cloudera Replication Manager.
Version information
Version : 0.9.128 (BETA)
License information
License : Apache 2.0
Terms of service : https://www.cloudera.com/legal/commercial-terms-and-conditions.html
URI scheme
Schemes : HTTPS
Consumes
-
application/json
Produces
-
application/json
Paths
Abort replication policy.
POST /api/v1/replicationmanager/abortPolicy
Description
Abort all running instances of the replication policy.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Resume a suspended HBase replication policy.
POST /api/v1/replicationmanager/activateHbasePolicy
Description
Resumes an HBase replication policy if it has previously been suspended. Note that if the destination cluster’s Cloudera Manager API version is higher than 50 then it resumes all HBase replication policies between the same source and destination cluster, while if it is less than 45 then it only resumes the selected policy. Resume is not available for versions between 45 and 50.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Resume all replication tasks defined by the policy.
POST /api/v1/replicationmanager/activatePolicy
Description
Resumes all replication tasks defined by the policy if the policy is currently suspended.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Resume snapshot policy.
POST /api/v1/replicationmanager/activateSnapshotPolicy
Description
Resumes a specific snapshot policy.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Collect diagnostic bundle for a policy.
POST /api/v1/replicationmanager/collectDiagnosticBundle
Description
Triggers the collection of diagnostic bundle for a policy.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Continue the setup of an HBase policy.
POST /api/v1/replicationmanager/continueHbaseSetup
Description
Continues the setup of an HBase policy. If an HBase policy has a Classic Cluster source, the HBase service on the source will not be restarted automatically. The restart on the source needs to be executed manually, and then the continue setup step has to be called. There is no need to call this command if the source cluster is not a Classic Cluster.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Create an ABFS Access Key based account in DLM Engine.
POST /api/v1/replicationmanager/createAbfsAccessKeyCredential
Description
Creates a new ABFS Access Key based account in DLM Engine.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Create an Azure Active Directory Service Principal account in Cloudera Manager.
POST /api/v1/replicationmanager/createAbfsClientKeyCredential
Description
Creates a new Azure Active Directory Service Principal account in Cloudera Manager.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Create an ABFS Cloud Credential.
POST /api/v1/replicationmanager/createAbfsCredential
Description
Creates a new ABFS cloud credential.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Create an AWS Access Key cloud credential.
POST /api/v1/replicationmanager/createAwsAccessKeyCredential
Description
Creates a new AWS Access Key cloud credential.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Create an AWS Cloud Credential.
POST /api/v1/replicationmanager/createAwsCredential
Description
Creates a new AWS cloud credential.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Create an AWS IAM Role based cloud credential.
POST /api/v1/replicationmanager/createAwsIamCredential
Description
Creates a new AWS IAM Role based cloud credential.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Create an AWS IDBroker cloud credential.
POST /api/v1/replicationmanager/createAwsIdbrokerCredential
Description
Creates a new AWS IDBroker cloud credential.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Create a GCS Private Key cloud credential.
POST /api/v1/replicationmanager/createGcsPrivateKeyCredential
Description
Creates a new GCS Private Key cloud credential.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Create an HBase Replication Policy.
POST /api/v1/replicationmanager/createHbasePolicy
Description
Creates a new HBase replication policy with the given name on a specific cluster.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Create a Replication Policy.
POST /api/v1/replicationmanager/createPolicy
Description
Creates a new replication policy with the given name on a specific cluster.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Create snapshot policy.
POST /api/v1/replicationmanager/createSnapshotPolicy
Description
Creates a snapshot policy.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Delete Cloud Credential.
POST /api/v1/replicationmanager/deleteCredential
Description
Permanently deletes a specific cloud credential.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Delete an HBase Replication Policy.
POST /api/v1/replicationmanager/deleteHbasePolicy
Description
Permanently deletes a specific HBase replication policy.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Delete Replication Policy.
POST /api/v1/replicationmanager/deletePolicy
Description
Permanently deletes a specific replication policy.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Delete snapshot policy.
POST /api/v1/replicationmanager/deleteSnapshotPolicy
Description
Permanently deletes a specific snapshot policy.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Download diagnostic bundle for a policy.
POST /api/v1/replicationmanager/downloadDiagnosticBundle
Description
Downloads the previously collected diagnostic bundle if available. Before calling, the get-command-status command shall be polled until the command’s status shows 'DOWNLOADABLE_WITH_CLI'. If the status is 'DOWNLOADABLE_WITH_URL', the result can be downloaded with the given result data URL only.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Get configuration of a cluster.
POST /api/v1/replicationmanager/getClusterConfig
Description
Retrieves configuration of a specific cluster.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Get the status of the given CM command.
POST /api/v1/replicationmanager/getCommandStatus
Description
Return the current status of the given CM command.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Get Cloud Credentials from a Cluster.
POST /api/v1/replicationmanager/getCredentials
Description
Returns cloud credentials on a specific cluster.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Retrieve time series data for an HBase replication peer.
POST /api/v1/replicationmanager/getHbaseTimeSeries
Description
Returns time series data for an HBase replication peer based on the provided parameters.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Get Snapshot Policy.
POST /api/v1/replicationmanager/getSnapshotPolicy
Description
Retrieves a specific snapshot policy from the cluster specified in the request.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Lists Cloud Credentials.
POST /api/v1/replicationmanager/listAllCredentials
Description
Provides a detailed list of cloud credentials across all available clusters.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Lists Cluster Service Statuses.
POST /api/v1/replicationmanager/listClusterServiceStatuses
Description
Provides a list of cluster service (e.g. HDFS, Hive, YARN, etc.) statuses.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Lists all clusters.
POST /api/v1/replicationmanager/listClusters
Description
Provides a detailed list of all available clusters.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
List cluster CRNs which have an active HBase policy.
POST /api/v1/replicationmanager/listPairedHbaseClusters
Description
Provides a list of cluster CRNs with active HBase policies.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Get All Replication Policies.
POST /api/v1/replicationmanager/listPolicies
Description
Provides a list of all replication policies across all available clusters.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
List policy jobs.
POST /api/v1/replicationmanager/listPolicyJobs
Description
Returns a list of jobs triggered by a replication policy.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Get All Snapshot Policies.
POST /api/v1/replicationmanager/listSnapshotPolicies
Description
Provides a list of all snapshot policies across all available clusters.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
List snapshot policy jobs.
POST /api/v1/replicationmanager/listSnapshotPolicyJobs
Description
Lists jobs triggered by a snapshot policy.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Repair a failed HBase policy.
POST /api/v1/replicationmanager/repairHbasePolicy
Description
Attempts to repair an HBase policy in failed update state by resending the last update.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Rerun policy job.
POST /api/v1/replicationmanager/rerunPolicy
Description
Instantly starts a new job of a provided policy.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Restore snapshot.
POST /api/v1/replicationmanager/restoreSnapshot
Description
Restores a specific snapshot.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Retry failed first time setup for an HBase policy.
POST /api/v1/replicationmanager/retryFailedHbaseFirstTimeSetup
Description
Runs the first time setup configuration between the source and destination clusters if the first time setup has failed for the given policy.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Retry failed snapshots for an HBase policy.
POST /api/v1/replicationmanager/retryFailedHbaseSnapshots
Description
Reruns the failed initial snapshots (and only the failed ones) in the replication policy if it has failed to replicate the existing data of some or all tables.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Suspend an HBase replication policy.
POST /api/v1/replicationmanager/suspendHbasePolicy
Description
Pauses an active HBase replication policy. Note that if the destination cluster’s Cloudera Manager API version is higher than 50 then it suspends all HBase replication policies between the same source and destination cluster, while if it is less than 45 then it only suspends the selected policy. Suspend is not available for versions between 45 and 50.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Stop all replication tasks defined by the policy.
POST /api/v1/replicationmanager/suspendPolicy
Description
Stops all replication tasks defined by the policy. Replication will resume after activating the policy.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Suspend snapshot policy.
POST /api/v1/replicationmanager/suspendSnapshotPolicy
Description
Suspends a specific snapshot policy.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Update an ABFS Access Key based account in DLM Engine.
POST /api/v1/replicationmanager/updateAbfsAccessKeyCredential
Description
Updates an existing ABFS Access Key based account in DLM Engine.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Update an Azure Active Directory Service Principal account in Cloudera Manager.
POST /api/v1/replicationmanager/updateAbfsClientKeyCredential
Description
Updates an existing Azure Active Directory Service Principal account in Cloudera Manager.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Update an AWS Access Key cloud credential.
POST /api/v1/replicationmanager/updateAwsAccessKeyCredential
Description
Updates an existing AWS Access Key cloud credential.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Update an AWS IAM Role based cloud credential.
POST /api/v1/replicationmanager/updateAwsIamCredential
Description
Updates an existing AWS IAM Role based cloud credential.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Update an AWS IDBroker cloud credential.
POST /api/v1/replicationmanager/updateAwsIdbrokerCredential
Description
Updates an existing AWS IDBroker cloud credential.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Update a GCS Private Key cloud credential.
POST /api/v1/replicationmanager/updateGcsPrivateKeyCredential
Description
Updates an existing GCS Private Key cloud credential.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Update an HBase Replication Policy.
POST /api/v1/replicationmanager/updateHbasePolicy
Description
Updates an existing HBase replication policy with the given parameters on a specific cluster.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Update a Replication Policy.
POST /api/v1/replicationmanager/updatePolicy
Description
Updates an existing replication policy with the given parameters on a specific cluster.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Update snapshot policy.
POST /api/v1/replicationmanager/updateSnapshotPolicy
Description
Updates a snapshot policy.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Verify a source-destination cluster pair for HBase policy creation.
POST /api/v1/replicationmanager/verifyHbaseClusterPair
Description
Returns whether the cluster pair is ready for policy creation, or if there are some manual steps that need to be performed before.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Describes a successful response to a valid request. |
|
default |
The default response on an error. |
Definitions
AbfsCloudCredentialType
ABFS cloud credential type.
Type : enum (ACCESSKEY, CLIENTKEY)
AbortPolicyRequest
Request object for abortPolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the cluster where the replication policy is. |
string |
policyId |
The ID of the policy. |
string |
AbortPolicyResponse
Response object for abortPolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the input cluster. |
string |
message |
The detailed description of the action taken. |
string |
requestId |
The ID of the request. Populated only for Ambari backend. |
string |
status |
The status of the request. |
string |
ActivateHbasePolicyRequest
Activate an HBase replication policy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the destination cluster. |
string |
policyId |
ID of the HBase policy. |
string |
ActivateHbasePolicyResponse
Response object for activateHbasePolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the input cluster. |
string |
message |
The detailed description of the action taken. |
string |
status |
The status of the request. |
string |
ActivatePolicyRequest
Activate a replication policy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the cluster where the policy is. |
string |
policyName |
Policy name to resume. |
string |
ActivatePolicyResponse
Response object for resumePolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the input cluster. |
string |
message |
The detailed description of the action taken. |
string |
requestId |
The ID of the request. Populated only for Ambari backend. |
string |
status |
The status of the request. |
string |
ActivateSnapshotPolicyRequest
Request object for activateSnapshotPolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the cluster where the snapshot policy is. |
string |
name |
The name of the snapshot policy to be resumed. |
string |
ActivateSnapshotPolicyResponse
Response object for activateSnapshotPolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the cluster where the snapshot policy is. |
string |
message |
The detailed description of the action taken. |
string |
status |
The status of the request. |
string |
Alert
Cloudera Manager alerting behavior.
| Name | Description | Schema |
|---|---|---|
onAbort |
Alert on abort. |
boolean |
onFailure |
Alert on failure. |
boolean |
onStart |
Alert on start. |
boolean |
onSuccess |
ALert on success. |
boolean |
ApiError
API error.
| Name | Description | Schema |
|---|---|---|
clusterUrl |
Cluster URL. |
string |
code |
Error code. |
integer (int32) |
message |
Error message. |
string |
requestId |
Request ID. |
string |
status |
Error status. |
string |
AwsCloudCredentialType
AWS cloud credential type.
Type : enum (IAM, ACCESSKEY)
Cluster
Describes a Datalake, Datahub or Classic cluster.
| Name | Description | Schema |
|---|---|---|
cloudAccountProvider |
Cloud account provider. |
enum (AWS, ADLS, WASB, ABFS, GCS) |
clusterManagerType |
Cluster Manager type. |
enum (CLOUDERA_MANAGER, AMBARI) |
clusterManagerUrl |
Cluster Manager URL. |
string |
clusterType |
Cluster type. |
enum (CLASSIC, SDX, DISTROX) |
clusterUrl |
Cluster URL. |
string |
cmName |
Cloudera Manager name. |
string |
codProperties |
Additional properties for operational databases. |
|
crn |
Cluster CRN. |
string |
dataCenter |
Cluster data center. |
string |
description |
Cluster description. |
string |
environmentCrn |
CRN of the cluster’s environment. |
string |
knoxUrl |
Knox URL if the cluster was registered with one, null otherwise. |
string |
location |
Cluster location. |
|
name |
Cluster name. |
string |
replicationEngineType |
Replication engine type. |
enum (CM, DLM_ENGINE) |
stackCrn |
Stack CRN. |
string |
stackMajorVersion |
Stack major version. |
string |
stackVersion |
Stack version. |
string |
totalHosts |
Total hosts on the cluster. |
integer (int32) |
uuid |
Cluster UUID from Cloudera Manager if the cluster has CM backend. |
string |
ClusterServiceStatuses
Describes the status of services running on a cluster.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
Cluster CRN. |
string |
serviceStatuses |
List of service statuses. |
< ServiceInfo > array |
CmPolicySubmitUser
CM Policy submit user.
| Name | Description | Schema |
|---|---|---|
sourceUser |
Source user. |
string |
userName |
Username. |
string |
CmPolicySubmitUserResponse
The user that the replication policy uses to perform operations on the source or target cluster.
| Name | Description | Schema |
|---|---|---|
sourceUser |
Source user. |
string |
userName |
Username. |
string |
CodProperties
Additional properties for operational databases.
| Name | Description | Schema |
|---|---|---|
operationalDatabaseName |
Name of the corresponding operational database.. |
string |
CollectDiagnosticBundleRequest
Triggers a diagnostic bundle collect command for the given cluster and policyName.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the target cluster. |
string |
policyName |
Name of the policy. |
string |
CollectDiagnosticBundleResponse
Response object for collect-diagnostic-bundle.
| Name | Description | Schema |
|---|---|---|
active |
Whether the diagnostic bundle command is active. |
boolean |
commandId |
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 |
Name of the policy. |
string |
resultMessage |
Diagnostic bundle collection command result message. |
string |
startTime |
Start time of the diagnostic bundle collection command. |
string |
ContinueHbaseSetupRequest
Continue an HBase setup for Classic Cluster source.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the destination cluster. |
string |
policyId |
The ID of the HBase policy. |
string |
ContinueHbaseSetupResponse
Response object for continueHbaseSetup.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the input cluster. |
string |
message |
The detailed description of the action taken. |
string |
status |
The status of the request. |
string |
CreateAbfsAccessKeyCredentialRequest
Request object for creating ABFS Access Key based accounts in DLM Engine.
| Name | Description | Schema |
|---|---|---|
accessKey |
ABFS access key. |
string |
clusters |
List of cluster CRNs where the credential should be created. |
< string > array |
name |
Name of the credential. |
string |
storageAccountName |
ABFS storage account name. |
string |
CreateAbfsAccessKeyCredentialResponse
Response object for creating ABFS Access Key based accounts in DLM Engine.
| Name | Description | Schema |
|---|---|---|
errors |
The list of response errors in case of a partial failure while creating the credential. |
< ApiError > array |
CreateAbfsClientKeyCredentialRequest
Request object for creating Azure Active Directory Service Principal accounts in Cloudera Manager.
| Name | Description | Schema |
|---|---|---|
clientId |
Client ID of an Active Directory service principal account. |
string |
clientSecretKey |
Client Key of an Active Directory service principal account. |
string |
clusters |
List of cluster CRNs where the credential should be created. |
< string > array |
name |
Name of the credential. |
string |
tenantId |
Tenant ID of an Active Directory service principal account. |
string |
CreateAbfsClientKeyCredentialResponse
Response object for creating Azure Active Directory Service Principal accounts in Cloudera Manager.
| Name | Description | Schema |
|---|---|---|
errors |
The list of response errors in case of a partial failure while creating the credential. |
< ApiError > array |
CreateAbfsCredentialRequest
Request object for creating ABFS cloud credentials. Currently supported cloud credentials: ABFS Access Key for Ambari clusters, ABFS Client Secret for CM clusters.
| Name | Description | Schema |
|---|---|---|
accessKey |
ABFS access key. |
string |
clientId |
Client ID of an Active Directory service principal account. |
string |
clientSecretKey |
Client Key of an Active Directory service principal account. |
string |
clusters |
List of cluster CRNs where the credential should be created. |
< string > array |
name |
Name of the credential. |
string |
storageAccountName |
ABFS storage account name. |
string |
tenantId |
Tenant ID of an Active Directory service principal account. |
string |
type |
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. |
CreateAbfsCredentialResponse
Response object for creating ABFS credentials.
| Name | Description | Schema |
|---|---|---|
errors |
The list of response errors in case of a partial failure while creating the credential. |
< ApiError > array |
CreateAwsAccessKeyCredentialRequest
Request object for creating AWS Access Key cloud credentials.
| Name | Description | Schema |
|---|---|---|
accessKey |
AWS access key. |
string |
clusters |
List of cluster CRNs where the credential should be created. |
< string > array |
name |
Name of the credential. |
string |
secretKey |
AWS secret key. |
string |
CreateAwsAccessKeyCredentialResponse
Response object for creating AWS Access Key cloud credentials.
| Name | Description | Schema |
|---|---|---|
errors |
The list of response errors in case of a partial failure while creating the credential. |
< ApiError > array |
CreateAwsCredentialRequest
Request object for creating AWS IAM or Access & Secret Key cloud credentials.
| Name | Description | Schema |
|---|---|---|
accessKey |
AWS access key. |
string |
clusters |
List of cluster CRNs where the credential should be created. |
< string > array |
name |
Name of the credential. |
string |
secretKey |
AWS secret key. |
string |
type |
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. |
CreateAwsCredentialResponse
Response object for creating AWS credentials.
| Name | Description | Schema |
|---|---|---|
errors |
The list of response errors in case of a partial failure while creating the credential. |
< ApiError > array |
CreateAwsIamCredentialRequest
Request object for creating AWS IAM Role based cloud credentials.
| Name | Description | Schema |
|---|---|---|
clusters |
List of cluster CRNs where the credential should be created. |
< string > array |
name |
Name of the credential. |
string |
CreateAwsIamCredentialResponse
Response object for creating AWS IAM Role based cloud credentials.
| Name | Description | Schema |
|---|---|---|
errors |
The list of response errors in case of a partial failure while creating the credential. |
< ApiError > array |
CreateAwsIdbrokerCredentialRequest
Request object for creating AWS IDBroker cloud credentials.
| Name | Description | Schema |
|---|---|---|
clusters |
List of cluster CRNs where the credential should be created. |
< string > array |
idbrokerAddress |
The address of the IDBroker endpoint that will be used for authentication, for example http(s)://[IDBROKER_HOST]:[IDBROKER_PORT]/gateway. |
string |
idbrokerCabPath |
The name of the IDBroker topology that will be used for authentication. |
string |
name |
Name of the credential. |
string |
CreateAwsIdbrokerCredentialResponse
Response object for creating AWS IDBroker cloud credentials.
| Name | Description | Schema |
|---|---|---|
errors |
The list of response errors in case of a partial failure while creating the credential. |
< ApiError > array |
CreateGcsPrivateKeyCredentialRequest
Request object for creating GCS Private Key cloud credentials.
| Name | Description | Schema |
|---|---|---|
clientEmail |
Client email. |
string |
clusters |
List of cluster CRNs where the credential should be created. |
< string > array |
name |
Name of the credential. |
string |
privateKey |
GCS private key. |
string |
privateKeyId |
GCS private key ID. |
string |
CreateGcsPrivateKeyCredentialResponse
Response object for creating GCS Private Key cloud credentials.
| Name | Description | Schema |
|---|---|---|
errors |
The list of response errors in case of a partial failure while creating the credential. |
< ApiError > array |
CreateHbasePolicyRequest
Create an HBase replication policy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the destination cluster. |
string |
policyDefinition |
Policy definition. |
|
policyName |
Name of the new policy. |
string |
CreateHbasePolicyResponse
Response object for createHbasePolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the input cluster. |
string |
message |
The detailed description of the action taken. |
string |
status |
The status of the request. |
string |
CreatePolicyRequest
Create a replication policy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the cluster where the policy will be created. |
string |
policyDefinition |
Policy definition. |
|
policyName |
Name of the new policy. |
string |
CreatePolicyResponse
Response object for createPolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the input cluster. |
string |
message |
The detailed description of the action taken. |
string |
requestId |
The ID of the request. Populated only for Ambari backend. |
string |
status |
The status of the request. |
string |
CreateSnapshotPolicyRequest
Request object for createSnapshotPolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the cluster where the snapshot policy will be created. |
string |
snapshotPolicyDefinition |
The details of the snapshot policy to be created. |
CreateSnapshotPolicyResponse
Response object for createSnapshotPolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the cluster from where the snapshot policy has been created. |
string |
message |
The detailed description of the action taken. |
string |
status |
The status of the request. |
string |
CredentialCollection
Cloud Credentials listing.
| Name | Description | Schema |
|---|---|---|
credentials |
Cloud credential details. |
< CredentialDetails > array |
results |
Number of cloud credentials in the response. |
integer (int64) |
totalResults |
Total number cloud credentials. |
integer (int64) |
CredentialDetails
Cloud credential details for by-name or by-id cloud credential request.
| Name | Description | Schema |
|---|---|---|
authType |
Authentication type. |
string |
configs |
Configurations. |
< string, string > map |
creationTime |
Creation time. |
string (date-time) |
customConfigs |
Custom configurations. |
< CustomConfigs > array |
id |
Credential id. |
string |
lastModifiedTime |
Last modified time. |
string (date-time) |
name |
Credential name. |
string |
provider |
Credential provider. |
string |
CredentialsResponse
Response object for cloud credentials.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
Cluster CRN. |
string |
clusterUrl |
Cluster URL. |
string |
credentials |
Cloud credentials. |
|
replicationEngineType |
Replication engine type. |
enum (CM, DLMENGINE) |
CustomConfigs
Custom key/value configurations.
| Name | Description | Schema |
|---|---|---|
confidential |
Whether the value is confidential. |
boolean |
name |
Name. |
string |
value |
Value. |
string |
DeleteCredentialRequest
Request object for deleting a credential.
| Name | Description | Schema |
|---|---|---|
name |
Name of the cloud credential to delete. |
string |
DeleteCredentialResponse
Response object for delete credential operation.
| Name | Description | Schema |
|---|---|---|
errors |
The list of response errors in case of a partial failure while deleting the credential. |
< ApiError > array |
DeleteHbasePolicyRequest
Request object to delete an HBase replication policy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the destination cluster. |
string |
force |
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 |
ID of the HBase policy. |
string |
DeleteHbasePolicyResponse
Response object for deleteHbasePolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the input cluster. |
string |
message |
The detailed description of the action taken. |
string |
status |
The status of the request. |
string |
DeletePolicyRequest
Delete a replication policy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the cluster where the policy is. |
string |
policyName |
Policy name to delete. |
string |
DeletePolicyResponse
Response object for deletePolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the input cluster. |
string |
message |
The detailed description of the action taken. |
string |
requestId |
The ID of the request. Populated only for Ambari backend. |
string |
status |
The status of the request. |
string |
DeleteSnapshotPolicyRequest
Request object for deleteSnapshotPolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the cluster where the snapshot policy is. |
string |
name |
The name of the snapshot policy to be deleted. |
string |
DeleteSnapshotPolicyResponse
Response object for deleteSnapshotPolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the cluster from where the snapshot policy was deleted. |
string |
message |
The detailed description of the action taken. |
string |
status |
The status of the request. |
string |
DownloadDiagnosticBundleRequest
Request to download the diagnostic bundle for the given cluster and command id.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the target cluster. |
string |
commandId |
The command ID from the response of collect-diagnostic-bundle command. |
string |
DownloadDiagnosticBundleResponse
Response object for download-diagnostic-bundle. On certain clusters this response will show if the download is only available directly from CM.
| Name | Description | Schema |
|---|---|---|
bundleFile |
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' |
string (byte) |
Error
An object returned on an error.
| Name | Description | Schema |
|---|---|---|
code |
The error code. |
string |
message |
The error message. |
string |
ErrorHandling
Error handling behavior.
| Name | Description | Schema |
|---|---|---|
abortOnError |
Abort policy on error. |
boolean |
abortOnSnapshotDiffFailures |
Abort policy if there are snapshot diff failures. |
boolean |
skipChecksumChecks |
Skip checksum checks. |
boolean |
skipListingChecksumChecks |
Skip checksum checks for copy-listing. |
boolean |
GetClusterConfigRequest
Request object for getClusterConfig.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the cluster. |
string |
GetClusterConfigResponse
Response object for getClusterConfig.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the cluster. |
string |
cmApiVersion |
Cloudera Manager API version. |
integer (int32) |
dmx |
Configuration related to DMX. |
|
featureSupport |
A map of available features and whether they are supported on the cluster. |
< string, boolean > map |
services |
A list of service configurations. |
< ServiceConfiguration > array |
underlyingFsForHive |
Underlying file system for Hive. |
enum (HDFS, S3, WASB, ABFS, GCS) |
dmx
| Name | Description | Schema |
|---|---|---|
hbaseSuspend |
Suspend type for HBase policies. |
GetCommandStatusRequest
Get the current status of any CM command.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the target cluster. |
string |
commandId |
ID of a CM command on the cluster. |
string |
GetCommandStatusResponse
Response object for get command status.
| Name | Description | Schema |
|---|---|---|
active |
Whether the command is still active. |
boolean |
bundleStatus |
The current status of the command. |
enum (IN_PROGRESS, DOWNLOADABLE_WITH_URL, DOWNLOADABLE_WITH_CLI, FAILED) |
bundleStatusMessage |
Further information about the current command status. |
string |
commandId |
Id of the CM command. |
integer (int64) |
endTime |
End time of the CM command. |
string |
name |
Name of the policy. |
string |
resultDataUrl |
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 |
Result message of the command. |
string |
startTime |
Start time of the CM command. |
string |
success |
Whether the diagnostic collection is successful. |
boolean |
GetCredentialsRequest
Request object to retrieve specific cloud credentials.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the cluster where the credential is. |
string |
credentialId |
Id of the credential. If both name and Id are specified, the Id is considered. |
string |
credentialName |
Name of the credential. If both name and Id are specified, the Id is considered. |
string |
GetCredentialsResponse
Response for credential request.
| Name | Description | Schema |
|---|---|---|
credentials |
List of credentials. |
< CredentialDetails > array |
GetHbaseTimeSeriesRequest
Request to retrieve time series data for an HBase replication peer.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the destination cluster of the policy. |
string |
endTime |
End time of the time series data. Defaults to current time. |
string (date-time) |
metric |
Name of the HBase replication peer metric. |
enum (age_of_last_shipped_operation, log_edits_filtered_rate, log_edits_read_rate, log_queue_size, log_read_in_bytes_rate, shipped_batches_rate, shipped_ops_rate, shipped_size_in_kb_rate, age_of_last_shipped_operation_25th_percentile, age_of_last_shipped_operation_75th_percentile, age_of_last_shipped_operation_90th_percentile, age_of_last_shipped_operation_98th_percentile, age_of_last_shipped_operation_99th_percentile, age_of_last_shipped_operation_999th_percentile, age_of_last_shipped_operation_max, age_of_last_shipped_operation_mean, age_of_last_shipped_operation_median, age_of_last_shipped_operation_min, age_of_last_shipped_operation_rate, shipped_hfiles_rate, size_of_hfile_refs_queue) |
policyId |
ID of the policy that the time series data is requested for. |
string |
rollup |
Aggregate rollup level for time series data. Defaults to RAW data. |
enum (RAW, TEN_MINUTELY, HOURLY, SIX_HOURLY, DAILY, WEEKLY) |
startTime |
Start time of the time series data. Defaults to 5 minutes before end time. |
string (date-time) |
GetHbaseTimeSeriesResponse
Response object for getHbaseTimeSeries.
| Name | Description | Schema |
|---|---|---|
hbasePeerName |
Name of the HBase peer used for replication. |
string |
sourceCluster |
Name of source cluster in the format: "dataCenterName$cluster name", for example "DC-Europe$My Source 42". |
string |
targetCluster |
Name of destination cluster in the format: "dataCenterName$cluster name", for example "DC-US$My Destination 17". |
string |
timeSeries |
Time series data with additional metadata. |
GetSnapshotPolicyRequest
Request object for getSnapshotPolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the cluster where the snapshot policy is. |
string |
name |
The name of the snapshot policy to be retrieved. |
string |
GetSnapshotPolicyResponse
Response object for getSnapshotPolicy.
| Name | Description | Schema |
|---|---|---|
alert |
Alerting behaviour of the snapshot policy. |
|
cluster |
The cluster that stores that snapshot policy. |
string |
description |
The description of the snapshot policy. |
string |
hbaseArguments |
Arguments specific to HBase snapshot policies. |
|
hdfsArguments |
Arguments specific to HDFS snapshot policies. |
|
lastCommand |
Latest command of the snapshot policy. The command might still be active. |
|
lastSuccessfulCommand |
Last successful command of the snapshot policy. |
|
name |
The name of the snapshot policy. |
string |
paused |
Whether the snapshot policy is suspended. |
boolean |
schedule |
The schedule of the snapshot policy. |
|
scope |
Defines the datasets that are covered by the snapshot policy. Contains path patterns for HDFS snapshot policies and table regular expressions for HBase snapshot policies. |
< string > array |
snapshotRetentionCount |
The number of snapshots to be retained for snapshot policies. |
|
state |
The current state of the snapshot policy. |
|
type |
The type of the snapshot policy. |
HBaseSnapshotStorageType
The location where the HBase shapshot is stored.
Type : enum (LOCAL, REMOTE_S3)
HbaseCrnPairs
HBase CRN pairs.
| Name | Description | Schema |
|---|---|---|
pairedCrns |
The list of CRNs which are peers of each other. |
< string > array |
HbaseDatabaseArguments
HBase database replication arguments.
| Name | Description | Schema |
|---|---|---|
replicationStrategy |
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) |
HbasePolicyArguments
HBase replication parameters.
| Name | Description | Schema |
|---|---|---|
cloudCredential |
Cloud credentials to use to replicate the initial snapshot if the credential location is specified as 'EXTERNAL_ACCOUNT'. |
string |
credentialLocation |
Location of the credentials provided for initial snapshots. Setting it to 'SAFETY_VALVE' indicates that the credentials are available in safety valves on the source cluster, otherwise credentials have to be defined in the 'cloudCredential' property. Defaults to 'EXTERNAL_ACCOUNT'. |
enum (EXTERNAL_ACCOUNT, SAFETY_VALVE) |
databaseArguments |
Optional parameters used for HBase database replication. |
|
forceSetup |
Whether setup should be forced if one of the clusters is already paired with another cluster. Forced setup is only possible if either there are no HBase replication policies between the pair or if the other cluster in the pair is currently unreachable. Note that when set to 'true' the existing pairing for the selected source or target cluster will be cleared and the first-time setup will be initiated with the chosen new source or destination cluster. |
boolean |
tables |
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 |
validateReplicationSetup |
Whether to validate replication setup after policy creation. |
boolean |
HbasePolicyDefinition
HBase policy definition.
| Name | Description | Schema |
|---|---|---|
description |
Description of the policy. |
string |
distcpMapBandwidth |
Maximum bandwidth per mapper to use for initial snapshot. |
integer (int64) |
distcpMaxMaps |
Maximum Map jobs to use for initial snapshot. |
integer (int64) |
exportSnapshotUser |
If set, the user specified by this parameter will be used to export the initial snapshot on the source. |
string |
hbasePolicyArguments |
HBase policy arguments. |
|
initialSnapshot |
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 |
Machine user details to use for the replication. If not specified, an internal machine user will be created and synchronized to the required environments. |
|
queueName |
YARN queue name to use for initial snapshot if not default. |
string |
sourceCluster |
Name of source cluster in the format: "dataCenterName$cluster name", for example "DC-Europe$My Source 42." |
string |
sourceRestartType |
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. |
|
targetCluster |
Name of destination cluster in the format: "dataCenterName$cluster name", for example "DC-US$My Destination 17". |
string |
targetRestartType |
Type of restart for the destination cluster. This is only accepted if the cluster has restart-type support. Default is ROLLING_RESTART. |
HbaseSnapshotPolicyArgumentsRequest
Arguments specific to HBase snapshot policies.
| Name | Description | Schema |
|---|---|---|
storage |
The location where the snapshots should be stored. |
|
tableRegExps |
The regular expressions specifying the tables. Tables matching any of them will be eligible for snapshot creation. |
< string > array |
HbaseSnapshotPolicyArgumentsResponse
Arguments specific to HBase snapshot policies.
| Name | Description | Schema |
|---|---|---|
storage |
The location where the snapshots should be stored. |
|
tableRegExps |
The regular expressions specifying the tables. Tables matching any of them will be eligible for snapshot creation. |
< string > array |
HbaseSuspendType
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 destination cluster, while 'POLICY' means that only the selected policy gets suspended/resumed. 'NOT_SUPPORTED' means that this feature is not available on the cluster.
Type : enum (POLICY, ALL, NOT_SUPPORTED)
HbaseTimeSeries
HBase time series data and metadata.
| Name | Description | Schema |
|---|---|---|
data |
List of time series data points. |
< HbaseTimeSeriesData > array |
metadata |
Metadata regarding the time series data. |
HbaseTimeSeriesData
Time series data point.
| Name | Description | Schema |
|---|---|---|
timestamp |
Timestamp of the data point. |
string (date-time) |
value |
Value of the data point. |
number (double) |
HbaseTimeSeriesMetadata
Time series metadata.
| Name | Description | Schema |
|---|---|---|
attributes |
Attributes of the resource providing time series data. |
|
endTime |
End time of the time series data. |
string (date-time) |
metricName |
Name of the metric. |
string |
startTime |
Start time of the time series data. |
string (date-time) |
unitDenominator |
Unit denominator. |
string |
unitNumerator |
Unit numerator. |
string |
HbaseTimeSeriesMetadataAttributes
Attributes of the resource providing time series data.
| Name | Description | Schema |
|---|---|---|
clusterName |
Cluster name. |
string |
serviceName |
Service name. |
string |
HdfsArguments
Extra properties for HDFS.
| Name | Description | Schema |
|---|---|---|
alert |
Alerting behavior. |
|
deletePolicy |
Deletion behavior. |
enum (KEEP_DELETED_FILES, DELETE_TO_TRASH, DELETE_PERMANENTLY) |
errorHandling |
Error handling strategy. |
|
exclusionFilters |
Exclusion filters in glob format. |
< string > array |
logPath |
Job log path. |
string |
mapReduceService |
Name of the mapreduce service. |
string |
path |
HDFS path. Mandatory for HDFS policies, otherwise optional. |
string |
preserve |
Properties to preserve. |
|
replicationStrategy |
Replication strategy. |
enum (DYNAMIC, STATIC) |
HdfsDistCpArgs
The distcp arguments for restoring a HDFS snapshot.
| Name | Description | Schema |
|---|---|---|
abortOnError |
Whether to abort the job on an error. If selected, files copied up to that point remain in the destination, but no additional files are copied. |
boolean |
bandwidthPerMap |
The maximum bandwidth (in MB) per mapper in the mapreduce job restoring the snapshot. |
integer (int64) |
logPath |
An alternate path for logs. |
string |
mapreduceServiceName |
The MapReduce or YARN service to use. |
string |
numMaps |
The number of mappers to use for the mapreduce job restoring the snapshot. |
integer (int64) |
preserveBlockSize |
Whether to preserve the HDFS block size. |
boolean |
preservePermissions |
Whether to preserve the HDFS owner, group and permissions. |
boolean |
preserveReplicationCount |
Whether to preserve the HDFS replication count. |
boolean |
removeMissingFiles |
Whether to delete destination files that are missing in source. |
boolean |
replicationStrategy |
Replication strategy. |
enum (DYNAMIC, STATIC) |
schedulerPoolName |
The name of a resource pool in the field. The value entered is used by the MapReduce Service you specified when Cloudera Manager executes the MapReduce job for restoring the snapshot. |
string |
skipChecksumChecks |
Whether to skip checksum checks. If set to true, checksum validation will not be performed. |
boolean |
skipTrash |
Whether to permanently delete destination files that are missing in source. |
boolean |
userName |
The CM user used to run the job restoring the snapshot. |
string |
HdfsSnapshotPolicyArgumentsRequest
Arguments specific to HDFS snapshot policies.
| Name | Description | Schema |
|---|---|---|
pathPatterns |
The path patterns specifying the paths. Paths matching any of them will be eligible for snapshot creation. The pattern matching characters that can be specific are those supported by HDFS. |
< string > array |
HdfsSnapshotPolicyArgumentsResponse
Arguments specific to HDFS snapshot policies.
| Name | Description | Schema |
|---|---|---|
pathPatterns |
The path patterns specifying the paths. Paths matching any of them will be eligible for snapshot creation. The pattern matching characters that can be specific are those supported by HDFS. |
< string > array |
HdfsUpdateArguments
Updatable HDFS properties.
| Name | Description | Schema |
|---|---|---|
alert |
Alerting behavior. |
|
deletePolicy |
Deletion behavior for the target side when files are removed on the source side. KEEP_DELETED_FILES:Keep deleted source files on the target, DELETE_TO_TRASH:Remove the deleted source files to trash on the target, DELETE_PERMANENTLY:Permanently remove deleted files on the target. |
enum (KEEP_DELETED_FILES, DELETE_TO_TRASH, DELETE_PERMANENTLY) |
errorHandling |
Error handling strategy. |
|
exclusionFilters |
Exclusion filters in glob format. |
< string > array |
logPath |
The HDFS path where the replication log files should be written to. |
string |
mapReduceService |
The name of the MapReduce service. |
string |
preserve |
Properties to preserve. |
|
replicationStrategy |
Replication strategy. |
enum (DYNAMIC, STATIC) |
HiveArguments
Hive replication arguments.
| Name | Description | Schema |
|---|---|---|
databasesAndTables |
Scope of the replication. |
< HiveDatabaseAndTables > array |
numThreads |
Number of threads to use during replication. |
integer (int64) |
sentryPermissions |
Include or exclude Sentry permissions. |
enum (INCLUDE, EXCLUDE) |
skipUrlPermissions |
Skip URL permissions. |
boolean |
HiveDatabaseAndTables
Hive replication scope.
| Name | Description | Schema |
|---|---|---|
database |
Database to replicate. |
string |
tablesExcludeRegex |
Regex to match excluded tables. |
string |
tablesIncludeRegex |
Regex to match included tables. |
string |
ListAllCredentialsRequest
Request object for listing all cloud credentials on all clusters.
Type : object
ListAllCredentialsResponse
Response object for list credentials request.
| Name | Description | Schema |
|---|---|---|
credentials |
List of credentials by cluster. |
< CredentialsResponse > array |
unreachableClusters |
List of errors for unreachable clusters. |
< ApiError > array |
ListClusterServiceStatusesRequest
Request object to list cluster statuses.
Type : object
ListClusterServiceStatusesResponse
Response object for listing of cluster statuses.
| Name | Description | Schema |
|---|---|---|
statuses |
List of statuses by cluster. |
< ClusterServiceStatuses > array |
ListClustersRequest
Request to list clusters.
Type : object
ListClustersResponse
Response object for list clusters request.
| Name | Description | Schema |
|---|---|---|
clusters |
List of clusters. |
< Cluster > array |
unreachableClusters |
List of errors for unreachable clusters. |
< ApiError > array |
ListPairedHbaseClustersRequest
Request to list all paired HBase cluster CRNs.
Type : object
ListPairedHbaseClustersResponse
Response object for listPairedHbaseClusters.
| Name | Description | Schema |
|---|---|---|
crnsMissingHbaseService |
Cluster CRNs where the HBase service was missing and pairing status could not be determined. |
< string > array |
pairings |
The list of CRN pairings. |
< HbaseCrnPairs > array |
unreachableClusters |
The list of errors for unreachable clusters. |
< ApiError > array |
ListPoliciesRequest
Request object for listing all policies.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the cluster where the policies are stored. |
string |
ListPoliciesResponse
Response object for a list policies request.
| Name | Description | Schema |
|---|---|---|
policies |
List of policies. |
< Policy > array |
policyErrors |
List of policy errors. |
< ApiError > array |
unreachableClusters |
List of errors for unreachable clusters. |
< ApiError > array |
ListPolicyJobsRequest
Request object for listing policy jobs.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the cluster where the replication policy is. |
string |
pageSize |
The size of each page. Defaults to 10. |
integer (int32) |
policyId |
The ID of the policy. |
string |
startingToken |
A token to specify where to start paginating. This is the nextToken from a previously truncated response. 1 or empty for first page. |
string |
ListPolicyJobsResponse
Response object for listPolicyJobs.
| Name | Description | Schema |
|---|---|---|
jobs |
List of policy jobs. |
< PolicyInstanceResponse > array |
nextToken |
The token to use when requesting the next set of results. If not present, there are no additional results. |
string |
results |
Number of jobs in the response. |
integer (int64) |
totalResults |
Total number of jobs for the policy. |
integer (int64) |
ListSnapshotPoliciesRequest
Request object for listing all snapshot policies.
Type : object
ListSnapshotPoliciesResponse
Response object for a list snapshot policies request.
| Name | Description | Schema |
|---|---|---|
errorResponses |
List of snapshot policy errors. |
< ApiError > array |
snapshotPolicyResponses |
List of snapshot policies. |
< GetSnapshotPolicyResponse > array |
ListSnapshotPolicyJobsRequest
Request object for listSnapshotPolicyJobs.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the cluster where the snapshot policy is. |
string |
name |
The name of the snapshot policy whose snapshot history will be retrieved. |
string |
ListSnapshotPolicyJobsResponse
Response object for listSnapshotPolicyJobs.
| Name | Description | Schema |
|---|---|---|
errorResponses |
List of snapshot policy errors. |
< ApiError > array |
jobs |
The list of snapshot jobs that ran for the snapshot policy. |
< SnapshotJob > array |
Location
Location object.
| Name | Description | Schema |
|---|---|---|
city |
City. |
string |
country |
Country. |
string |
id |
Location ID. |
integer (int64) |
latitude |
Latitude. |
number (double) |
longitude |
Longitude. |
number (double) |
MachineUser
Username and password for the machine user.
| Name | Description | Schema |
|---|---|---|
createUser |
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 |
Password. |
string |
user |
Username. |
string |
Policy
Replication policy definition.
| Name | Description | Schema |
|---|---|---|
cmPolicySubmitUser |
CM policy submit user. |
|
creationTime |
Policy creation time. |
string (date-time) |
customProperties |
Custom replication properties. |
< string, string > map |
description |
Policy description. |
string |
endTime |
End time of policy run or when it repeats. |
string (date-time) |
executionType |
Policy execution type. |
string |
frequency |
Frequency in seconds when the policy runs. |
integer (int64) |
jobs |
List of policy runs. |
< PolicyInstanceResponse > array |
name |
Policy name. |
string |
nextRun |
Next expected run of the policy. |
string |
plugins |
Plugins. |
< string > array |
policyId |
Policy id. |
string |
report |
Policy report. |
|
sourceCluster |
Source cluster of replication. |
string |
sourceClusterCrn |
CRN of the source cluster. |
string |
sourceDataset |
Source dataset of replication. |
< string > array |
startTime |
Policy start time. |
string (date-time) |
status |
Current status of the policy. |
string |
target |
Replication target details. |
|
targetCluster |
Target cluster of replication if not cloud. |
string |
targetClusterCrn |
CRN of the target cluster. |
string |
targetDataset |
Target dataset of replication. |
< string > array |
type |
Policy type. |
string |
PolicyDefinition
Policy creation request definition.
| Name | Description | Schema |
|---|---|---|
cloudCredential |
Cloud credentials to use if replicating to Cloud. |
string |
cloudEncryptionAlgorithm |
The type of cloud encryption algorithm. Can be used only for HDP/Ambari managed clusters. Supported values are AES256,SSE-KMS. |
string |
cloudEncryptionKey |
Cloud encryption key. |
string |
cmPolicySubmitUser |
CM policy submit user. |
|
description |
Description of the policy. |
string |
distcpMapBandwidth |
Maximum bandwidth to use for replication. |
integer (int64) |
distcpMaxMaps |
Maximum Map jobs to use for replication. |
integer (int64) |
enableSnapshotBasedReplication |
Enable snapshot based replication. |
boolean |
endTime |
End time. |
string (date-time) |
frequencyInSec |
Policy’s frequency in seconds. |
integer (int64) |
hiveExternalTableBaseDirectory |
Hive external table base directory. |
string |
name |
Name of the new policy. |
string |
plugins |
Plugins. |
< string > array |
queueName |
YARN queue name if not default. |
string |
sourceCluster |
Name of source cluster in the format: "dataCenterName$cluster name", for example "DC-Europe$My Source 42. |
string |
sourceDataset |
Source dataset to replicate. |
|
startTime |
Start time. |
string (date-time) |
targetCluster |
Name of destination cluster in the format: "dataCenterName$cluster name", for example "DC-US$My Destination 17". |
string |
targetDataset |
Dataset to replicate to. |
string |
tdeSameKey |
TDE same key. |
boolean |
type |
Policy replication type. |
enum (FS, HIVE, HBASE) |
PolicyInstanceResponse
Policy execution details.
| Name | Description | Schema |
|---|---|---|
completedSteps |
Number of completed steps. |
integer (int32) |
endTime |
Command end time. |
string (date-time) |
id |
Policy instance command id. |
string |
jobType |
Job type. |
string |
message |
Output of the policy command. |
string |
policyId |
Policy id. |
string |
startTime |
Command start time. |
string (date-time) |
status |
Policy command status. |
string |
totalSteps |
Total number of steps. |
integer (int32) |
trackingInfo |
JSON data to track polciy status. |
string |
PolicyReport
Policy report.
| Name | Description | Schema |
|---|---|---|
lastFailedInstance |
Last failed instance. |
|
lastSucceededInstance |
Last successful instance. |
PolicyReportDetails
Policy report details.
| Name | Description | Schema |
|---|---|---|
endTime |
End time. |
string (date-time) |
status |
Status of the command. |
string |
Preserve
Properties to preserve after replication.
| Name | Description | Schema |
|---|---|---|
blockSize |
Block size. |
boolean |
extendedAttributes |
Extended attributes. |
boolean |
permissions |
Permissions. |
boolean |
replicationCount |
Replication count. |
boolean |
RepairHbasePolicyRequest
Attempt to repair an HBase replication policy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the destination cluster. |
string |
policyId |
ID of the HBase policy. |
string |
RepairHbasePolicyResponse
Response object for repairHbasePolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the input cluster. |
string |
message |
The detailed description of the action taken. |
string |
status |
The status of the request. |
string |
RerunPolicyRequest
Request object for rerun policy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the cluster where the replication policy run gets executed. |
string |
policyId |
The ID of the policy to rerun. |
string |
RerunPolicyResponse
Response object for rerun policy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the cluster where the replication policy run gets executed. |
string |
message |
The output of rerun policy command. |
string |
requestId |
The ID of the request. Populated only for Ambari backend. |
string |
status |
The status of the request. |
string |
RestartType
Type of restart for a cluster.
Type : enum (RESTART, ROLLING_RESTART)
RestoreHBaseSnapshotArgs
Arguments for restoring a HBase snapshot.
| Name | Description | Schema |
|---|---|---|
creationTime |
The time when the snapshot to be restored was created. This value should equal the 'endTime' attribute of the snapshot restore command that created the snapshot. |
string (date-time) |
isClone |
Whether to restore or clone the snapshot. Cloning a snapshot creates a new read/write table that serves the data kept at the time of the snapshot. The original table and the cloned table can be modified independently; new data written to one table does not show up on the other. Restoring a snapshot replaces the current version of a table with different version based on the snapshot. |
boolean |
snapshotName |
The name of the snapshot to be restored. |
string |
storageType |
Whether the snapshot is stored locally or remotely. |
|
tableName |
If the hbase operation is 'clone', a table name should be provided, which will be the name of the new table created when cloning the snapshot. If the hbase operation is 'restore', the table name should be empty. |
string |
RestoreHdfsSnapshotArgs
Arguments for restoring a HDFS snapshot.
| Name | Description | Schema |
|---|---|---|
destinationPath |
The path to restore the snapshot into. |
string |
distCpArgs |
The distcp arguments for restoring the snapshot. When this attribute is set, disctp will be used to restore the snapshot. When unset, the HDFS copy command will be used to restore the snapshot. |
|
path |
The snapshotted path. |
string |
snapshotName |
The name of the snapshot to be restored. |
string |
snapshotPath |
The absolute path of the snapshot to be restored. |
string |
RestoreSnapshotArguments
Arguments for restoring a HDFS or HBase snapshot.
| Name | Description | Schema |
|---|---|---|
restoreHBaseSnapshotArgs |
Arguments for restoring a HBase snapshot. |
|
restoreHdfsSnapshotArgs |
Arguments for restoring a HDFS snapshot. |
|
snapshotType |
The type of the snapshot to be restored. |
RestoreSnapshotRequest
Request object for restoreSnapshot.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the cluster where the snapshot policy is. |
string |
restoreSnapshotArguments |
Arguments for restoring a specific snapshot. |
RestoreSnapshotResponse
Response object for restoreSnapshot.
| Name | Description | Schema |
|---|---|---|
restoreSnapshotCommand |
Details of the CM command that was created to restore the snapshot. |
RetryFailedHbaseFirstTimeSetupRequest
Request object to retry first time setup for an HBase policy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the destination cluster. |
string |
machineUser |
Machine user details to use for the replication. If not specified, an internal machine user will be created and synchronized to the required environments. |
|
policyId |
ID of the HBase policy. |
string |
sourceRestartType |
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. |
|
targetRestartType |
Type of restart for the destination cluster. This is only accepted if the cluster has restart-type support. Default is ROLLING_RESTART. |
RetryFailedHbaseFirstTimeSetupResponse
Response object for retryFailedHbaseFirstTimeSetup.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the input cluster. |
string |
message |
The detailed description of the action taken. |
string |
status |
The status of the request. |
string |
RetryFailedHbaseSnapshotsRequest
Request object to retry failed snapshots for an HBase policy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the destination cluster. |
string |
policyId |
ID of the HBase policy. |
string |
RetryFailedHbaseSnapshotsResponse
Response object for retryFailedHbaseSnapshots.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the input cluster. |
string |
message |
The detailed description of the action taken. |
string |
status |
The status of the request. |
string |
ServiceConfiguration
Configuration related to a service.
| Name | Description | Schema |
|---|---|---|
configs |
Service configuration map. |
< string, string > map |
name |
The name of the service. |
string |
ServiceInfo
Service status definition.
| Name | Description | Schema |
|---|---|---|
serviceName |
Service name. |
string |
status |
Service status. |
string |
SnapshotCommand
Detailed information about a snapshot command.
| Name | Description | Schema |
|---|---|---|
active |
Whether the command is currenlty active. |
boolean |
children |
List of references to the child commands. |
< GetCommandStatusResponse > array |
endTime |
The end time of the command, if the command is finished. |
string (date-time) |
id |
The id of the command. |
integer (int64) |
name |
The name of the command. |
string |
parent |
Reference to the parent command, if any. |
|
resultMessage |
The result message of the command, if the command has finished. |
string |
startTime |
The start time of the command. |
string (date-time) |
success |
Whether the command was successful, if the command has finished. |
boolean |
SnapshotJob
Detailed information about a snapshot job.
| Name | Description | Schema |
|---|---|---|
clusterId |
The crn of the cluster where the snapshot is. |
string |
endTime |
The end time of the snapshot command. |
string (date-time) |
estimatedExpiration |
The estimated expiration time of the snapshot created by the snapshot command. |
string (date-time) |
hbaseResult |
Detailed results for snapshot commands for HBase tables. |
|
hdfsResult |
Detaileds results for snapshot commands for HDFS paths. |
|
id |
The id of the snapshot command. |
integer (int64) |
name |
The name of the snapshot command. |
string |
resultDataUrl |
The URL to the command’s downloadable result data. |
string |
resultMessage |
The result message for a finished command. |
string |
schedule |
The schedule of the snapshot policy. |
|
snapshotName |
The name of the snapshot. |
string |
snapshotRetentionCount |
The number of snapshots to be retained for the snapshot policy. |
|
startTime |
The start time of the snapshot command. |
string (date-time) |
state |
The state of the snapshot created by the snapshot command. |
string |
SnapshotPolicyAlertRequest
Alerting behaviour for snapshot policy activities. Defines whether an alert is sent on certain events related to snapshot policies.
| Name | Description | Schema |
|---|---|---|
onAbort |
Whether to alert on abort of snapshot creation/deletion activity. |
boolean |
onFail |
Whether to alert on failure of snapshot creation/deletion activity. |
boolean |
onStart |
Whether to alert on start of snapshot creation/deletion activity. |
boolean |
onSuccess |
Whether to alert on successful completion of snapshot creation/deletion activity. |
boolean |
SnapshotPolicyAlertResponse
Alerting behaviour for snapshot policy activities. Defines whether an alert is sent on certain events related to snapshot policies.
| Name | Description | Schema |
|---|---|---|
onAbort |
Whether to alert on abort of snapshot creation/deletion activity. |
boolean |
onFail |
Whether to alert on failure of snapshot creation/deletion activity. |
boolean |
onStart |
Whether to alert on start of snapshot creation/deletion activity. |
boolean |
onSuccess |
Whether to alert on successful completion of snapshot creation/deletion activity. |
boolean |
SnapshotPolicyDefinition
Details of the snapshot policy to be created.
| Name | Description | Schema |
|---|---|---|
alert |
Alerting behaviour of the snapshot policy. |
|
hbaseArguments |
Arguments specific to HBase snapshot policies. |
|
hdfsArguments |
Arguments specific to HDFS snapshot policies. |
|
name |
The name of the snapshot policy. |
string |
paused |
Whether to pause the snapshot policy. |
boolean |
schedule |
The schedule of the snapshot policy. |
|
snapshotRetentionCount |
The number of snapshots to be retained for the snapshot policy. |
|
type |
The type of the snapshot policy. |
SnapshotPolicyScheduleRequest
Defines the schedule of a snapshot policy.
| Name | Description | Schema |
|---|---|---|
dayOfMonth |
Day of the month that monthly and yearly snapshots will be created. Valid values are 1 to 31. Additionally 0 to -30 can be used to specify offsets from the last day of the month. |
integer (int32) |
dayOfWeek |
Day of the week that weekly snapshots will be created. Valid values are 1 to 7, 1 representing Sunday. |
integer (int32) |
hourOfDay |
Hour of the day that daily, weekly, monthly and yearly snapshots will be created. Valid values are 0 to 23. |
integer (int32) |
hoursForHourly |
Hours of the day that hourly snapshots will be created. Valid values are 0 to 23. If this list is null or empty, then hourly snapshots are created for every hour. |
< integer (int32) > array |
minuteOfHour |
Minute of the hour that hourly, daily, weekly, monthly and yearly snapshots will be created. Valid values are 0 to 59. |
integer (int32) |
monthOfYear |
Month of the year that yearly snapshots will be created. Valid values are 1 to 12, 1 representing January. |
integer (int32) |
SnapshotPolicyScheduleResponse
Defines the schedule of a snapshot policy.
| Name | Description | Schema |
|---|---|---|
dayOfMonth |
Day of the month that monthly and yearly snapshots will be created. Valid values are 1 to 31. Additionally 0 to -30 can be used to specify offsets from the last day of the month. |
integer (int32) |
dayOfWeek |
Day of the week that weekly snapshots will be created. Valid values are 1 to 7, 1 representing Sunday. |
integer (int32) |
hourOfDay |
Hour of the day that daily, weekly, monthly and yearly snapshots will be created. Valid values are 0 to 23. |
integer (int32) |
hoursForHourly |
Hours of the day that hourly snapshots will be created. Valid values are 0 to 23. If this list is null or empty, then hourly snapshots are created for every hour. |
< integer (int32) > array |
minuteOfHour |
Minute of the hour that hourly, daily, weekly, monthly and yearly snapshots will be created. Valid values are 0 to 59. |
integer (int32) |
monthOfYear |
Month of the year that yearly snapshots will be created. Valid values are 1 to 12, 1 representing January. |
integer (int32) |
SnapshotPolicyType
The snapshot type of snapshot policies.
Type : enum (HDFS, HBASE)
SnapshotResult
The detailed results of a snapshot command.
| Name | Description | Schema |
|---|---|---|
createdSnapshotCount |
The number of snapshots created. |
integer (int64) |
createdSnapshots |
The list of snapshots created. |
< StoredSnapshot > array |
creationErrorCount |
The number of errors encountered when creating snapshots. |
integer (int64) |
creationErrors |
The list of errors encountered when creating snapshots. |
< SnapshotStoreError > array |
deletedSnapshotCount |
The number of snapshots deleted. |
integer (int64) |
deletedSnapshots |
The list of snapshots deleted. |
< StoredSnapshot > array |
deletionErrorCount |
The number of errors encountered when deleting snapshots. |
integer (int64) |
deletionErrors |
The list of errors encountered when deleting snapshots. |
< SnapshotStoreError > array |
processedEntities |
The list of processed entities. Processed tables for HBase, paths for HDFS snapshots. |
< string > array |
processedEntityCount |
The number of processed entities. Processed tables for HBase, paths for HDFS snapshots. |
integer (int64) |
unprocessedEntities |
The list of unprocessed entities. Unprocessed tables for HBase, paths for HDFS snapshots. |
< string > array |
unprocessedEntityCount |
The number of unprocessed entities. Unprocessed tables for HBase, paths for HDFS snapshots. |
integer (int64) |
SnapshotRetentionCountRequest
Defines the number of snapshots to be retained for snapshot policies.
| Name | Description | Schema |
|---|---|---|
dailySnapshots |
The number of daily snapshots to be retained. |
integer (int64) |
hourlySnapshots |
The number of hourly snapshots to be retained. |
integer (int64) |
monthlySnapshots |
The number of monthly snapshots to be retained. |
integer (int64) |
weeklySnapshots |
The number of weekly snapshots to be retained. |
integer (int64) |
yearlySnapshots |
The number of yearly snapshots to be retained. |
integer (int64) |
SnapshotRetentionCountResponse
Defines the number of snapshots to be retained for snapshot policies.
| Name | Description | Schema |
|---|---|---|
dailySnapshots |
The number of daily snapshots to be retained. |
integer (int64) |
hourlySnapshots |
The number of hourly snapshots to be retained. |
integer (int64) |
monthlySnapshots |
The number of monthly snapshots to be retained. |
integer (int64) |
weeklySnapshots |
The number of weekly snapshots to be retained. |
integer (int64) |
yearlySnapshots |
The number of yearly snapshots to be retained. |
integer (int64) |
SnapshotState
The current state of a snapshot policy.
Type : enum (RUNNING, ACTIVE, SUSPENDED, ERROR)
SnapshotStoreError
Detailed description about a snapshot operation error.
| Name | Description | Schema |
|---|---|---|
error |
The description of the error. |
string |
path |
The HDFS path/HBase table name for which the snapshot error occurred. |
string |
snapshotName |
The name of the snapshot. |
string |
SourceDataset
Extra properties for the source dataset.
| Name | Description | Schema |
|---|---|---|
hdfsArguments |
HDFS arguments for HDFS and Hive replication. |
|
hiveArguments |
Arguments for Hive replication, null if HDFS replication. |
SourceUpdateDataset
Extra properties for updating the source dataset.
| Name | Description | Schema |
|---|---|---|
hdfsArguments |
Updatable arguments for HDFS replication. |
|
hiveArguments |
Updatable arguments for Hive replication, null if HDFS replication. |
StoredSnapshot
Detailed description about a snapshot.
| Name | Description | Schema |
|---|---|---|
creationTime |
The creation time of the snapshot. |
string (date-time) |
path |
The snapshotted HDFS path/HBase table. |
string |
snapshotName |
The name of the snapshot. |
string |
snapshotPath |
The fully qualified path of the snapshot. |
string |
storage |
Whether the snapshot is stored locally or remotely. |
SuspendHbasePolicyRequest
Suspend an HBase replication policy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the destination cluster. |
string |
policyId |
ID of the HBase policy. |
string |
SuspendHbasePolicyResponse
Response object for suspendHbasePolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the input cluster. |
string |
message |
The detailed description of the action taken. |
string |
status |
The status of the request. |
string |
SuspendPolicyRequest
Suspend a replication policy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the cluster where the policy is. |
string |
policyName |
Policy name to suspend. |
string |
SuspendPolicyResponse
Response object for suspendPolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the input cluster. |
string |
message |
The detailed description of the action taken. |
string |
requestId |
The ID of the request. Populated only for Ambari backend. |
string |
status |
The status of the request. |
string |
SuspendSnapshotPolicyRequest
Request object for suspendSnapshotPolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the cluster where the snapshot policy is. |
string |
name |
The name of the snapshot policy to be suspended. |
string |
SuspendSnapshotPolicyResponse
Response object for suspendSnapshotPolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the cluster where the snapshot policy is. |
string |
message |
The detailed description of the action taken. |
string |
status |
The status of the request. |
string |
TargetDetails
Target details.
| Name | Description | Schema |
|---|---|---|
environmentCrn |
Target’s environment CRN. |
string |
warehouseCrn |
Target’s warehouse CRN. |
string |
UpdateAbfsAccessKeyCredentialRequest
Request object for updating ABFS Access Key based accounts in DLM Engine.
| Name | Description | Schema |
|---|---|---|
accessKey |
ABFS access key. |
string |
name |
Name of the credential to update. |
string |
storageAccountName |
ABFS storage account name. |
string |
UpdateAbfsAccessKeyCredentialResponse
Response object for updating ABFS Access Key based accounts in DLM Engine.
| Name | Description | Schema |
|---|---|---|
errors |
The list of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters). |
< ApiError > array |
UpdateAbfsClientKeyCredentialRequest
Request object for updating Azure Active Directory Service Principal accounts in Cloudera Manager.
| Name | Description | Schema |
|---|---|---|
clientId |
Client ID of an Active Directory service principal account. |
string |
clientSecretKey |
Client Key of an Active Directory service principal account. |
string |
name |
Name of the credential to update. |
string |
tenantId |
Tenant ID of an Active Directory service principal account. |
string |
UpdateAbfsClientKeyCredentialResponse
Response object for updating Azure Active Directory Service Principal accounts in Cloudera Manager.
| Name | Description | Schema |
|---|---|---|
errors |
The list of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters). |
< ApiError > array |
UpdateAwsAccessKeyCredentialRequest
Request object for updating AWS Access Key cloud credentials.
| Name | Description | Schema |
|---|---|---|
accessKey |
AWS access key. |
string |
name |
Name of the credential to update. |
string |
secretKey |
AWS secret key. |
string |
UpdateAwsAccessKeyCredentialResponse
Response object for updating AWS Access Key cloud credentials.
| Name | Description | Schema |
|---|---|---|
errors |
The list of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters). |
< ApiError > array |
UpdateAwsIamCredentialRequest
Request object for updating AWS IAM Role based cloud credentials.
| Name | Description | Schema |
|---|---|---|
name |
Name of the credential to update. |
string |
UpdateAwsIamCredentialResponse
Response object for updating AWS IAM Role based cloud credentials.
| Name | Description | Schema |
|---|---|---|
errors |
The list of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters). |
< ApiError > array |
UpdateAwsIdbrokerCredentialRequest
Request object for updating AWS IdBroker cloud credentials.
| Name | Description | Schema |
|---|---|---|
idbrokerAddress |
The address of the IDBroker endpoint that will be used for authentication, for example http(s)://[IDBROKER_HOST]:[IDBROKER_PORT]/gateway. |
string |
idbrokerCabPath |
The name of the IDBroker topology that will be used for authentication. |
string |
name |
Name of the credential to update. |
string |
UpdateAwsIdbrokerCredentialResponse
Response object for updating AWS IdBroker cloud credentials.
| Name | Description | Schema |
|---|---|---|
errors |
The list of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters). |
< ApiError > array |
UpdateGcsPrivateKeyCredentialRequest
Request object for updating GCS Private Key cloud credentials.
| Name | Description | Schema |
|---|---|---|
clientEmail |
Client email. |
string |
name |
Name of the credential to update. |
string |
privateKey |
GCS private key. |
string |
privateKeyId |
GCS private key ID. |
string |
UpdateGcsPrivateKeyCredentialResponse
Response object for updating GCS Private Key cloud credentials.
| Name | Description | Schema |
|---|---|---|
errors |
The list of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters). |
< ApiError > array |
UpdateHbasePolicyDefinition
HBase policy update request definition.
| Name | Description | Schema |
|---|---|---|
description |
Description of the policy. |
string |
name |
The policy name. |
string |
tables |
List of tables to be replicated. The items should be in "namespace:tablename" format. |
< string > array |
UpdateHbasePolicyRequest
Update HBase replication policy request.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the cluster where the policy will be updated. |
string |
policyId |
The ID of the policy to be updated. |
string |
updateHbasePolicyDefinition |
The policy definition. |
UpdateHbasePolicyResponse
Response object for updateHbasePolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the input cluster. |
string |
message |
The detailed description of the action taken. |
string |
requestId |
The ID of the request. Populated only for Ambari backend. |
string |
status |
The status of the request (Successful or an error). |
string |
UpdatePolicyDefinition
Policy update request definition.
| Name | Description | Schema |
|---|---|---|
cloudEncryptionAlgorithm |
The type of cloud encryption algorithm. Can be used only for HDP/Ambari managed clusters. Supported values are AES256,SSE-KMS. |
string |
cloudEncryptionKey |
The encryption key for the selected cloud encryption algorithm. |
string |
cmPolicySubmitUser |
CM policy submit user. |
|
description |
Description of the policy. |
string |
distcpMapBandwidth |
Maximum bandwidth to use for replication. |
integer (int64) |
distcpMaxMaps |
Maximum Map jobs to use for replication. |
integer (int64) |
enableSnapshotBasedReplication |
Whether to enable snapshot based replication. |
boolean |
endTime |
Policy end time. |
string (date-time) |
frequencyInSec |
Policy’s frequency in seconds. |
integer (int64) |
hiveExternalTableBaseDirectory |
The base directory path on the target where to put the replicated Hive external tables. |
string |
name |
The policy name. |
string |
plugins |
The list of plugins. |
< string > array |
queueName |
YARN queue name if not default. |
string |
sourceUpdateDataset |
The source dataset to replicate. |
|
startTime |
Policy start time. |
string (date-time) |
suspend |
Whether to suspend the policy. Changing this is the same as using suspend-policy (suspend = true) and activate-policy (suspend = false). |
boolean |
targetDataset |
The path of the dataset to replicate to. |
string |
tdeSameKey |
Whether to use TDE same key. |
boolean |
UpdatePolicyRequest
Update a replication policy request.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the cluster where the policy will be updated. |
string |
policyId |
The ID of the policy to be updated. |
string |
updatePolicyDefinition |
The policy definition. |
UpdatePolicyResponse
Response object for updatePolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the input cluster. |
string |
message |
The detailed description of the action taken. |
string |
requestId |
The ID of the request. Populated only for Ambari backend. |
string |
status |
The status of the request (Successful or an error). |
string |
UpdateSnapshotPolicyRequest
Request object for updateSnapshotPolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the cluster where the snapshot policy will be updated. |
string |
name |
The name of the snapshot policy to be updated. |
string |
snapshotPolicyDefinition |
The details of the snapshot policy to be updated. |
UpdateSnapshotPolicyResponse
Response object for updateSnapshotPolicy.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the cluster from where the snapshot policy has been updated. |
string |
message |
The detailed description of the action taken. |
string |
status |
The status of the request. |
string |
VerificationSteps
Verification steps.
| Name | Description | Schema |
|---|---|---|
clusterManagerUrl |
The cluster manager URL to reach the cluster’s UI. |
string |
steps |
The list of manual steps to perform or verify. |
< string > array |
VerifyHbaseClusterPairRequest
Request to verify a cluster pairing for HBase policy creation prerequisites.
| Name | Description | Schema |
|---|---|---|
destinationClusterCrn |
CRN of the destination cluster. |
string |
sourceClusterCrn |
CRN of the source cluster. |
string |
VerifyHbaseClusterPairResponse
Response object for verifyHbaseClusterPair.
| Name | Description | Schema |
|---|---|---|
afterPolicySteps |
Manual steps to perform after HBase policy creation. |
|
beforePolicySteps |
Manual steps to perform before HBase policy creation. |
|
pairedStatus |
Substatus of an active pairing. Indicates if a pairing is resettable or in an erroneous state. |
string |
pairingMessage |
Description of the pairing status. |
string |
pairingStatus |
The current status of pairing. |
string |
afterPolicySteps
| Name | Description | Schema |
|---|---|---|
destination |
Steps to perform for the destination cluster. |
|
source |
Steps to perform for the source cluster. |
|
summary |
Summary of the steps to perform. |
string |
beforePolicySteps
| Name | Description | Schema |
|---|---|---|
destination |
Steps to perform for the destination cluster. |
|
documentationLink |
Link to the HBase replication manual steps documentation. |
string |
source |
Steps to perform for the source cluster. |
|
summary |
Summary of the steps to perform. |
string |