From 435163a6de5735115f82239b2a17f63b301b6374 Mon Sep 17 00:00:00 2001 From: SRE Service Date: Thu, 31 Oct 2024 12:28:23 -0700 Subject: [PATCH] CDP API Documentation 0.9.125 --- api-docs/CHANGELOG.md | 19 + api-docs/README.md | 38 +- api-docs/audit/index.html | 4 +- api-docs/cloudprivatelinks/index.html | 4 +- api-docs/compute/index.html | 4 +- api-docs/consumption/index.html | 4 +- api-docs/datacatalog/index.html | 4 +- api-docs/datahub/index.html | 4 +- api-docs/datalake/index.html | 181 +- api-docs/de/index.html | 4 +- api-docs/df/index.html | 4 +- api-docs/dfworkload/index.html | 4 +- api-docs/drscp/index.html | 4 +- api-docs/dw/index.html | 52 +- api-docs/environments/index.html | 1313 ++++-- api-docs/iam/index.html | 4 +- api-docs/imagecatalog/index.html | 4 +- api-docs/ml/index.html | 16 +- api-docs/opdb/index.html | 111 +- api-docs/replicationmanager/index.html | 5355 ++++++++++++++++------ api-docs/swagger/README.md | 38 +- api-docs/swagger/audit.yaml | 2 +- api-docs/swagger/cloudprivatelinks.yaml | 2 +- api-docs/swagger/compute.yaml | 12 +- api-docs/swagger/consumption.yaml | 2 +- api-docs/swagger/datacatalog.yaml | 2 +- api-docs/swagger/datahub.yaml | 2 +- api-docs/swagger/datalake.yaml | 54 +- api-docs/swagger/de.yaml | 2 +- api-docs/swagger/df.yaml | 2 +- api-docs/swagger/dfworkload.yaml | 2 +- api-docs/swagger/drscp.yaml | 2 +- api-docs/swagger/dw.yaml | 74 +- api-docs/swagger/environments.yaml | 184 +- api-docs/swagger/iam.yaml | 2 +- api-docs/swagger/imagecatalog.yaml | 2 +- api-docs/swagger/ml.yaml | 5 +- api-docs/swagger/opdb.yaml | 27 +- api-docs/swagger/replicationmanager.yaml | 630 ++- 39 files changed, 6293 insertions(+), 1886 deletions(-) diff --git a/api-docs/CHANGELOG.md b/api-docs/CHANGELOG.md index e3f55d0a9..cb4f2367e 100644 --- a/api-docs/CHANGELOG.md +++ b/api-docs/CHANGELOG.md @@ -1,5 +1,24 @@ # CDP Control Plane Public API Changelog +## 0.9.125 (2024-10-30) +* datalake: Add new object 'DiskOptions' to 'StartDatalakeVerticalScalingRequest' & 'startDatalakeVerticalScaling' object. +* datalake: Add new object 'AddDisks', 'ModifyDisks' to 'DiskOptions' object. +* datalake: Add support for adding new additional storages or modifying existing additional storages to 'startDatalakeVerticalScaling' command. +* replicationmanager: Support for HBase replication with create-hbase-policy, update-hbase-policy, continue-hbase-setup, suspend-hbase-policy, activate-hbase-policy, delete-hbase-policy, list-paired-hbase-clusters and verify-hbase-cluster-pair commands. +* replicationmanager: Add get-cluster-config command. +* environments: Add 'azureDetails' to the 'Environment' object. +* environments: Add new commands 'initializeAWSComputeCluster' and 'initializeAzureComputeCluster'. +* environments: Add new properties 'enableComputeCluster' and 'computeClusterConfiguration' to 'CreateAWSEnvironmentRequest' object. +* environments: Add new properties 'enableComputeCluster' and 'computeClusterConfiguration' to 'CreateAzureEnvironmentRequest' object. +* environments: Add new property 'computeClusterEnabled' to 'EnvironmentSummary' object. +* environments: Add new property 'awsComputeClusterConfiguration', 'azureComputeClusterConfiguration' and 'computeClusterEnabled' to 'Environment' object. +* dw: Deprecate property 'downloadOptions' in 'CreateDbcDiagnosticDataJobRequest'. +* dw: Deprecate properties 'hiveDownloadOptions' and 'impalaDownloadOptions' in 'CreateDbcDiagnosticDataJobResponse'. +* dw: Deprecate 'HiveCreateDiagnosticDataDownloadOptions', 'ImpalaCreateDiagnosticDataDownloadOptions', 'DBCCreateDiagnosticDataDownloadOptions' and 'ClusterCreateDiagnosticDataDownloadOptions'. + +BACKWARD INCOMPATIBILITIES: +* ml: Remove 'isCrossNsBackup' option from 'BackupDetail' object. + ## 0.9.124 (2024-10-16) * ml: Change descriptions of APIs to reflect naming change from `Cloudera Machine Learning` to `Cloudera AI`. * ml: Add new command `addInstanceGroups`. diff --git a/api-docs/README.md b/api-docs/README.md index 3ec38e83f..3639ca766 100644 --- a/api-docs/README.md +++ b/api-docs/README.md @@ -1,6 +1,6 @@ # CDP Control Plane Public API Documentation -*Version: 0.9.124* +*Version: 0.9.125* [CHANGELOG](CHANGELOG.md) @@ -8,24 +8,24 @@ Available documentation is listed by service below. | Service | Version | | --- | --- | -| [audit](./audit/index.html) | 0.9.124 | -| [cloudprivatelinks](./cloudprivatelinks/index.html) | 0.9.124 | -| [compute](./compute/index.html) | 0.9.124 | -| [consumption](./consumption/index.html) | 0.9.124 | -| [datacatalog](./datacatalog/index.html) | 0.9.124 | -| [datahub](./datahub/index.html) | 0.9.124 | -| [datalake](./datalake/index.html) | 0.9.124 | -| [de](./de/index.html) | 0.9.124 | -| [df](./df/index.html) | 0.9.124 | -| [dfworkload](./dfworkload/index.html) | 0.9.124 | -| [drscp](./drscp/index.html) | 0.9.124 | -| [dw](./dw/index.html) | 0.9.124 | -| [environments](./environments/index.html) | 0.9.124 | -| [iam](./iam/index.html) | 0.9.124 | -| [imagecatalog](./imagecatalog/index.html) | 0.9.124 | -| [ml](./ml/index.html) | 0.9.124 | -| [opdb](./opdb/index.html) | 0.9.124 | -| [replicationmanager](./replicationmanager/index.html) | 0.9.124 | +| [audit](./audit/index.html) | 0.9.125 | +| [cloudprivatelinks](./cloudprivatelinks/index.html) | 0.9.125 | +| [compute](./compute/index.html) | 0.9.125 | +| [consumption](./consumption/index.html) | 0.9.125 | +| [datacatalog](./datacatalog/index.html) | 0.9.125 | +| [datahub](./datahub/index.html) | 0.9.125 | +| [datalake](./datalake/index.html) | 0.9.125 | +| [de](./de/index.html) | 0.9.125 | +| [df](./df/index.html) | 0.9.125 | +| [dfworkload](./dfworkload/index.html) | 0.9.125 | +| [drscp](./drscp/index.html) | 0.9.125 | +| [dw](./dw/index.html) | 0.9.125 | +| [environments](./environments/index.html) | 0.9.125 | +| [iam](./iam/index.html) | 0.9.125 | +| [imagecatalog](./imagecatalog/index.html) | 0.9.125 | +| [ml](./ml/index.html) | 0.9.125 | +| [opdb](./opdb/index.html) | 0.9.125 | +| [replicationmanager](./replicationmanager/index.html) | 0.9.125 | API documentation uses the Adoc Riak stylesheet from [https://github.com/darshandsoni/asciidoctor-skins](https://github.com/darshandsoni/asciidoctor-skins). diff --git a/api-docs/audit/index.html b/api-docs/audit/index.html index 46c054ec6..7ce0e0312 100644 --- a/api-docs/audit/index.html +++ b/api-docs/audit/index.html @@ -822,7 +822,7 @@

Overview

Version information

-

Version : 0.9.124

+

Version : 0.9.125

@@ -3910,7 +3910,7 @@

MarkArchiveBatchesAsSuccessfulR


diff --git a/api-docs/cloudprivatelinks/index.html b/api-docs/cloudprivatelinks/index.html index ae0ca947e..bb99ceba8 100644 --- a/api-docs/cloudprivatelinks/index.html +++ b/api-docs/cloudprivatelinks/index.html @@ -775,7 +775,7 @@

Overview

Version information

-

Version : 0.9.124

+

Version : 0.9.125

@@ -2734,7 +2734,7 @@

RevokePrivateLinkServiceAccessRes


diff --git a/api-docs/compute/index.html b/api-docs/compute/index.html index c326a2e77..8f0ce354a 100644 --- a/api-docs/compute/index.html +++ b/api-docs/compute/index.html @@ -827,7 +827,7 @@

Overview

Version information

-

Version : 0.9.124

+

Version : 0.9.125

@@ -7493,7 +7493,7 @@

ValidationSummary


diff --git a/api-docs/consumption/index.html b/api-docs/consumption/index.html index 190d9ef2f..c6a25b87c 100644 --- a/api-docs/consumption/index.html +++ b/api-docs/consumption/index.html @@ -720,7 +720,7 @@

Overview

Version information

-

Version : 0.9.124

+

Version : 0.9.125

@@ -1259,7 +1259,7 @@

ListComputeUsageRecordsResponse


diff --git a/api-docs/datacatalog/index.html b/api-docs/datacatalog/index.html index 657dc63c5..80a96d70f 100644 --- a/api-docs/datacatalog/index.html +++ b/api-docs/datacatalog/index.html @@ -721,7 +721,7 @@

Overview

Version information

-

Version : 0.9.124

+

Version : 0.9.125

@@ -1220,7 +1220,7 @@

LaunchProfilersResponse


diff --git a/api-docs/datahub/index.html b/api-docs/datahub/index.html index 14571f191..b4bd0f83e 100644 --- a/api-docs/datahub/index.html +++ b/api-docs/datahub/index.html @@ -1359,7 +1359,7 @@

Overview

Version information

-

Version : 0.9.124

+

Version : 0.9.125

@@ -18016,7 +18016,7 @@

VolumeEncryptionRequest


diff --git a/api-docs/datalake/index.html b/api-docs/datalake/index.html index 470f20d48..276914a06 100644 --- a/api-docs/datalake/index.html +++ b/api-docs/datalake/index.html @@ -1039,6 +1039,7 @@

Cloudera Datalake Service

@@ -871,7 +962,7 @@

Overview

Version information

-

Version : 0.9.124

+

Version : 0.9.125

@@ -913,16 +1004,16 @@

Produces

Paths

-

Resume all replication tasks defined by the policy.

+

Resume a suspended HBase replication policy.

-
POST /api/v1/replicationmanager/activatePolicy
+
POST /api/v1/replicationmanager/activateHbasePolicy

Description

-

Resumes all replication tasks defined by the policy if the policy is currently suspended.

+

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.

@@ -950,7 +1041,7 @@

Parameters

required

@@ -980,7 +1071,7 @@

Responses

Describes a successful response to a valid request.

@@ -999,16 +1090,16 @@

Responses

-

Collect diagnostic bundle for a policy.

+

Resume all replication tasks defined by the policy.

-
POST /api/v1/replicationmanager/collectDiagnosticBundle
+
POST /api/v1/replicationmanager/activatePolicy

Description

-

Triggers the collection of diagnostic bundle for a policy.

+

Resumes all replication tasks defined by the policy if the policy is currently suspended.

@@ -1036,7 +1127,7 @@

Parameters

required

@@ -1066,7 +1157,7 @@

Responses

Describes a successful response to a valid request.

@@ -1085,16 +1176,16 @@

Responses

-

Create an ABFS Cloud Credential.

+

Collect diagnostic bundle for a policy.

-
POST /api/v1/replicationmanager/createAbfsCredential
+
POST /api/v1/replicationmanager/collectDiagnosticBundle

Description

-

Creates a new ABFS cloud credential.

+

Triggers the collection of diagnostic bundle for a policy.

@@ -1122,7 +1213,7 @@

Parameters

required

@@ -1152,7 +1243,7 @@

Responses

Describes a successful response to a valid request.

@@ -1171,16 +1262,16 @@

Responses

-

Create an AWS Cloud Credential.

+

Continue the setup of an HBase policy.

-
POST /api/v1/replicationmanager/createAwsCredential
+
POST /api/v1/replicationmanager/continueHbaseSetup

Description

-

Creates a new AWS cloud credential.

+

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.

@@ -1208,7 +1299,7 @@

Parameters

required

@@ -1238,7 +1329,7 @@

Responses

Describes a successful response to a valid request.

@@ -1257,16 +1348,16 @@

Responses

-

Create a Replication Policy.

+

Create an ABFS Cloud Credential.

-
POST /api/v1/replicationmanager/createPolicy
+
POST /api/v1/replicationmanager/createAbfsCredential

Description

-

Creates a new replication policy with the given name on a specific cluster.

+

Creates a new ABFS cloud credential.

@@ -1294,7 +1385,7 @@

Parameters

required

@@ -1324,7 +1415,7 @@

Responses

Describes a successful response to a valid request.

@@ -1343,16 +1434,16 @@

Responses

-

Delete Cloud Credential.

+

Create an AWS Cloud Credential.

-
POST /api/v1/replicationmanager/deleteCredential
+
POST /api/v1/replicationmanager/createAwsCredential

Description

-

Permanently deletes a specific cloud credential.

+

Creates a new AWS cloud credential.

@@ -1380,7 +1471,7 @@

Parameters

required

@@ -1410,7 +1501,7 @@

Responses

Describes a successful response to a valid request.

@@ -1429,16 +1520,16 @@

Responses

-

Delete Replication Policy.

+

Create an HBase Replication Policy.

-
POST /api/v1/replicationmanager/deletePolicy
+
POST /api/v1/replicationmanager/createHbasePolicy

Description

-

Permanently deletes a specific replication policy.

+

Creates a new HBase replication policy with the given name on a specific cluster.

@@ -1466,7 +1557,7 @@

Parameters

required

@@ -1496,7 +1587,7 @@

Responses

Describes a successful response to a valid request.

@@ -1515,16 +1606,16 @@

Responses

-

Download diagnostic bundle for a policy.

+

Create a Replication Policy.

-
POST /api/v1/replicationmanager/downloadDiagnosticBundle
+
POST /api/v1/replicationmanager/createPolicy

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.

+

Creates a new replication policy with the given name on a specific cluster.

@@ -1552,7 +1643,7 @@

Parameters

required

@@ -1582,7 +1673,7 @@

Responses

Describes a successful response to a valid request.

@@ -1601,16 +1692,16 @@

Responses

-

Get the status of the given CM command.

+

Delete Cloud Credential.

-
POST /api/v1/replicationmanager/getCommandStatus
+
POST /api/v1/replicationmanager/deleteCredential

Description

-

Return the current status of the given CM command.

+

Permanently deletes a specific cloud credential.

@@ -1638,7 +1729,7 @@

Parameters

required

@@ -1668,7 +1759,7 @@

Responses

Describes a successful response to a valid request.

@@ -1687,16 +1778,16 @@

Responses

-

Get Cloud Credentials from a Cluster.

+

Delete an HBase Replication Policy.

-
POST /api/v1/replicationmanager/getCredentials
+
POST /api/v1/replicationmanager/deleteHbasePolicy

Description

-

Returns cloud credentials on a specific cluster.

+

Permanently deletes a specific HBase replication policy.

@@ -1724,7 +1815,7 @@

Parameters

required

@@ -1754,7 +1845,7 @@

Responses

Describes a successful response to a valid request.

@@ -1773,16 +1864,16 @@

Responses

-

Lists Cloud Credentials.

+

Delete Replication Policy.

-
POST /api/v1/replicationmanager/listAllCredentials
+
POST /api/v1/replicationmanager/deletePolicy

Description

-

Provides a detailed list of cloud credentials across all available clusters.

+

Permanently deletes a specific replication policy.

@@ -1810,7 +1901,7 @@

Parameters

required

@@ -1840,7 +1931,7 @@

Responses

Describes a successful response to a valid request.

@@ -1859,16 +1950,16 @@

Responses

-

Lists Cluster Service Statuses.

+

Download diagnostic bundle for a policy.

-
POST /api/v1/replicationmanager/listClusterServiceStatuses
+
POST /api/v1/replicationmanager/downloadDiagnosticBundle

Description

-

Provides a list of cluster service (e.g. HDFS, Hive, YARN, etc.) statuses.

+

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.

@@ -1896,7 +1987,7 @@

Parameters

required

@@ -1926,7 +2017,7 @@

Responses

Describes a successful response to a valid request.

@@ -1945,16 +2036,16 @@

Responses

-

Lists all clusters.

+

Get configuration of a cluster.

-
POST /api/v1/replicationmanager/listClusters
+
POST /api/v1/replicationmanager/getClusterConfig

Description

-

Provides a detailed list of all available clusters.

+

Retrieves configuration of a specific cluster.

@@ -1982,7 +2073,7 @@

Parameters

required

@@ -2012,7 +2103,7 @@

Responses

Describes a successful response to a valid request.

@@ -2031,16 +2122,16 @@

Responses

-

Get All Replication Policies.

+

Get the status of the given CM command.

-
POST /api/v1/replicationmanager/listPolicies
+
POST /api/v1/replicationmanager/getCommandStatus

Description

-

Provides a list of all replication policies across all available clusters.

+

Return the current status of the given CM command.

@@ -2068,7 +2159,7 @@

Parameters

required

@@ -2098,7 +2189,7 @@

Responses

Describes a successful response to a valid request.

@@ -2117,16 +2208,16 @@

Responses

-

Stop all replication tasks defined by the policy.

+

Get Cloud Credentials from a Cluster.

-
POST /api/v1/replicationmanager/suspendPolicy
+
POST /api/v1/replicationmanager/getCredentials

Description

-

Stops all replication tasks defined by the policy. Replication will resume after activating the policy.

+

Returns cloud credentials on a specific cluster.

@@ -2154,7 +2245,7 @@

Parameters

required

@@ -2184,7 +2275,7 @@

Responses

Describes a successful response to a valid request.

@@ -2202,89 +2293,61 @@

Responses

- - -
-

Definitions

-
-

AbfsCloudCredentialType

-
-

ABFS cloud credential type.

-
-
-

Type : enum (ACCESSKEY, CLIENTKEY)

+

Lists Cloud Credentials.

+
+
+
POST /api/v1/replicationmanager/listAllCredentials
-
-

ActivatePolicyRequest

+
+

Description

-

Activate a replication policy.

+

Provides a detailed list of cloud credentials across all available clusters.

+
+
+

Parameters

---+++ + - - - - - -
Type NameDescription Schema
-

clusterCrn
-required

-
-

CRN of the cluster where the policy is.

-
-

string

+

Body

-

policyName
+

input
required

-

Policy name to resume.

-
-
-

ActivatePolicyResponse

-
-

Response object for resumePolicy.

-
-
-

Type : object

-
-
-
-

Alert

-
-

Cloudera Manager alerting behavior.

-
+
+

Responses

---+++ - + @@ -2292,256 +2355,2579 @@

Alert

- - - - - - - - - -
NameHTTP Code Description Schema
-

onAbort
-required

+

200

-

Alert on abort.

-
-

boolean

-
-

onFailure
-required

-
-

Alert on failure.

-
-

boolean

-
-

onStart
-required

-
-

Alert on start.

+

Describes a successful response to a valid request.

-

onSuccess
-required

+

default

-

ALert on success.

+

The default response on an error.

-

boolean

+

Error

+
-

ApiError

+

Lists Cluster Service Statuses.

+
+
+
POST /api/v1/replicationmanager/listClusterServiceStatuses
+
+
+
+

Description

-

API error.

+

Provides a list of cluster service (e.g. HDFS, Hive, YARN, etc.) statuses.

+
+
+

Parameters

---+++ + - - - - - - + +
Type NameDescription Schema
-

clusterUrl
-optional

-
-

Cluster URL.

-
-

string

+

Body

-

code
+

input
required

-

Error code.

-
+
+
+

Responses

+ +++++ + - - - + + + + +
-

message
-required

-
-

Error message.

-
-

string

-
HTTP CodeDescriptionSchema
-

requestId
-optional

+

200

-

Request ID.

+

Describes a successful response to a valid request.

-

status
-required

+

default

-

Error status.

+

The default response on an error.

-

string

+

Error

-
-

AwsCloudCredentialType

-
-

AWS cloud credential type.

-
-

Type : enum (IAM, ACCESSKEY)

+
+

Lists all clusters.

+
+
+
POST /api/v1/replicationmanager/listClusters
-
-

Cluster

+
+

Description

-

Describes a Datalake, Datahub or Classic cluster.

+

Provides a detailed list of all available clusters.

+
+
+

Parameters

---+++ + - + +
Type NameDescription Schema
-

cloudAccountProvider
-optional

+

Body

-

Cloud account provider.

+

input
+required

-

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

+

ListClustersRequest

+
+
+

Responses

+ +++++ + - - - + + + + + + +
-

clusterManagerType
-required

-
-

Cluster Manager type.

-
-

enum (CLOUDERA_MANAGER, AMBARI)

-
HTTP CodeDescriptionSchema
-

clusterManagerUrl
-required

+

200

-

Cluster Manager URL.

+

Describes a successful response to a valid request.

-

clusterType
-required

+

default

-

Cluster type.

+

The default response on an error.

-

enum (CLASSIC, SDX, DISTROX)

+

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

+ +++++ + + + + + + + + + +
TypeNameSchema
-

clusterUrl
-required

+

Body

-

Cluster URL.

+

input
+required

+
+
+

Responses

+ +++++ + + + + + + + + - - +
HTTP CodeDescriptionSchema
-

cmName
-optional

+

200

-

Cloudera Manager name.

+

Describes a successful response to a valid request.

-

codProperties
-optional

+

default

-

Additional properties for operational databases.

+

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

+ +++++ + + + + + + + + + + + + + + +
TypeNameSchema
+

Body

+
+

input
+required

+
+
+
+

Responses

+ +++++ + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

Describes a successful response to a valid request.

+
+

default

+
+

The default response on an error.

+
+

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

+ +++++ + + + + + + + + + + + + + + +
TypeNameSchema
+

Body

+
+

input
+required

+
+
+
+

Responses

+ +++++ + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

Describes a successful response to a valid request.

+
+

default

+
+

The default response on an error.

+
+

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

+ +++++ + + + + + + + + + + + + + + +
TypeNameSchema
+

Body

+
+

input
+required

+
+
+
+

Responses

+ +++++ + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

Describes a successful response to a valid request.

+
+

default

+
+

The default response on an error.

+
+

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

+ +++++ + + + + + + + + + + + + + + +
TypeNameSchema
+

Body

+
+

input
+required

+
+
+
+

Responses

+ +++++ + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

Describes a successful response to a valid request.

+
+

default

+
+

The default response on an error.

+
+

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

+ +++++ + + + + + + + + + + + + + + +
TypeNameSchema
+

Body

+
+

input
+required

+
+
+
+

Responses

+ +++++ + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

Describes a successful response to a valid request.

+
+

default

+
+

The default response on an error.

+
+

Error

+
+
+
+
+
+
+

Definitions

+
+
+

AbfsCloudCredentialType

+
+

ABFS cloud credential type.

+
+
+

Type : enum (ACCESSKEY, CLIENTKEY)

+
+
+
+

ActivateHbasePolicyRequest

+
+

Activate an HBase replication policy.

+
+ +++++ + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

clusterCrn
+required

+
+

CRN of the destination cluster.

+
+

string

+
+

policyId
+required

+
+

ID of the HBase policy.

+
+

string

+
+
+
+

ActivateHbasePolicyResponse

+
+

Response object for activateHbasePolicy.

+
+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

clusterCrn
+optional

+
+

The CRN of the input cluster.

+
+

string

+
+

message
+optional

+
+

The detailed description of the action taken.

+
+

string

+
+

status
+optional

+
+

The status of the request.

+
+

string

+
+
+
+

ActivatePolicyRequest

+
+

Activate a replication policy.

+
+ +++++ + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

clusterCrn
+required

+
+

CRN of the cluster where the policy is.

+
+

string

+
+

policyName
+required

+
+

Policy name to resume.

+
+

string

+
+
+
+

ActivatePolicyResponse

+
+

Response object for resumePolicy.

+
+
+

Type : object

+
+
+
+

Alert

+
+

Cloudera Manager alerting behavior.

+
+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

onAbort
+required

+
+

Alert on abort.

+
+

boolean

+
+

onFailure
+required

+
+

Alert on failure.

+
+

boolean

+
+

onStart
+required

+
+

Alert on start.

+
+

boolean

+
+

onSuccess
+required

+
+

ALert on success.

+
+

boolean

+
+
+
+

ApiError

+
+

API error.

+
+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

clusterUrl
+optional

+
+

Cluster URL.

+
+

string

+
+

code
+required

+
+

Error code.

+
+

integer (int32)

+
+

message
+required

+
+

Error message.

+
+

string

+
+

requestId
+optional

+
+

Request ID.

+
+

string

+
+

status
+required

+
+

Error status.

+
+

string

+
+
+
+

AwsCloudCredentialType

+
+

AWS cloud credential type.

+
+
+

Type : enum (IAM, ACCESSKEY)

+
+
+
+

Cluster

+
+

Describes a Datalake, Datahub or Classic cluster.

+
+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

cloudAccountProvider
+optional

+
+

Cloud account provider.

+
+

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

+
+

clusterManagerType
+required

+
+

Cluster Manager type.

+
+

enum (CLOUDERA_MANAGER, AMBARI)

+
+

clusterManagerUrl
+required

+
+

Cluster Manager URL.

+
+

string

+
+

clusterType
+required

+
+

Cluster type.

+
+

enum (CLASSIC, SDX, DISTROX)

+
+

clusterUrl
+required

+
+

Cluster URL.

+
+

string

+
+

cmName
+optional

+
+

Cloudera Manager name.

+
+

string

+
+

codProperties
+optional

+
+

Additional properties for operational databases.

+

crn
required

-

Cluster CRN.

+

Cluster CRN.

+
+

string

+
+

dataCenter
+required

+
+

Cluster data center.

+
+

string

+
+

description
+optional

+
+

Cluster description.

+
+

string

+
+

environmentCrn
+optional

+
+

CRN of the cluster’s environment.

+
+

string

+
+

knoxUrl
+optional

+
+

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

+
+

string

+
+

location
+optional

+
+

Cluster location.

+
+

name
+required

+
+

Cluster name.

+
+

string

+
+

replicationEngineType
+required

+
+

Replication engine type.

+
+

enum (CM, DLM_ENGINE)

+
+

stackCrn
+optional

+
+

Stack CRN.

+
+

string

+
+

stackMajorVersion
+optional

+
+

Stack major version.

+
+

string

+
+

stackVersion
+optional

+
+

Stack version.

+
+

string

+
+

totalHosts
+optional

+
+

Total hosts on the cluster.

+
+

integer (int32)

+
+

uuid
+optional

+
+

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

+
+

string

+
+
+
+

ClusterServiceStatuses

+
+

Describes the status of services running on a cluster.

+
+ +++++ + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

clusterCrn
+required

+
+

Cluster CRN.

+
+

string

+
+

serviceStatuses
+required

+
+

List of service statuses.

+
+

< ServiceInfo > array

+
+
+
+

CmPolicySubmitUser

+
+

CM Policy submit user.

+
+ +++++ + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

sourceUser
+optional

+
+

Source user.

+
+

string

+
+

userName
+optional

+
+

Username.

+
+

string

+
+
+
+

CodProperties

+
+

Additional properties for operational databases.

+
+ +++++ + + + + + + + + + + + + + + +
NameDescriptionSchema
+

operationalDatabaseName
+optional

+
+

Name of the corresponding operational database..

+
+

string

+
+
+
+

CollectDiagnosticBundleRequest

+
+

Triggers a diagnostic bundle collect command for the given cluster and policyName.

+
+ +++++ + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

clusterCrn
+required

+
+

The CRN of the target cluster.

+
+

string

+
+

policyName
+required

+
+

Name of the policy.

+
+

string

+
+
+
+

CollectDiagnosticBundleResponse

+
+

Response object for collect-diagnostic-bundle.

+
+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

active
+optional

+
+

Whether the diagnostic bundle command is active.

+
+

boolean

+
+

commandId
+required

+
+

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

+
+

integer (int64)

+
+

name
+optional

+
+

Name of the policy.

+
+

string

+
+

resultMessage
+optional

+
+

Diagnostic bundle collection command result message.

+
+

string

+
+

startTime
+optional

+
+

Start time of the diagnostic bundle collection command.

+
+

string

+
+
+
+

ContinueHbaseSetupRequest

+
+

Continue an HBase setup for Classic Cluster source.

+
+ +++++ + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

clusterCrn
+required

+
+

The CRN of the destination cluster.

+
+

string

+
+

policyId
+required

+
+

The ID of the HBase policy.

+
+

string

+
+
+
+

ContinueHbaseSetupResponse

+
+

Response object for continueHbaseSetup.

+
+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

clusterCrn
+optional

+
+

The CRN of the input cluster.

+
+

string

+
+

message
+optional

+
+

The detailed description of the action taken.

+
+

string

+
+

status
+optional

+
+

The status of the request.

+
+

string

+
+
+
+

CreateAbfsCredentialRequest

+
+

Request object for creating ABFS cloud credentials. Currently supported cloud credentials: ABFS Access Key for Ambari clusters, ABFS Client Secret for CM clusters.

+
+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

accessKey
+optional

+
+

ABFS access key.

+
+

string

+
+

clientId
+optional

+
+

Client ID of an Active Directory service principal account.

+
+

string

+
+

clientSecretKey
+optional

+
+

Client Key of an Active Directory service principal account.

+
+

string

+
+

clusters
+required

+
+

List of cluster CRNs where the credential should be created.

+
+

< string > array

+
+

name
+required

+
+

Name of the credential.

+
+

string

+
+

storageAccountName
+optional

+
+

ABFS storage account name.

+
+

string

+
+

tenantId
+optional

+
+

Tenant ID of an Active Directory service principal account.

+
+

string

+
+

type
+required

+
+

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

+
+
+
+

CreateAbfsCredentialResponse

+
+

Response object for creating ABFS credentials.

+
+ +++++ + + + + + + + + + + + + + + +
NameDescriptionSchema
+

errors
+optional

+
+

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.

+
+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

accessKey
+optional

+
+

AWS access key.

+
+

string

+
+

clusters
+required

+
+

List of cluster CRNs where the credential should be created.

+
+

< string > array

+
+

name
+required

+
+

Name of the credential.

+
+

string

+
+

secretKey
+optional

+
+

AWS secret key.

+
+

string

+
+

type
+required

+
+

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

+
+
+
+

CreateAwsCredentialResponse

+
+

Response object for creating AWS credentials.

+
+ +++++ + + + + + + + + + + + + + + +
NameDescriptionSchema
+

errors
+optional

+
+

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

+
+

< ApiError > array

+
+
+
+

CreateHbasePolicyRequest

+
+

Create an HBase replication policy.

+
+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

clusterCrn
+required

+
+

CRN of the destination cluster.

+
+

string

+
+

policyDefinition
+required

+
+

Policy definition.

+
+

policyName
+required

+
+

Name of the new policy.

+
+

string

+
+
+
+

CreateHbasePolicyResponse

+
+

Response object for createHbasePolicy.

+
+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

clusterCrn
+optional

+
+

The CRN of the input cluster.

+
+

string

+
+

message
+optional

+
+

The detailed description of the action taken.

+
+

string

+
+

status
+optional

+
+

The status of the request.

+
+

string

+
+
+
+

CreatePolicyRequest

+
+

Create a replication policy.

+
+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

clusterCrn
+required

+
+

CRN of the cluster where the policy will be created.

+
+

string

+
+

policyDefinition
+required

+
+

Policy definition.

+
+

policyName
+required

+
+

Name of the new policy.

+
+

string

+
+
+
+

CreatePolicyResponse

+
+

Response object for createPolicy.

+
+
+

Type : object

+
+
+
+

CredentialCollection

+
+

Cloud Credentials listing.

+
+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

credentials
+required

+
+

Cloud credential details.

+
+

< CredentialDetails > array

+
+

results
+required

+
+

Number of cloud credentials in the response.

+
+

integer (int64)

+
+

totalResults
+required

+
+

Total number cloud credentials.

+
+

integer (int64)

+
+
+
+

CredentialDetails

+
+

Cloud credential details for by-name or by-id cloud credential request.

+
+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

authType
+required

+
+

Authentication type.

+
+

string

+
+

configs
+optional

+
+

Configurations.

+
+

< string, string > map

+
+

creationTime
+required

+
+

Creation time.

+
+

string (date-time)

+
+

customConfigs
+optional

+
+

Custom configurations.

+
+

< CustomConfigs > array

+
+

id
+required

+
+

Credential id.

+
+

string

+
+

lastModifiedTime
+required

+
+

Last modified time.

+
+

string (date-time)

+
+

name
+required

+
+

Credential name.

+
+

string

+
+

provider
+required

+
+

Credential provider.

+
+

string

+
+
+
+

CredentialsResponse

+
+

Response object for cloud credentials.

+
+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

clusterCrn
+required

+
+

Cluster CRN.

+
+

string

+
+

clusterUrl
+required

+
+

Cluster URL.

+
+

string

+
+

credentials
+required

+
+

Cloud credentials.

+
+

replicationEngineType
+required

+
+

Replication engine type.

+
+

enum (CM, DLMENGINE)

+
+
+
+

CustomConfigs

+
+

Custom key/value configurations.

+
+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

confidential
+required

+
+

Whether the value is confidential.

+
+

boolean

+
+

name
+required

+
+

Name.

+
+

string

+
+

value
+required

+
+

Value.

+
+

string

+
+
+
+

DeleteCredentialRequest

+
+

Request object for deleting a credential.

+
+ +++++ + + + + + + + + + + + + + + +
NameDescriptionSchema
+

name
+required

+
+

Name of the cloud credential to delete.

+
+

string

+
+
+
+

DeleteCredentialResponse

+
+

Response object for delete credential operation.

+
+ +++++ + + + + + + + + + + + + + + +
NameDescriptionSchema
+

errors
+optional

+
+

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.

+
+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

clusterCrn
+required

+
+

CRN of the destination cluster.

+
+

string

+
+

force
+optional

+
+

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

+
+

boolean

+
+

policyId
+required

+
+

ID of the HBase policy.

+
+

string

+
+
+
+

DeleteHbasePolicyResponse

+
+

Response object for deleteHbasePolicy.

+
+ +++++ + + + + + + + + + + + + +
NameDescriptionSchema
+

clusterCrn
+optional

+
+

The CRN of the input cluster.

string

@@ -2549,11 +4935,11 @@

Cluster

-

dataCenter
-required

+

message
+optional

-

Cluster data center.

+

The detailed description of the action taken.

string

@@ -2561,23 +4947,45 @@

Cluster

-

description
+

status
optional

-

Cluster description.

+

The status of the request.

string

+
+
+

DeletePolicyRequest

+
+

Delete a replication policy.

+
+ +++++ + + + + + + + + + +
NameDescriptionSchema
-

environmentCrn
-optional

+

clusterCrn
+required

-

CRN of the cluster’s environment.

+

CRN of the cluster where the policy is.

string

@@ -2585,59 +4993,135 @@

Cluster

-

knoxUrl
-optional

+

policyName
+required

-

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

+

Policy name to delete.

string

+
+
+

DeletePolicyResponse

+
+

Response object for deletePolicy.

+
+
+

Type : object

+
+
+
+

DownloadDiagnosticBundleRequest

+
+

Request to download the diagnostic bundle for the given cluster and command id.

+
+ +++++ + + + + + + + + + +
NameDescriptionSchema
-

location
-optional

+

clusterCrn
+required

-

Cluster location.

+

The CRN of the target cluster.

-

Location

+

string

-

name
+

commandId
required

-

Cluster name.

+

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.

+
+ +++++ + + + + + + + + + +
NameDescriptionSchema
-

replicationEngineType
-required

+

bundleFile
+optional

-

Replication engine type.

+

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

-

enum (CM, DLM_ENGINE)

+

string (byte)

+
+
+

Error

+
+

An object returned on an error.

+
+ +++++ + + + + + + + + + +
NameDescriptionSchema
-

stackCrn
+

code
optional

-

Stack CRN.

+

The error code.

string

@@ -2645,47 +5129,115 @@

Cluster

-

stackMajorVersion
+

message
optional

-

Stack major version.

+

The error message.

string

+
+
+

ErrorHandling

+
+

Error handling behavior.

+
+ +++++ + + + + + + + + + + + + + + + + + +
NameDescriptionSchema
+

abortOnError
+required

+
+

Abort policy on error.

+
+

boolean

+
-

stackVersion
-optional

+

abortOnSnapshotDiffFailures
+required

-

Stack version.

+

Abort policy if there are snapshot diff failures.

-

string

+

boolean

-

totalHosts
-optional

+

skipChecksumChecks
+required

-

Total hosts on the cluster.

+

Skip checksum checks.

-

integer (int32)

+

boolean

-

uuid
-optional

+

skipListingChecksumChecks
+required

+
+

Skip checksum checks for copy-listing.

+
+

boolean

+
+
+
+

GetClusterConfigRequest

+
+

Request object for getClusterConfig.

+
+ +++++ + + + + + + + + + +
NameDescriptionSchema
+

clusterCrn
+required

-

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

+

The CRN of the cluster.

string

@@ -2695,9 +5247,9 @@

Cluster

-

ClusterServiceStatuses

+

GetClusterConfigResponse

-

Describes the status of services running on a cluster.

+

Response object for getClusterConfig.

@@ -2716,10 +5268,10 @@

ClusterServiceStatuses

- -

clusterCrn
-required

+optional

-

Cluster CRN.

+

The CRN of the cluster.

string

@@ -2727,69 +5279,68 @@

ClusterServiceStatuses

-

serviceStatuses
-required

+

cmApiVersion
+optional

-

List of service statuses.

+

Cloudera Manager API version.

-

< ServiceInfo > array

+

integer (int32)

-
-
-

CmPolicySubmitUser

-
-

CM Policy submit user.

-
- ----- - - - - + + + - - + + + + +
NameDescriptionSchema
+

dmx
+optional

+
+

Configuration related to DMX.

+
+

dmx

+
-

sourceUser
+

featureSupport
optional

-

Source user.

+

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

-

string

+

< string, boolean > map

-

userName
+

services
optional

-

Username.

+

A list of service configurations.

-

string

+

< ServiceConfiguration > array

+
+

underlyingFsForHive
+optional

+
+

Underlying file system for Hive.

+
+

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

-
-
-

CodProperties

-
-

Additional properties for operational databases.

+
+

dmx

@@ -2807,23 +5358,23 @@

CodProperties

-

operationalDatabaseName
+

hbaseSuspend
optional

-

Name of the corresponding operational database..

+

Suspend type for HBase policies.

-

string

+

HbaseSuspendType

-

CollectDiagnosticBundleRequest

+

GetCommandStatusRequest

-

Triggers a diagnostic bundle collect command for the given cluster and policyName.

+

Get the current status of any CM command.

@@ -2853,11 +5404,11 @@

CollectDiagnosticBundleRequest

-

policyName
+

commandId
required

-

Name of the policy.

+

ID of a CM command on the cluster.

string

@@ -2867,9 +5418,9 @@

CollectDiagnosticBundleRequest

-

CollectDiagnosticBundleResponse

+

GetCommandStatusResponse

-

Response object for collect-diagnostic-bundle.

+

Response object for get command status.

@@ -2891,7 +5442,7 @@

CollectDiagnosticBundleResponse

optional

- - - - - - -
-

Whether the diagnostic bundle command is active.

+

Whether the command is still active.

boolean

@@ -2899,35 +5450,23 @@

CollectDiagnosticBundleResponse

-

commandId
-required

-
-

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

-
-

integer (int64)

-
-

name
+

bundleStatus
optional

-

Name of the policy.

+

The current status of the command.

-

string

+

enum (IN_PROGRESS, DOWNLOADABLE_WITH_URL, DOWNLOADABLE_WITH_CLI, FAILED)

-

resultMessage
+

bundleStatusMessage
optional

-

Diagnostic bundle collection command result message.

+

Further information about the current command status.

string

@@ -2935,45 +5474,23 @@

CollectDiagnosticBundleResponse

-

startTime
-optional

+

commandId
+required

-

Start time of the diagnostic bundle collection command.

+

Id of the CM command.

-

string

+

integer (int64)

-
-
-

CreateAbfsCredentialRequest

-
-

Request object for creating ABFS cloud credentials. Currently supported cloud credentials: ABFS Access Key for Ambari clusters, ABFS Client Secret for CM clusters.

-
- ----- - - - - - - - - - - - - - - - - - -
NameDescriptionSchema
-

accessKey
+

endTime
optional

-

ABFS access key.

+

End time of the CM command.

string

@@ -2981,11 +5498,11 @@

CreateAbfsCredentialRequest

-

clientId
+

name
optional

-

Client ID of an Active Directory service principal account.

+

Name of the policy.

string

@@ -2993,35 +5510,11 @@

CreateAbfsCredentialRequest

-

clientSecretKey
+

resultDataUrl
optional

-

Client Key of an Active Directory service principal account.

-
-

string

-
-

clusters
-required

-
-

List of cluster CRNs where the credential should be created.

-
-

< string > array

-
-

name
-required

-
-

Name of the credential.

+

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

@@ -3029,11 +5522,11 @@

CreateAbfsCredentialRequest

-

storageAccountName
+

resultMessage
optional

-

ABFS storage account name.

+

Result message of the command.

string

@@ -3041,11 +5534,11 @@

CreateAbfsCredentialRequest

-

tenantId
+

startTime
optional

-

Tenant ID of an Active Directory service principal account.

+

Start time of the CM command.

string

@@ -3053,23 +5546,23 @@

CreateAbfsCredentialRequest

-

type
-required

+

success
+optional

-

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.

+

Whether the diagnostic collection is successful.

-

CreateAbfsCredentialResponse

+

GetCredentialsRequest

-

Response object for creating ABFS credentials.

+

Request object to retrieve specific cloud credentials.

@@ -3087,23 +5580,47 @@

CreateAbfsCredentialResponse

+ + + + + + + + + +
-

errors
+

clusterCrn
+required

+
+

CRN of the cluster where the credential is.

+
+

string

+
+

credentialId
optional

-

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

+

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

-

< ApiError > array

+

string

+
+

credentialName
+optional

+
+

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

+
+

string

-

CreateAwsCredentialRequest

+

GetCredentialsResponse

-

Request object for creating AWS IAM or Access & Secret Key cloud credentials.

+

Response for credential request.

@@ -3121,71 +5638,57 @@

CreateAwsCredentialRequest

- - - - - - - - - - - - - - - + +
-

accessKey
-optional

-
-

AWS access key.

-
-

string

-
-

clusters
-required

-
-

List of cluster CRNs where the credential should be created.

-
-

< string > array

-
-

name
-required

-
-

Name of the credential.

-
-

string

-
-

secretKey
+

credentials
optional

-

AWS secret key.

+

List of credentials.

-

string

+

< CredentialDetails > array

+
+
+

HbaseCrnPairs

+
+

HBase CRN pairs.

+
+ +++++ + + + + + + + +
NameDescriptionSchema
-

type
-required

+

pairedCrns
+optional

-

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.

+

The list of CRNs which are peers of each other.

-

AwsCloudCredentialType

+

< string > array

-

CreateAwsCredentialResponse

+

HbaseDatabaseArguments

-

Response object for creating AWS credentials.

+

HBase database replication arguments.

@@ -3203,23 +5706,23 @@

CreateAwsCredentialResponse

-

errors
+

replicationStrategy
optional

-

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

+

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

-

< ApiError > array

+

enum (ALL_TABLES, TABLES_WITH_REPLICATION_SCOPE_SET)

-

CreatePolicyRequest

+

HbasePolicyArguments

-

Create a replication policy.

+

HBase replication parameters.

@@ -3237,11 +5740,11 @@

CreatePolicyRequest

-

clusterCrn
-required

+

cloudCredential
+optional

-

CRN of the cluster where the policy will be created.

+

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

string

@@ -3249,44 +5752,35 @@

CreatePolicyRequest

-

policyDefinition
-required

+

databaseArguments
+optional

-

Policy definition.

+

Optional parameters used for HBase database replication.

-

policyName
-required

+

tables
+optional

-

Name of the new policy.

+

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

+

< string > array

-

CreatePolicyResponse

-
-

Response object for createPolicy.

-
-
-

Type : object

-
-
-
-

CredentialCollection

+

HbasePolicyDefinition

-

Cloud Credentials listing.

+

HBase policy definition.

@@ -3304,47 +5798,140 @@

CredentialCollection

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
-

credentials
+

description
+optional

+
+

Description of the policy.

+
+

string

+
+

distcpMaxMaps
+optional

+
+

Maximum Map jobs to use for initial snapshot.

+
+

integer (int64)

+
+

hbasePolicyArguments
required

-

Cloud credential details.

+

HBase policy arguments.

-

results
+

initialSnapshot
required

-

Number of cloud credentials in the response.

+

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.

-

integer (int64)

+

boolean

-

totalResults
+

machineUser
+optional

+
+

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

+
+

queueName
+optional

+
+

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

+
+

string

+
+

sourceCluster
required

-

Total number cloud credentials.

+

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

-

integer (int64)

+

string

+
+

sourceRestartType
+optional

+
+

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

+
+

targetCluster
+required

+
+

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

+
+

string

+
+

targetRestartType
+optional

+
+

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

+
-

CredentialDetails

+

HbaseSuspendType

-

Cloud credential details for by-name or by-id cloud credential request.

+

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)

+
+
+
+

HdfsArguments

+
+

Extra properties for HDFS.

@@ -3362,59 +5949,59 @@

CredentialDetails

+ + + + +
-

authType
-required

+

alert
+optional

-

Authentication type.

+

Alerting behavior.

-

string

+

Alert

-

configs
+

deletePolicy
optional

-

Configurations.

+

Deletion behavior.

-

< string, string > map

+

enum (KEEP_DELETED_FILES, DELETE_TO_TRASH, DELETE_PERMANENTLY)

-

creationTime
-required

+

errorHandling
+optional

-

Creation time.

+

Error handling strategy.

-

string (date-time)

+

ErrorHandling

-

customConfigs
+

exclusionFilters
optional

-

Custom configurations.

+

Exclusion filters in glob format.

-

< CustomConfigs > array

+

< string > array

-

id
-required

+

logPath
+optional

-

Credential id.

+

Job log path.

string

@@ -3422,23 +6009,23 @@

CredentialDetails

-

lastModifiedTime
-required

+

mapReduceService
+optional

-

Last modified time.

+

Name of the mapreduce service.

-

string (date-time)

+

string

-

name
-required

+

path
+optional

-

Credential name.

+

HDFS path. Mandatory for HDFS policies, otherwise optional.

string

@@ -3446,23 +6033,35 @@

CredentialDetails

-

provider
-required

+

preserve
+optional

-

Credential provider.

+

Properties to preserve.

-

string

+

Preserve

+
+

replicationStrategy
+optional

+
+

Replication strategy.

+
+

enum (DYNAMIC, STATIC)

-

CredentialsResponse

+

HiveArguments

-

Response object for cloud credentials.

+

Hive replication arguments.

@@ -3480,59 +6079,59 @@

CredentialsResponse

-

clusterCrn
-required

+

databasesAndTables
+optional

-

Cluster CRN.

+

Scope of the replication.

-

string

+

< HiveDatabaseAndTables > array

-

clusterUrl
-required

+

numThreads
+optional

-

Cluster URL.

+

Number of threads to use during replication.

-

string

+

integer (int64)

-

credentials
-required

+

sentryPermissions
+optional

-

Cloud credentials.

+

Include or exclude Sentry permissions.

-

CredentialCollection

+

enum (INCLUDE, EXCLUDE)

-

replicationEngineType
-required

+

skipUrlPermissions
+optional

-

Replication engine type.

+

Skip URL permissions.

-

enum (CM, DLMENGINE)

+

boolean

-

CustomConfigs

+

HiveDatabaseAndTables

-

Custom key/value configurations.

+

Hive replication scope.

@@ -3550,23 +6149,23 @@

CustomConfigs

-

confidential
+

database
required

-

Whether the value is confidential.

+

Database to replicate.

-

boolean

+

string

-

name
-required

+

tablesExcludeRegex
+optional

-

Name.

+

Regex to match excluded tables.

string

@@ -3574,11 +6173,11 @@

CustomConfigs

-

value
-required

+

tablesIncludeRegex
+optional

-

Value.

+

Regex to match included tables.

string

@@ -3588,9 +6187,18 @@

CustomConfigs

-

DeleteCredentialRequest

+

ListAllCredentialsRequest

-

Request object for deleting a credential.

+

Request object for listing all cloud credentials on all clusters.

+
+
+

Type : object

+
+
+
+

ListAllCredentialsResponse

+
+

Response object for list credentials request.

@@ -3608,23 +6216,44 @@

DeleteCredentialRequest

+ + + + +
-

name
+

credentials
required

-

Name of the cloud credential to delete.

+

List of credentials by cluster.

-

string

+

< CredentialsResponse > array

+
+

unreachableClusters
+required

+
+

List of errors for unreachable clusters.

+
+

< ApiError > array

-

DeleteCredentialResponse

+

ListClusterServiceStatusesRequest

-

Response object for delete credential operation.

+

Request object to list cluster statuses.

+
+
+

Type : object

+
+
+
+

ListClusterServiceStatusesResponse

+
+

Response object for listing of cluster statuses.

@@ -3642,23 +6271,32 @@

DeleteCredentialResponse

-

errors
+

statuses
optional

-

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

+

List of statuses by cluster.

-

< ApiError > array

+

< ClusterServiceStatuses > array

-

DeletePolicyRequest

+

ListClustersRequest

-

Delete a replication policy.

+

Request to list clusters.

+
+
+

Type : object

+
+
+
+

ListClustersResponse

+
+

Response object for list clusters request.

@@ -3676,44 +6314,44 @@

DeletePolicyRequest

-

clusterCrn
+

clusters
required

-

CRN of the cluster where the policy is.

+

List of clusters.

-

string

+

< Cluster > array

-

policyName
+

unreachableClusters
required

-

Policy name to delete.

+

List of errors for unreachable clusters.

-

string

+

< ApiError > array

-

DeletePolicyResponse

+

ListPairedHbaseClustersRequest

-

Response object for deletePolicy.

+

Request to list all paired HBase cluster CRNs.

Type : object

-

DownloadDiagnosticBundleRequest

+

ListPairedHbaseClustersResponse

-

Request to download the diagnostic bundle for the given cluster and command id.

+

Response object for listPairedHbaseClusters.

@@ -3731,70 +6369,56 @@

DownloadDiagnosticBundleRequest

- -
-

clusterCrn
-required

+

crnsMissingHbaseService
+optional

-

The CRN of the target cluster.

+

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

-

string

+

< string > array

-

commandId
-required

+

pairings
+optional

-

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

+

The list of CRN pairings.

-

string

+

< HbaseCrnPairs > array

-
-
-

DownloadDiagnosticBundleResponse

-
-

Response object for download-diagnostic-bundle. On certain clusters this response will show if the download is only available directly from CM.

-
- ----- - - - - - - - -
NameDescriptionSchema
-

bundleFile
+

unreachableClusters
optional

-

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

+

The list of errors for unreachable clusters.

-

string (byte)

+

< ApiError > array

-

Error

+

ListPoliciesRequest

-

An object returned on an error.

+

Request object for listing all policies.

+
+
+

Type : object

+
+
+
+

ListPoliciesResponse

+
+

Response object for a list policies request.

@@ -3812,35 +6436,47 @@

Error

+ + + + +
-

code
-optional

+

policies
+required

-

The error code.

+

List of policies.

-

string

+

< Policy > array

-

message
-optional

+

policyErrors
+required

-

The error message.

+

List of policy errors.

-

string

+

< ApiError > array

+
+

unreachableClusters
+required

+
+

List of errors for unreachable clusters.

+
+

< ApiError > array

-

ErrorHandling

+

Location

-

Error handling behavior.

+

Location object.

@@ -3858,59 +6494,71 @@

ErrorHandling

+ + + + +
-

abortOnError
+

city
required

-

Abort policy on error.

+

City.

-

boolean

+

string

-

abortOnSnapshotDiffFailures
+

country
required

-

Abort policy if there are snapshot diff failures.

+

Country.

-

boolean

+

string

-

skipChecksumChecks
+

id
required

-

Skip checksum checks.

+

Location ID.

-

boolean

+

integer (int64)

-

skipListingChecksumChecks
+

latitude
required

-

Skip checksum checks for copy-listing.

+

Latitude.

-

boolean

+

number (double)

+
+

longitude
+required

+
+

Longitude.

+
+

number (double)

-

GetCommandStatusRequest

+

MachineUser

-

Get the current status of any CM command.

+

Username and password for the machine user.

@@ -3928,11 +6576,23 @@

GetCommandStatusRequest

+ + + + +
-

clusterCrn
+

createUser
required

-

The CRN of the target cluster.

+

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

+
+

boolean

+
+

password
+required

+
+

Password.

string

@@ -3940,11 +6600,11 @@

GetCommandStatusRequest

-

commandId
+

user
required

-

ID of a CM command on the cluster.

+

Username.

string

@@ -3954,9 +6614,9 @@

GetCommandStatusRequest

-

GetCommandStatusResponse

+

Policy

-

Response object for get command status.

+

Replication policy definition.

@@ -3974,35 +6634,35 @@

GetCommandStatusResponse

- -
-

active
+

creationTime
optional

-

Whether the command is still active.

+

Policy creation time.

-

boolean

+

string (date-time)

-

bundleStatus
+

customProperties
optional

-

The current status of the command.

+

Custom replication properties.

-

enum (IN_PROGRESS, DOWNLOADABLE_WITH_URL, DOWNLOADABLE_WITH_CLI, FAILED)

+

< string, string > map

-

bundleStatusMessage
+

description
optional

-

Further information about the current command status.

+

Policy description.

string

@@ -4010,23 +6670,23 @@

GetCommandStatusResponse

-

commandId
+

endTime
required

-

Id of the CM command.

+

End time of policy run or when it repeats.

-

integer (int64)

+

string (date-time)

-

endTime
+

executionType
optional

-

End time of the CM command.

+

Policy execution type.

string

@@ -4034,35 +6694,35 @@

GetCommandStatusResponse

-

name
-optional

+

frequency
+required

-

Name of the policy.

+

Frequency in seconds when the policy runs.

-

string

+

integer (int64)

-

resultDataUrl
-optional

+

jobs
+required

-

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.

+

List of policy runs.

-

string

+

< PolicyInstanceResponse > array

-

resultMessage
-optional

+

name
+required

-

Result message of the command.

+

Policy name.

string

@@ -4070,11 +6730,11 @@

GetCommandStatusResponse

-

startTime
+

nextRun
optional

-

Start time of the CM command.

+

Next expected run of the policy.

string

@@ -4082,45 +6742,23 @@

GetCommandStatusResponse

-

success
+

plugins
optional

-

Whether the diagnostic collection is successful.

+

Plugins.

-

boolean

+

< string > array

-
-
-

GetCredentialsRequest

-
-

Request object to retrieve specific cloud credentials.

-
- ----- - - - - - - - - - -
NameDescriptionSchema
-

clusterCrn
+

policyId
required

-

CRN of the cluster where the credential is.

+

Policy id.

string

@@ -4128,151 +6766,95 @@

GetCredentialsRequest

-

credentialId
-optional

+

report
+required

-

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

+

Policy report.

-

string

+

PolicyReport

-

credentialName
+

sourceCluster
optional

-

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

+

Source cluster of replication.

string

-
-
-

GetCredentialsResponse

-
-

Response for credential request.

-
- ----- - - - - - - - - - - - - - - -
NameDescriptionSchema
-

credentials
-optional

-
-

List of credentials.

-
-

< CredentialDetails > array

-
-
-
-

HdfsArguments

-
-

Extra properties for HDFS.

-
- ----- - - - - - - - -
NameDescriptionSchema
-

alert
+

sourceClusterCrn
optional

-

Alerting behavior.

+

CRN of the source cluster.

-

Alert

+

string

-

deletePolicy
+

sourceDataset
optional

-

Deletion behavior.

+

Source dataset of replication.

-

enum (KEEP_DELETED_FILES, DELETE_TO_TRASH, DELETE_PERMANENTLY)

+

< string > array

-

errorHandling
+

startTime
optional

-

Error handling strategy.

+

Policy start time.

-

ErrorHandling

+

string (date-time)

-

exclusionFilters
-optional

+

status
+required

-

Exclusion filters in glob format.

+

Current status of the policy.

-

< string > array

+

string

-

logPath
+

target
optional

-

Job log path.

+

Replication target details.

-

string

+

TargetDetails

-

mapReduceService
+

targetCluster
optional

-

Name of the mapreduce service.

+

Target cluster of replication if not cloud.

string

@@ -4280,11 +6862,11 @@

HdfsArguments

-

path
+

targetClusterCrn
optional

-

HDFS path. Mandatory for HDFS policies, otherwise optional.

+

CRN of the target cluster.

string

@@ -4292,35 +6874,35 @@

HdfsArguments

-

preserve
+

targetDataset
optional

-

Properties to preserve.

+

Target dataset of replication.

-

Preserve

+

< string > array

-

replicationStrategy
-optional

+

type
+required

-

Replication strategy.

+

Policy type.

-

enum (DYNAMIC, STATIC)

+

string

-

HiveArguments

+

PolicyDefinition

-

Hive replication arguments.

+

Policy creation request definition.

@@ -4338,93 +6920,59 @@

HiveArguments

- - - - - - -
-

databasesAndTables
-optional

-
-

Scope of the replication.

-
-

< HiveDatabaseAndTables > array

-
-

numThreads
+

cloudCredential
optional

-

Number of threads to use during replication.

+

Cloud credentials to use if replicating to Cloud.

-

integer (int64)

+

string

-

sentryPermissions
+

cloudEncryptionAlgorithm
optional

-

Include or exclude Sentry permissions.

+

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

-

enum (INCLUDE, EXCLUDE)

+

string

-

skipUrlPermissions
+

cloudEncryptionKey
optional

-

Skip URL permissions.

+

Cloud encryption key.

-

boolean

+

string

-
-
-

HiveDatabaseAndTables

-
-

Hive replication scope.

-
- ----- - - - - - - - - - -
NameDescriptionSchema
-

database
-required

+

cmPolicySubmitUser
+optional

-

Database to replicate.

+

CM policy submit user.

-

tablesExcludeRegex
+

description
optional

-

Regex to match excluded tables.

+

Description of the policy.

string

@@ -4432,277 +6980,155 @@

HiveDatabaseAndTables

-

tablesIncludeRegex
+

distcpMapBandwidth
optional

-

Regex to match included tables.

+

Maximum bandwidth to use for replication.

-

string

+

integer (int64)

-
-
-

ListAllCredentialsRequest

-
-

Request object for listing all cloud credentials on all clusters.

-
-
-

Type : object

-
-
-
-

ListAllCredentialsResponse

-
-

Response object for list credentials request.

-
- ----- - - - - - - - - - -
NameDescriptionSchema
-

credentials
-required

+

distcpMaxMaps
+optional

-

List of credentials by cluster.

+

Maximum Map jobs to use for replication.

-

< CredentialsResponse > array

+

integer (int64)

-

unreachableClusters
-required

+

enableSnapshotBasedReplication
+optional

-

List of errors for unreachable clusters.

+

Enable snapshot based replication.

-

< ApiError > array

+

boolean

-
-
-

ListClusterServiceStatusesRequest

-
-

Request object to list cluster statuses.

-
-
-

Type : object

-
-
-
-

ListClusterServiceStatusesResponse

-
-

Response object for listing of cluster statuses.

-
- ----- - - - - - - - - - -
NameDescriptionSchema
-

statuses
+

endTime
optional

-

List of statuses by cluster.

+

End time.

-

< ClusterServiceStatuses > array

+

string (date-time)

-
-
-

ListClustersRequest

-
-

Request to list clusters.

-
-
-

Type : object

-
-
-
-

ListClustersResponse

-
-

Response object for list clusters request.

-
- ----- - - - - + + + - - - -
NameDescriptionSchema
+

frequencyInSec
+required

+
+

Policy’s frequency in seconds.

+
+

integer (int64)

+
-

clusters
-required

+

hiveExternalTableBaseDirectory
+optional

-

List of clusters.

+

Hive external table base directory.

-

< Cluster > array

+

string

-

unreachableClusters
+

name
required

-

List of errors for unreachable clusters.

+

Name of the new policy.

-

< ApiError > array

+

string

-
-
-

ListPoliciesRequest

-
-

Request object for listing all policies.

-
-
-

Type : object

-
-
-
-

ListPoliciesResponse

-
-

Response object for a list policies request.

-
- ----- - - - - + + + - - - -
NameDescriptionSchema
+

plugins
+optional

+
+

Plugins.

+
+

< string > array

+
-

policies
-required

+

queueName
+optional

-

List of policies.

+

YARN queue name if not default.

-

< Policy > array

+

string

-

policyErrors
-required

+

sourceCluster
+optional

-

List of policy errors.

+

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

-

< ApiError > array

+

string

-

unreachableClusters
+

sourceDataset
required

-

List of errors for unreachable clusters.

+

Source dataset to replicate.

-

< ApiError > array

+

SourceDataset

-
-
-

Location

-
-

Location object.

-
- ----- - - - - - - - -
NameDescriptionSchema
-

city
-required

+

startTime
+optional

-

City.

+

Start time.

-

string

+

string (date-time)

-

country
-required

+

targetCluster
+optional

-

Country.

+

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

string

@@ -4710,47 +7136,47 @@

Location

-

id
-required

+

targetDataset
+optional

-

Location ID.

+

Dataset to replicate to.

-

integer (int64)

+

string

-

latitude
-required

+

tdeSameKey
+optional

-

Latitude.

+

TDE same key.

-

number (double)

+

boolean

-

longitude
+

type
required

-

Longitude.

+

Policy replication type.

-

number (double)

+

enum (FS, HIVE, HBASE)

-

Policy

+

PolicyInstanceResponse

-

Replication policy definition.

+

Policy execution details.

@@ -4768,35 +7194,35 @@

Policy

- - - - - - - - +
-

creationTime
+

completedSteps
optional

-

Policy creation time.

+

Number of completed steps.

-

string (date-time)

+

integer (int32)

-

customProperties
+

endTime
optional

-

Custom replication properties.

+

Command end time.

-

< string, string > map

+

string (date-time)

-

description
-optional

+

id
+required

-

Policy description.

+

Policy instance command id.

string

@@ -4804,23 +7230,23 @@

Policy

-

endTime
-required

+

jobType
+optional

-

End time of policy run or when it repeats.

+

Job type.

-

string (date-time)

+

string

-

executionType
+

message
optional

-

Policy execution type.

+

Output of the policy command.

string

@@ -4828,35 +7254,35 @@

Policy

-

frequency
+

policyId
required

-

Frequency in seconds when the policy runs.

+

Policy id.

-

integer (int64)

+

string

-

jobs
+

startTime
required

-

List of policy runs.

+

Command start time.

-

< PolicyInstanceResponse > array

+

string (date-time)

-

name
+

status
required

-

Policy name.

+

Policy command status.

string

@@ -4864,95 +7290,103 @@

Policy

-

nextRun
+

totalSteps
optional

-

Next expected run of the policy.

+

Total number of steps.

-

string

+

integer (int32)

-

plugins
+

trackingInfo
optional

-

Plugins.

-
-

< string > array

-
-

policyId
-required

-
-

Policy id.

+

JSON data to track polciy status.

string

-

report
-required

-
+
+
+
+

PolicyReport

+

Policy report.

-
- +
+ +++++ + + + + + + + + +
NameDescriptionSchema
-

sourceCluster
+

lastFailedInstance
optional

-

Source cluster of replication.

+

Last failed instance.

-

sourceClusterCrn
+

lastSucceededInstance
optional

-

CRN of the source cluster.

+

Last successful instance.

+
+
+

PolicyReportDetails

+
+

Policy report details.

+
+ +++++ + - - - + + + + + + +
-

sourceDataset
-optional

-
-

Source dataset of replication.

-
-

< string > array

-
NameDescriptionSchema
-

startTime
-optional

+

endTime
+required

-

Policy start time.

+

End time.

string (date-time)

@@ -4964,79 +7398,98 @@

Policy

required

-

Current status of the policy.

+

Status of the command.

string

+
+
+

Preserve

+
+

Properties to preserve after replication.

+
+ +++++ + - - - + + + + +
-

target
-optional

-
-

Replication target details.

-
NameDescriptionSchema
-

targetCluster
-optional

+

blockSize
+required

-

Target cluster of replication if not cloud.

+

Block size.

-

string

+

boolean

-

targetClusterCrn
-optional

+

extendedAttributes
+required

-

CRN of the target cluster.

+

Extended attributes.

-

string

+

boolean

-

targetDataset
-optional

+

permissions
+required

-

Target dataset of replication.

+

Permissions.

-

< string > array

+

boolean

-

type
+

replicationCount
required

-

Policy type.

+

Replication count.

-

string

+

boolean

-

PolicyDefinition

+

RestartType

-

Policy creation request definition.

+

Type of restart for a cluster.

+
+
+

Type : enum (RESTART, ROLLING_RESTART)

+
+
+
+

ServiceConfiguration

+
+

Configuration related to a service.

@@ -5045,68 +7498,66 @@

PolicyDefinition

- - - - - - - - - - - + + + + + + + +
NameDescriptionSchema
-

cloudCredential
-optional

-
-

Cloud credentials to use if replicating to Cloud.

-
-

string

-
NameDescriptionSchema
-

cloudEncryptionAlgorithm
+

configs
optional

-

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

+

Service configuration map.

-

string

+

< string, string > map

-

cloudEncryptionKey
+

name
optional

-

Cloud encryption key.

+

The name of the service.

string

+
+
+

ServiceInfo

+
+

Service status definition.

+
+ +++++ + - - - + + + + + + +
-

cmPolicySubmitUser
-optional

-
-

CM policy submit user.

-
NameDescriptionSchema
-

description
-optional

+

serviceName
+required

-

Description of the policy.

+

Service name.

string

@@ -5114,71 +7565,91 @@

PolicyDefinition

-

distcpMapBandwidth
-optional

+

status
+required

-

Maximum bandwidth to use for replication.

+

Service status.

-

integer (int64)

+

string

+
+
+

SourceDataset

+
+

Extra properties for the source dataset.

+
+ +++++ + - - - + + + + + + +
-

distcpMaxMaps
-optional

-
-

Maximum Map jobs to use for replication.

-
-

integer (int64)

-
NameDescriptionSchema
-

enableSnapshotBasedReplication
+

hdfsArguments
optional

-

Enable snapshot based replication.

+

HDFS arguments for HDFS and Hive replication.

-

boolean

+

HdfsArguments

-

endTime
+

hiveArguments
optional

-

End time.

+

Arguments for Hive replication, null if HDFS replication.

-

string (date-time)

+

HiveArguments

+
+
+

SuspendHbasePolicyRequest

+
+

Suspend an HBase replication policy.

+
+ +++++ + - - - + + + + + + +
-

frequencyInSec
-required

-
-

Policy’s frequency in seconds.

-
-

integer (int64)

-
NameDescriptionSchema
-

hiveExternalTableBaseDirectory
-optional

+

clusterCrn
+required

-

Hive external table base directory.

+

CRN of the destination cluster.

string

@@ -5186,35 +7657,45 @@

PolicyDefinition

-

name
+

policyId
required

-

Name of the new policy.

+

ID of the HBase policy.

string

+
+
+

SuspendHbasePolicyResponse

+
+

Response object for suspendHbasePolicy.

+
+ +++++ + - - - + + + + + + +
-

plugins
-optional

-
-

Plugins.

-
-

< string > array

-
NameDescriptionSchema
-

queueName
+

clusterCrn
optional

-

YARN queue name if not default.

+

The CRN of the input cluster.

string

@@ -5222,11 +7703,11 @@

PolicyDefinition

-

sourceCluster
+

message
optional

-

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

+

The detailed description of the action taken.

string

@@ -5234,35 +7715,45 @@

PolicyDefinition

-

sourceDataset
-required

+

status
+optional

-

Source dataset to replicate.

+

The status of the request.

-

SourceDataset

+

string

+
+
+

SuspendPolicyRequest

+
+

Suspend a replication policy.

+
+ +++++ + - - - + + + + + + +
-

startTime
-optional

-
-

Start time.

-
-

string (date-time)

-
NameDescriptionSchema
-

targetCluster
-optional

+

clusterCrn
+required

-

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

+

CRN of the cluster where the policy is.

string

@@ -5270,47 +7761,78 @@

PolicyDefinition

-

targetDataset
-optional

+

policyName
+required

-

Dataset to replicate to.

+

Policy name to suspend.

string

+
+
+

SuspendPolicyResponse

+
+

Response object for suspendPolicy.

+
+
+

Type : object

+
+
+
+

TargetDetails

+
+

Target details.

+
+ +++++ + + + + + + + +
NameDescriptionSchema
-

tdeSameKey
-optional

+

environmentCrn
+required

-

TDE same key.

+

Target’s environment CRN.

-

boolean

+

string

-

type
-required

+

warehouseCrn
+optional

-

Policy replication type.

+

Target’s warehouse CRN.

-

enum (FS, HIVE, HBASE)

+

string

-

PolicyInstanceResponse

+

UpdateHbasePolicyDefinition

-

Policy execution details.

+

HBase policy update request definition.

@@ -5328,47 +7850,69 @@

PolicyInstanceResponse

+ +
-

completedSteps
+

description
optional

-

Number of completed steps.

+

Description of the policy.

-

integer (int32)

+

string

-

endTime
+

name
optional

-

Command end time.

+

The policy name.

-

string (date-time)

+

string

-

id
-required

+

tables
+optional

-

Policy instance command id.

+

List of tables to be replicated. The items should be in "namespace:tablename" format.

-

string

+

< string > array

+
+
+

UpdateHbasePolicyRequest

+
+

Update HBase replication policy request.

+
+ +++++ + + + + + + + + + +
NameDescriptionSchema
-

jobType
-optional

+

clusterCrn
+required

-

Job type.

+

The CRN of the cluster where the policy will be updated.

string

@@ -5376,11 +7920,11 @@

PolicyInstanceResponse

-

message
-optional

+

policyId
+required

-

Output of the policy command.

+

The ID of the policy to be updated.

string

@@ -5388,35 +7932,57 @@

PolicyInstanceResponse

-

policyId
+

updateHbasePolicyDefinition
required

-

Policy id.

+

The policy definition.

+
+
+

UpdateHbasePolicyResponse

+
+

Response object for updateHbasePolicy.

+
+ +++++ + + + + + + + +
NameDescriptionSchema
-

startTime
-required

+

clusterCrn
+optional

-

Command start time.

+

The CRN of the input cluster.

-

string (date-time)

+

string

-

status
-required

+

message
+optional

-

Policy command status.

+

The detailed description of the action taken.

string

@@ -5424,23 +7990,23 @@

PolicyInstanceResponse

-

totalSteps
+

requestId
optional

-

Total number of steps.

+

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

-

integer (int32)

+

string

-

trackingInfo
+

status
optional

-

JSON data to track polciy status.

+

The status of the request (Successful or an error).

string

@@ -5450,9 +8016,9 @@

PolicyInstanceResponse

-

PolicyReport

+

VerificationSteps

-

Policy report.

+

Verification steps.

@@ -5470,35 +8036,35 @@

PolicyReport

-

lastFailedInstance
+

clusterManagerUrl
optional

-

Last failed instance.

+

The cluster manager URL to reach the cluster’s UI.

-

lastSucceededInstance
+

steps
optional

-

Last successful instance.

+

The list of manual steps to perform or verify.

-

PolicyReportDetails

+

< string > array

-

PolicyReportDetails

+

VerifyHbaseClusterPairRequest

-

Policy report details.

+

Request to verify a cluster pairing for HBase policy creation prerequisites.

@@ -5516,23 +8082,23 @@

PolicyReportDetails

-

endTime
+

destinationClusterCrn
required

-

End time.

+

CRN of the destination cluster.

-

string (date-time)

+

string

-

status
+

sourceClusterCrn
required

-

Status of the command.

+

CRN of the source cluster.

string

@@ -5542,9 +8108,9 @@

PolicyReportDetails

-

Preserve

+

VerifyHbaseClusterPairResponse

-

Properties to preserve after replication.

+

Response object for verifyHbaseClusterPair.

@@ -5562,81 +8128,47 @@

Preserve

- - - - - - -
-

blockSize
-required

-
-

Block size.

-
-

boolean

-
-

extendedAttributes
-required

+

afterPolicySteps
+optional

-

Extended attributes.

+

Manual steps to perform after HBase policy creation.

-

boolean

+

afterPolicySteps

-

permissions
-required

+

beforePolicySteps
+optional

-

Permissions.

+

Manual steps to perform before HBase policy creation.

-

boolean

+

beforePolicySteps

-

replicationCount
-required

+

pairedStatus
+optional

-

Replication count.

+

Substatus of an active pairing. Indicates if a pairing is resettable or in an erroneous state.

-

boolean

+

string

-
-
-

ServiceInfo

-
-

Service status definition.

-
- ----- - - - - - - - -
NameDescriptionSchema
-

serviceName
-required

+

pairingMessage
+optional

-

Service name.

+

Description of the pairing status.

string

@@ -5644,11 +8176,11 @@

ServiceInfo

-

status
-required

+

pairingStatus
+optional

-

Service status.

+

The current status of pairing.

string

@@ -5656,11 +8188,8 @@

ServiceInfo

-
-
-

SourceDataset

-
-

Extra properties for the source dataset.

+
+

afterPolicySteps

@@ -5678,35 +8207,44 @@

SourceDataset

+ + + + +
-

hdfsArguments
+

destination
optional

-

HDFS arguments for HDFS and Hive replication.

+

Steps to perform for the destination cluster.

-

hiveArguments
+

source
optional

-

Arguments for Hive replication, null if HDFS replication.

+

Steps to perform for the source cluster.

+

summary
+optional

+
+

Summary of the steps to perform.

+
+

string

-
-
-

SuspendPolicyRequest

-
-

Suspend a replication policy.

+
+

beforePolicySteps

@@ -5724,78 +8262,47 @@

SuspendPolicyRequest

- -
-

clusterCrn
-required

+

destination
+optional

-

CRN of the cluster where the policy is.

+

Steps to perform for the destination cluster.

-

policyName
-required

+

documentationLink
+optional

-

Policy name to suspend.

+

Link to the HBase replication manual steps documentation.

string

-
-
-

SuspendPolicyResponse

-
-

Response object for suspendPolicy.

-
-
-

Type : object

-
-
-
-

TargetDetails

-
-

Target details.

-
- ----- - - - - - - - -
NameDescriptionSchema
-

environmentCrn
-required

+

source
+optional

-

Target’s environment CRN.

+

Steps to perform for the source cluster.

-

warehouseCrn
+

summary
optional

-

Target’s warehouse CRN.

+

Summary of the steps to perform.

string

@@ -5809,7 +8316,7 @@

TargetDetails


diff --git a/api-docs/swagger/README.md b/api-docs/swagger/README.md index 926036bf7..d84812a81 100644 --- a/api-docs/swagger/README.md +++ b/api-docs/swagger/README.md @@ -1,6 +1,6 @@ # CDP Control Plane Public API Swagger Service Definitions -*Version: 0.9.124* +*Version: 0.9.125* These service definitions files are the basis for official CDP API artifacts, and you can use them to create your own client-side code. They adhere to the @@ -15,24 +15,24 @@ API requests must be signed according to the | Service Definition | Version | | --- | --- | -| [audit.yaml](./audit.yaml) | 0.9.124 | -| [cloudprivatelinks.yaml](./cloudprivatelinks.yaml) | 0.9.124 | -| [compute.yaml](./compute.yaml) | 0.9.124 | -| [consumption.yaml](./consumption.yaml) | 0.9.124 | -| [datacatalog.yaml](./datacatalog.yaml) | 0.9.124 | -| [datahub.yaml](./datahub.yaml) | 0.9.124 | -| [datalake.yaml](./datalake.yaml) | 0.9.124 | -| [de.yaml](./de.yaml) | 0.9.124 | -| [df.yaml](./df.yaml) | 0.9.124 | -| [dfworkload.yaml](./dfworkload.yaml) | 0.9.124 | -| [drscp.yaml](./drscp.yaml) | 0.9.124 | -| [dw.yaml](./dw.yaml) | 0.9.124 | -| [environments.yaml](./environments.yaml) | 0.9.124 | -| [iam.yaml](./iam.yaml) | 0.9.124 | -| [imagecatalog.yaml](./imagecatalog.yaml) | 0.9.124 | -| [ml.yaml](./ml.yaml) | 0.9.124 | -| [opdb.yaml](./opdb.yaml) | 0.9.124 | -| [replicationmanager.yaml](./replicationmanager.yaml) | 0.9.124 | +| [audit.yaml](./audit.yaml) | 0.9.125 | +| [cloudprivatelinks.yaml](./cloudprivatelinks.yaml) | 0.9.125 | +| [compute.yaml](./compute.yaml) | 0.9.125 | +| [consumption.yaml](./consumption.yaml) | 0.9.125 | +| [datacatalog.yaml](./datacatalog.yaml) | 0.9.125 | +| [datahub.yaml](./datahub.yaml) | 0.9.125 | +| [datalake.yaml](./datalake.yaml) | 0.9.125 | +| [de.yaml](./de.yaml) | 0.9.125 | +| [df.yaml](./df.yaml) | 0.9.125 | +| [dfworkload.yaml](./dfworkload.yaml) | 0.9.125 | +| [drscp.yaml](./drscp.yaml) | 0.9.125 | +| [dw.yaml](./dw.yaml) | 0.9.125 | +| [environments.yaml](./environments.yaml) | 0.9.125 | +| [iam.yaml](./iam.yaml) | 0.9.125 | +| [imagecatalog.yaml](./imagecatalog.yaml) | 0.9.125 | +| [ml.yaml](./ml.yaml) | 0.9.125 | +| [opdb.yaml](./opdb.yaml) | 0.9.125 | +| [replicationmanager.yaml](./replicationmanager.yaml) | 0.9.125 | See all the files at once in this site's [Github repository](https://github.com/cloudera/cdp-dev-docs/tree/master/api-docs/swagger). diff --git a/api-docs/swagger/audit.yaml b/api-docs/swagger/audit.yaml index a18220ded..21d10c09d 100644 --- a/api-docs/swagger/audit.yaml +++ b/api-docs/swagger/audit.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.124 + version: 0.9.125 title: Cloudera Audit Service license: name: Apache 2.0 diff --git a/api-docs/swagger/cloudprivatelinks.yaml b/api-docs/swagger/cloudprivatelinks.yaml index 8411b6eb4..90d61ff48 100644 --- a/api-docs/swagger/cloudprivatelinks.yaml +++ b/api-docs/swagger/cloudprivatelinks.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.124 + version: 0.9.125 title: Cloudera CloudPrivateLinks API Service license: name: Apache 2.0 diff --git a/api-docs/swagger/compute.yaml b/api-docs/swagger/compute.yaml index 1f2c29edc..b703f3d23 100644 --- a/api-docs/swagger/compute.yaml +++ b/api-docs/swagger/compute.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public,private x-cdp-releases: PUBLIC info: - version: 0.9.124 + version: 0.9.125 title: Cloudera Compute Service license: name: Apache 2.0 @@ -92,7 +92,6 @@ paths: description: Gets a single deployment along with its extended history. This can also include all of the known templates. operationId: describeDeployment x-entitlement: COMPUTE_API_LIFTIE - x-form-factors: public parameters: - name: input in: body @@ -161,7 +160,6 @@ paths: description: Upgrades a deployment to a different chart. operationId: upgradeDeployment x-entitlement: COMPUTE_API_LIFTIE - x-form-factors: public parameters: - name: input in: body @@ -1712,7 +1710,6 @@ definitions: name: type: string description: The name of the deployment. - x-form-factors: public Chart: type: object description: Chart structure. @@ -1732,7 +1729,6 @@ definitions: values: type: string description: Escaped JSON for values.yaml of that chart. - x-form-factors: public AvailableDeploymentUpgrade: type: object description: Available deployment upgrade structure. @@ -1743,7 +1739,6 @@ definitions: deploymentVersion: type: string description: The version of the deployment that is available to upgrade to. - x-form-factors: public Deployment: type: object description: Deployment structure. @@ -1775,7 +1770,6 @@ definitions: overrides: type: string description: Escaped JSON overrides for the deployment's properties. - x-form-factors: public History: type: object description: History structure. @@ -1793,7 +1787,6 @@ definitions: overrides: type: string description: Escaped JSON overrides for the deployment's properties for given revision. - x-form-factors: public DescribeDeploymentResponse: type: object description: Response structure for describing a deployment. @@ -1810,7 +1803,6 @@ definitions: type: string description: Escaped JSON overrides for the deployment's properties. Deprecated. x-deprecated: true - x-form-factors: public UpgradeDeploymentRequest: type: object description: Request structure for upgrading a deployment. @@ -1834,7 +1826,6 @@ definitions: overrides: type: string description: Escaped JSON overrides for the deployment's properties. - x-form-factors: public UpgradeDeploymentResponse: type: object description: Response structure for upgrading a deployment. @@ -1858,7 +1849,6 @@ definitions: chart: description: Chart that the deployment was created from. $ref: '#/definitions/Chart' - x-form-factors: public ListDeploymentsRequest: type: object description: Request structure to list deployments in the cluster. diff --git a/api-docs/swagger/consumption.yaml b/api-docs/swagger/consumption.yaml index bac4fc7a0..2a9244e24 100644 --- a/api-docs/swagger/consumption.yaml +++ b/api-docs/swagger/consumption.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.124 + version: 0.9.125 title: Cloudera Consumption API Service license: name: Apache 2.0 diff --git a/api-docs/swagger/datacatalog.yaml b/api-docs/swagger/datacatalog.yaml index 82f0dc55d..b611d924d 100644 --- a/api-docs/swagger/datacatalog.yaml +++ b/api-docs/swagger/datacatalog.yaml @@ -5,7 +5,7 @@ x-form-factors: public x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.124 + version: 0.9.125 title: Cloudera DataCatalog Service license: name: Apache 2.0 diff --git a/api-docs/swagger/datahub.yaml b/api-docs/swagger/datahub.yaml index 5c99b2fbe..d6499f218 100644 --- a/api-docs/swagger/datahub.yaml +++ b/api-docs/swagger/datahub.yaml @@ -6,7 +6,7 @@ x-form-factors: public x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.124 + version: 0.9.125 title: Cloudera Data hub Service license: name: Apache 2.0 diff --git a/api-docs/swagger/datalake.yaml b/api-docs/swagger/datalake.yaml index d66c171b9..aadeba9ab 100644 --- a/api-docs/swagger/datalake.yaml +++ b/api-docs/swagger/datalake.yaml @@ -6,7 +6,7 @@ x-form-factors: public x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.124 + version: 0.9.125 title: Cloudera Datalake Service license: name: Apache 2.0 @@ -1131,6 +1131,9 @@ definitions: instanceTemplate: description: Instance template that specifies the core information for the vertical scale. $ref: '#/definitions/InstanceTemplate' + diskOptions: + description: Disk options for vertical scaling - modify disks. + $ref: '#/definitions/DiskOptions' StartDatalakeVerticalScalingResponse: type: object description: The response object for Data Lake vertical scaling. @@ -1145,6 +1148,55 @@ definitions: instanceType: type: string description: The type of the instance. + DiskOptions: + type: object + description: Attached disk configuration(s). + properties: + modifyDisks: + description: Modifies all the disks attached to all instances in a group. + $ref: '#/definitions/ModifyDisks' + addDisks: + description: Adds the requested number of disks of the requested type, size, and usage type. + $ref: '#/definitions/AddDisks' + AddDisks: + type: object + description: Attached volume configuration. + required: + - numberOfDisks + - volumeType + - size + - cloudVolumeUsageType + properties: + numberOfDisks: + type: integer + format: int32 + description: Number of disks to add on all the instances in a group. + volumeType: + type: string + description: Type of disks to add on all the instances in a group. + size: + type: integer + format: int32 + description: Size of disks to add on all the instances in a group in GB. + cloudVolumeUsageType: + type: string + description: Usage for the requested disks. + enum: + - GENERAL + - DATABASE + ModifyDisks: + type: object + description: Attached volume configuration. + required: + - size + properties: + size: + type: integer + format: int32 + description: Size of disks to modify to on all the instances in a group in GB. + volumeType: + type: string + description: Type of disks to modify to on all the instances in a group. DatalakeDetails: type: object description: Details about a datalake diff --git a/api-docs/swagger/de.yaml b/api-docs/swagger/de.yaml index 0d5cd7494..76dfef417 100644 --- a/api-docs/swagger/de.yaml +++ b/api-docs/swagger/de.yaml @@ -5,7 +5,7 @@ x-form-factors: public,private x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.124 + version: 0.9.125 title: Cloudera Data Engineering license: name: Apache 2.0 diff --git a/api-docs/swagger/df.yaml b/api-docs/swagger/df.yaml index 75fae2292..e42e6d8f5 100644 --- a/api-docs/swagger/df.yaml +++ b/api-docs/swagger/df.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.124 + version: 0.9.125 title: Cloudera DataFlow Service license: name: Apache 2.0 diff --git a/api-docs/swagger/dfworkload.yaml b/api-docs/swagger/dfworkload.yaml index b5bd04029..41a9deb5b 100644 --- a/api-docs/swagger/dfworkload.yaml +++ b/api-docs/swagger/dfworkload.yaml @@ -6,7 +6,7 @@ x-form-factors: public x-cdp-releases: PUBLIC info: description: "This REST API provides remote access to the DataFlow Service.\n Endpoints that are marked as [BETA] are subject to change in future releases of the application without backwards compatibility and without a major version change." - version: 0.9.124 + version: 0.9.125 title: Cloudera DataFlow Workload Service license: name: Apache 2.0 diff --git a/api-docs/swagger/drscp.yaml b/api-docs/swagger/drscp.yaml index ef007984d..54faafc30 100644 --- a/api-docs/swagger/drscp.yaml +++ b/api-docs/swagger/drscp.yaml @@ -5,7 +5,7 @@ x-form-factors: private x-audit: true x-cdp-releases: PUBLIC info: - version: 0.9.124 + version: 0.9.125 title: CDP Control Plane Data Recovery Service license: name: Apache 2.0 diff --git a/api-docs/swagger/dw.yaml b/api-docs/swagger/dw.yaml index e4ea63f03..8ed48a2f9 100644 --- a/api-docs/swagger/dw.yaml +++ b/api-docs/swagger/dw.yaml @@ -4,7 +4,7 @@ x-products: CDP x-form-factors: public,private x-cdp-releases: PUBLIC info: - version: 0.9.124 + version: 0.9.125 title: Cloudera Data Warehouse [EXPERIMENTAL] license: name: Apache 2.0 @@ -3215,7 +3215,8 @@ definitions: default: false description: Forced recreation of the diagnostic job. downloadOptions: - description: Database Catalog diagnostic options. If not provided, everything will be included in the Diagnostic Data. + x-deprecated: true + description: 'DEPRECATED: All logs are included by default' $ref: '#/definitions/DBCCreateDiagnosticDataDownloadOptions' CreateDbcDiagnosticDataJobResponse: type: object @@ -4292,10 +4293,12 @@ definitions: default: false description: Forced recreation of the diagnostic job. hiveDownloadOptions: - description: Hive diagnostic options. If not provided, everything will be included into the Diagnostic Data. + x-deprecated: true + description: 'DEPRECATED: All logs are included by default' $ref: '#/definitions/HiveCreateDiagnosticDataDownloadOptions' impalaDownloadOptions: - description: Impala diagnostic options. If not provided, everything will be included into the Diagnostic Data. + x-deprecated: true + description: 'DEPRECATED: All logs are included by default' $ref: '#/definitions/ImpalaCreateDiagnosticDataDownloadOptions' CreateVwDiagnosticDataJobResponse: type: object @@ -4465,97 +4468,118 @@ definitions: items: $ref: '#/definitions/EventResponse' HiveCreateDiagnosticDataDownloadOptions: + x-deprecated: true type: object - description: Flags that denote which diagnostics to include for a Hive Virtual Warehouse. + description: 'DEPRECATED: Included by default, no need to specify' x-form-factors: public properties: includeHms: + x-deprecated: true type: boolean default: false - description: Include the HMS diagnostics. + description: 'DEPRECATED: Included by default, no need to specify' includeErrordump: + x-deprecated: true type: boolean default: false - description: Include the error dump. + description: 'DEPRECATED: Included by default, no need to specify' includeGclogs: + x-deprecated: true type: boolean default: false - description: Include the Garbage collector logs. + description: 'DEPRECATED: Included by default, no need to specify' includeHeapdump: + x-deprecated: true type: boolean default: false - description: Include the heap-dump. + description: 'DEPRECATED: Included by default, no need to specify' includeLogs: + x-deprecated: true type: boolean default: false - description: Include logs. + description: 'DEPRECATED: Included by default, no need to specify' includeComputeResourceInfo: + x-deprecated: true type: boolean default: false - description: Include compute resource info. + description: 'DEPRECATED: Included by default, no need to specify' includeKubernetesResourceInfo: + x-deprecated: true type: boolean default: false - description: Include Kubernetes resource info. + description: 'DEPRECATED: Included by default, no need to specify' ImpalaCreateDiagnosticDataDownloadOptions: + x-deprecated: true type: object - description: Flags that denote which diagnostics to include for an Impala Virtual Warehouse. + description: 'DEPRECATED: Included by default, no need to specify' x-form-factors: public properties: includeHms: + x-deprecated: true type: boolean default: false - description: Include the HMS diagnostics. + description: 'DEPRECATED: Included by default, no need to specify' includeMinidump: + x-deprecated: true type: boolean default: false - description: Include the minidump. + description: 'DEPRECATED: Included by default, no need to specify' includeProfile: + x-deprecated: true type: boolean default: false - description: Include the profile. + description: 'DEPRECATED: Included by default, no need to specify' includeSidecar: + x-deprecated: true type: boolean default: false - description: Include the sidecar diagnostics. + description: 'DEPRECATED: Included by default, no need to specify' includeWorkload: + x-deprecated: true type: boolean default: false - description: Include the workload diagnostics. + description: 'DEPRECATED: Included by default, no need to specify' includeKubernetesResourceInfo: + x-deprecated: true type: boolean default: false - description: Include kubernetes resource info. + description: 'DEPRECATED: Included by default, no need to specify' DBCCreateDiagnosticDataDownloadOptions: + x-deprecated: true type: object - description: Flags that denote which diagnostics to include for a Database Catalog. + description: 'DEPRECATED: Included by default, no need to specify' x-form-factors: public properties: includeKubernetesResourceInfo: + x-deprecated: true type: boolean default: false - description: Include kubernetes resource info. + description: 'DEPRECATED: Included by default, no need to specify' ClusterCreateDiagnosticDataDownloadOptions: type: object description: Flags that denote which diagnostics to include for the cluster. x-form-factors: public properties: includeClusterInfo: + x-deprecated: true type: boolean default: false - description: Include cluster info. + description: 'DEPRECATED: Included by default, no need to specify' includeIstioSystem: + x-deprecated: true type: boolean default: false - description: Include Istio system. + description: 'DEPRECATED: Included by default, no need to specify' includeSharedServices: + x-deprecated: true type: boolean default: false - description: Include shared services. + description: 'DEPRECATED: Included by default, no need to specify' includeKubeSystem: + x-deprecated: true type: boolean default: false - description: Include Kube system. + description: 'DEPRECATED: Included by default, no need to specify' ExternalBucket: type: object description: External bucket details. diff --git a/api-docs/swagger/environments.yaml b/api-docs/swagger/environments.yaml index 42a1c3374..76313542b 100644 --- a/api-docs/swagger/environments.yaml +++ b/api-docs/swagger/environments.yaml @@ -6,7 +6,7 @@ x-form-factors: public,private x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.124 + version: 0.9.125 title: Cloudera Environments Service license: name: Apache 2.0 @@ -1940,6 +1940,48 @@ paths: description: The default response on an error. schema: $ref: '#/definitions/Error' + /api/v1/environments2/initializeAWSComputeCluster: + post: + summary: Initialize compute cluster for AWS environment. + description: Initialize compute cluster for AWS environment. + operationId: initializeAWSComputeCluster + x-mutating: true + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/InitializeAWSComputeClusterRequest' + responses: + 200: + description: Expected response to a valid request. + schema: + $ref: '#/definitions/InitializeAWSComputeClusterResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' + /api/v1/environments2/initializeAzureComputeCluster: + post: + summary: Initialize compute cluster for Azure environment. + description: Initialize compute cluster for Azure environment. + operationId: initializeAzureComputeCluster + x-mutating: true + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/InitializeAzureComputeClusterRequest' + responses: + 200: + description: Expected response to a valid request. + schema: + $ref: '#/definitions/InitializeAzureComputeClusterResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' definitions: Error: type: object @@ -2424,6 +2466,30 @@ definitions: policyJson: type: string description: The policy JSON encoded in base64. + InitializeAWSComputeClusterRequest: + type: object + description: Request object for a initialize AWS default compute cluster. + required: + - environmentName + properties: + environmentName: + type: string + description: The name of the environment. + computeClusterConfiguration: + description: The Externalized k8s configuration create request for the environment + $ref: '#/definitions/AWSComputeClusterConfigurationRequest' + InitializeAzureComputeClusterRequest: + type: object + description: Request object for a initialize Azure default compute cluster. + required: + - environmentName + properties: + environmentName: + type: string + description: The name of the environment. + computeClusterConfiguration: + description: The Externalized k8s configuration create request for the environment + $ref: '#/definitions/AzureComputeClusterConfigurationRequest' CreateAWSEnvironmentRequest: type: object description: Request object for a create AWS environment request. @@ -2501,6 +2567,12 @@ definitions: freeIpa: $ref: '#/definitions/AWSFreeIpaCreationRequest' description: The FreeIPA creation request for the environment + enableComputeCluster: + description: Enable compute clusters for environment + type: boolean + computeClusterConfiguration: + description: The Externalized k8s configuration create request for the environment + $ref: '#/definitions/AWSComputeClusterConfigurationRequest' image: $ref: '#/definitions/FreeIpaImageRequest' description: The FreeIPA image request for the environment @@ -2914,6 +2986,12 @@ definitions: environment: $ref: '#/definitions/Environment' description: Created environment object. + InitializeAWSComputeClusterResponse: + type: object + description: Response object for an initialize AWS default compute cluster request. + InitializeAzureComputeClusterResponse: + type: object + description: Response object for an initialize Azure default compute cluster request. CreateAzureEnvironmentResponse: type: object description: Response object for a create Azure environment request. @@ -3048,6 +3126,12 @@ definitions: freeIpa: $ref: '#/definitions/AzureFreeIpaCreationRequest' description: The FreeIPA creation request for the environment + enableComputeCluster: + description: Enable compute clusters for environment + type: boolean + computeClusterConfiguration: + description: The Externalized k8s configuration create request for the environment. + $ref: '#/definitions/AzureComputeClusterConfigurationRequest' image: $ref: '#/definitions/FreeIpaImageRequest' description: The FreeIPA image request for the environment @@ -3475,6 +3559,9 @@ definitions: proxyConfigName: type: string description: Name of the proxy config of the environment. + computeClusterEnabled: + description: Compute clusters enabled + type: boolean Environment: type: object description: The environment. @@ -3541,6 +3628,16 @@ definitions: s3GuardTableName: type: string description: The name for the DynamoDB table backing S3Guard. + azureDetails: + type: object + description: Azure specific environment configuration information. + properties: + resourceGroupName: + type: string + description: Name of an existing Azure resource group to be used for the environment. If it is not specified then new resource groups will be generated. + resourceEncryptionParameters: + $ref: '#/definitions/AzureResourceEncryptionParameters' + description: Object containing details of encryption parameters for Azure cloud. gcpDetails: type: object description: GCP specific environment configuration information. @@ -3569,6 +3666,15 @@ definitions: customDockerRegistry: description: The configured custom docker registry for data services on the environment. $ref: '#/definitions/CustomDockerRegistryResponse' + awsComputeClusterConfiguration: + description: The Externalized AWS k8s configuration for the environment. + $ref: '#/definitions/AWSComputeClusterConfiguration' + azureComputeClusterConfiguration: + description: The Externalized Azure k8s configuration for the environment. + $ref: '#/definitions/AzureComputeClusterConfiguration' + computeClusterEnabled: + description: Compute clusters enabled + type: boolean AuthenticationRequest: type: object description: Additional SSH key authentication configuration for accessing cluster node. @@ -4858,6 +4964,82 @@ definitions: description: List of volumes attached to this instance. items: $ref: '#/definitions/AttachedVolumeDetail' + AWSComputeClusterConfigurationRequest: + description: Request object for creating Externalized compute cluster for the environment. + type: object + properties: + privateCluster: + type: boolean + description: If true, creates private cluster. + kubeApiAuthorizedIpRanges: + type: array + items: + type: string + description: Kubernetes API authorized IP ranges in CIDR notation. Mutually exclusive with privateCluster. + workerNodeSubnets: + type: array + items: + type: string + description: Specify subnets for Kubernetes Worker Nodes + AzureComputeClusterConfigurationRequest: + description: Request object for creating Externalized compute cluster for the environment. + type: object + properties: + privateCluster: + type: boolean + description: If true, creates private cluster + kubeApiAuthorizedIpRanges: + type: array + items: + type: string + description: Kubernetes API authorized IP ranges in CIDR notation. Mutually exclusive with privateCluster. + outboundType: + type: string + enum: + - udr + description: Customize cluster egress with defined outbound type in Azure Kubernetes Service. + workerNodeSubnets: + type: array + items: + type: string + description: Specify subnets for Kubernetes Worker Nodes + AWSComputeClusterConfiguration: + description: Externalized compute cluster configuration for the environment. + type: object + properties: + privateCluster: + type: boolean + description: If true, creates private cluster. + kubeApiAuthorizedIpRanges: + type: array + items: + type: string + description: Kubernetes API authorized IP ranges in CIDR notation. + workerNodeSubnets: + type: array + items: + type: string + description: Subnets for Kubernetes Worker Nodes + AzureComputeClusterConfiguration: + description: Externalized compute cluster configuration for the environment. + type: object + properties: + privateCluster: + type: boolean + description: If true, creates private cluster. + kubeApiAuthorizedIpRanges: + type: array + items: + type: string + description: Kubernetes API authorized IP ranges in CIDR notation. + outboundType: + type: string + description: Cluster egress with defined outbound type in Azure Kubernetes Service. + workerNodeSubnets: + type: array + items: + type: string + description: Subnets for Kubernetes Worker Nodes AttachedVolumeDetail: type: object description: The attached volume configuration. diff --git a/api-docs/swagger/iam.yaml b/api-docs/swagger/iam.yaml index 705b9c0cc..45d7140bb 100644 --- a/api-docs/swagger/iam.yaml +++ b/api-docs/swagger/iam.yaml @@ -7,7 +7,7 @@ x-cdp-releases: PUBLIC x-audit: true x-extensions: pvcapipath info: - version: 0.9.124 + version: 0.9.125 title: Cloudera IAM Service license: name: Apache 2.0 diff --git a/api-docs/swagger/imagecatalog.yaml b/api-docs/swagger/imagecatalog.yaml index e8bb242fe..06bc738c4 100644 --- a/api-docs/swagger/imagecatalog.yaml +++ b/api-docs/swagger/imagecatalog.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.124 + version: 0.9.125 title: Image catalog service license: name: Apache 2.0 diff --git a/api-docs/swagger/ml.yaml b/api-docs/swagger/ml.yaml index 56773b394..ab42fd57d 100644 --- a/api-docs/swagger/ml.yaml +++ b/api-docs/swagger/ml.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public,private x-cdp-releases: PUBLIC info: - version: 0.9.124 + version: 0.9.125 title: Cloudera AI license: name: Apache 2.0 @@ -1615,9 +1615,6 @@ definitions: backupStatus: type: string description: The status of the backup. - isCrossNsBackup: - type: boolean - description: Status whether the backup is cross namespace enabled. ListWorkspaceBackupsResponse: type: object description: Response object for ListWorkspaceBackups method. diff --git a/api-docs/swagger/opdb.yaml b/api-docs/swagger/opdb.yaml index 3476bb815..560cca016 100644 --- a/api-docs/swagger/opdb.yaml +++ b/api-docs/swagger/opdb.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.124 + version: 0.9.125 title: Operational Database service license: name: Apache 2.0 @@ -500,6 +500,31 @@ definitions: type: integer format: int32 description: Number of REST Worker nodes to be created for the database. A positive, non-zero number is required. The default value is 0. Requires the COD_RESTWORKERS entitlement. + customInstanceTypes: + description: Provide custom VM instance types for master, worker, gateway, leader, edge and compute groups. + $ref: '#/definitions/CustomInstanceTypes' + CustomInstanceTypes: + type: object + description: Custom VM Instance Types. + properties: + masterType: + type: string + description: Master VM Instance Type. + workerType: + type: string + description: Worker VM Instance Type. + gatewayType: + type: string + description: Gateway VM Instance Type. + leaderType: + type: string + description: Leader VM Instance Type. + edgeType: + type: string + description: Edge VM Instance Type. + computeType: + type: string + description: Compute VM Instance Type. VolumeType: type: string description: "Volume Type.\n `HDD` - Hard disk drives (HDD) volume type. Default is HDD. `SSD` - Solid disk drives (SSD) volume type. `LOCAL_SSD` - Local SSD volume type." diff --git a/api-docs/swagger/replicationmanager.yaml b/api-docs/swagger/replicationmanager.yaml index 6ba3a4d4f..f1a04f101 100644 --- a/api-docs/swagger/replicationmanager.yaml +++ b/api-docs/swagger/replicationmanager.yaml @@ -5,7 +5,7 @@ x-form-factors: public x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.124 + version: 0.9.125 title: Cloudera Replication Manager Service license: name: Apache 2.0 @@ -165,6 +165,27 @@ paths: description: The default response on an error. schema: $ref: '#/definitions/Error' + /api/v1/replicationmanager/getClusterConfig: + post: + summary: Get configuration of a cluster. + description: Retrieves configuration of a specific cluster. + operationId: getClusterConfig + x-mutating: false + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/GetClusterConfigRequest' + responses: + 200: + description: Describes a successful response to a valid request. + schema: + $ref: '#/definitions/GetClusterConfigResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' /api/v1/replicationmanager/listPolicies: post: summary: Get All Replication Policies. @@ -270,6 +291,174 @@ paths: description: The default response on an error. schema: $ref: '#/definitions/Error' + /api/v1/replicationmanager/createHbasePolicy: + post: + summary: Create an HBase Replication Policy. + description: Creates a new HBase replication policy with the given name on a specific cluster. + operationId: createHbasePolicy + x-mutating: true + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/CreateHbasePolicyRequest' + responses: + 200: + description: Describes a successful response to a valid request. + schema: + $ref: '#/definitions/CreateHbasePolicyResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' + /api/v1/replicationmanager/updateHbasePolicy: + post: + summary: Update an HBase Replication Policy. + description: Updates an existing HBase replication policy with the given parameters on a specific cluster. + operationId: updateHbasePolicy + x-mutating: true + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/UpdateHbasePolicyRequest' + responses: + 200: + description: Describes a successful response to a valid request. + schema: + $ref: '#/definitions/UpdateHbasePolicyResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' + /api/v1/replicationmanager/continueHbaseSetup: + post: + summary: Continue the setup of an HBase policy. + 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. + operationId: continueHbaseSetup + x-mutating: true + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/ContinueHbaseSetupRequest' + responses: + 200: + description: Describes a successful response to a valid request. + schema: + $ref: '#/definitions/ContinueHbaseSetupResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' + /api/v1/replicationmanager/suspendHbasePolicy: + post: + summary: Suspend an HBase replication policy. + 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. + operationId: suspendHbasePolicy + x-mutating: true + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/SuspendHbasePolicyRequest' + responses: + 200: + description: Describes a successful response to a valid request. + schema: + $ref: '#/definitions/SuspendHbasePolicyResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' + /api/v1/replicationmanager/activateHbasePolicy: + post: + summary: Resume a suspended HBase replication policy. + 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. + operationId: activateHbasePolicy + x-mutating: true + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/ActivateHbasePolicyRequest' + responses: + 200: + description: Describes a successful response to a valid request. + schema: + $ref: '#/definitions/ActivateHbasePolicyResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' + /api/v1/replicationmanager/deleteHbasePolicy: + post: + summary: Delete an HBase Replication Policy. + description: Permanently deletes a specific HBase replication policy. + operationId: deleteHbasePolicy + x-mutating: true + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/DeleteHbasePolicyRequest' + responses: + 200: + description: Describes a successful response to a valid request. + schema: + $ref: '#/definitions/DeleteHbasePolicyResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' + /api/v1/replicationmanager/listPairedHbaseClusters: + post: + summary: List cluster CRNs which have an active HBase policy. + description: Provides a list of cluster CRNs with active HBase policies. + operationId: listPairedHbaseClusters + x-mutating: false + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/ListPairedHbaseClustersRequest' + responses: + 200: + description: Describes a successful response to a valid request. + schema: + $ref: '#/definitions/ListPairedHbaseClustersResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' + /api/v1/replicationmanager/verifyHbaseClusterPair: + post: + summary: Verify a source-destination cluster pair for HBase policy creation. + description: Returns whether the cluster pair is ready for policy creation, or if there are some manual steps that need to be performed before. + operationId: verifyHbaseClusterPair + x-mutating: false + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/VerifyHbaseClusterPairRequest' + responses: + 200: + description: Describes a successful response to a valid request. + schema: + $ref: '#/definitions/VerifyHbaseClusterPairResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' /api/v1/replicationmanager/downloadDiagnosticBundle: post: summary: Download diagnostic bundle for a policy. @@ -519,6 +708,71 @@ definitions: type: array items: $ref: '#/definitions/ApiError' + GetClusterConfigRequest: + type: object + description: Request object for getClusterConfig. + required: + - clusterCrn + properties: + clusterCrn: + type: string + description: The CRN of the cluster. + GetClusterConfigResponse: + type: object + description: Response object for getClusterConfig. + properties: + clusterCrn: + description: The CRN of the cluster. + type: string + cmApiVersion: + description: Cloudera Manager API version. + type: integer + format: int32 + underlyingFsForHive: + description: Underlying file system for Hive. + type: string + enum: + - HDFS + - S3 + - WASB + - ABFS + - GCS + dmx: + description: Configuration related to DMX. + type: object + properties: + hbaseSuspend: + description: Suspend type for HBase policies. + $ref: '#/definitions/HbaseSuspendType' + featureSupport: + description: A map of available features and whether they are supported on the cluster. + type: object + additionalProperties: + type: boolean + services: + description: A list of service configurations. + type: array + items: + $ref: '#/definitions/ServiceConfiguration' + ServiceConfiguration: + description: Configuration related to a service. + type: object + properties: + name: + description: The name of the service. + type: string + configs: + description: Service configuration map. + type: object + additionalProperties: + type: string + HbaseSuspendType: + description: 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: string + enum: + - POLICY + - ALL + - NOT_SUPPORTED ListPoliciesRequest: type: object description: Request object for listing all policies. @@ -581,6 +835,269 @@ definitions: CreatePolicyResponse: type: object description: Response object for createPolicy. + CreateHbasePolicyRequest: + type: object + description: Create an HBase replication policy. + required: + - clusterCrn + - policyName + - policyDefinition + properties: + clusterCrn: + description: CRN of the destination cluster. + type: string + policyName: + type: string + description: Name of the new policy. + policyDefinition: + description: Policy definition. + $ref: '#/definitions/HbasePolicyDefinition' + CreateHbasePolicyResponse: + type: object + description: Response object for createHbasePolicy. + properties: + clusterCrn: + type: string + description: The CRN of the input cluster. + message: + type: string + description: The detailed description of the action taken. + status: + type: string + description: The status of the request. + UpdateHbasePolicyRequest: + type: object + description: Update HBase replication policy request. + required: + - clusterCrn + - policyId + - updateHbasePolicyDefinition + properties: + clusterCrn: + type: string + description: The CRN of the cluster where the policy will be updated. + policyId: + type: string + description: The ID of the policy to be updated. + updateHbasePolicyDefinition: + description: The policy definition. + $ref: '#/definitions/UpdateHbasePolicyDefinition' + UpdateHbasePolicyDefinition: + type: object + description: HBase policy update request definition. + properties: + name: + type: string + description: The policy name. + description: + type: string + description: Description of the policy. + tables: + description: List of tables to be replicated. The items should be in "namespace:tablename" format. + x-default: null + type: array + items: + type: string + UpdateHbasePolicyResponse: + type: object + description: Response object for updateHbasePolicy. + properties: + clusterCrn: + type: string + description: The CRN of the input cluster. + requestId: + type: string + description: The ID of the request. Populated only for Ambari backend. + message: + type: string + description: The detailed description of the action taken. + status: + type: string + description: The status of the request (Successful or an error). + ContinueHbaseSetupRequest: + type: object + description: Continue an HBase setup for Classic Cluster source. + required: + - clusterCrn + - policyId + properties: + clusterCrn: + type: string + description: The CRN of the destination cluster. + policyId: + type: string + description: The ID of the HBase policy. + ContinueHbaseSetupResponse: + type: object + description: Response object for continueHbaseSetup. + properties: + clusterCrn: + type: string + description: The CRN of the input cluster. + message: + type: string + description: The detailed description of the action taken. + status: + type: string + description: The status of the request. + ActivateHbasePolicyRequest: + type: object + description: Activate an HBase replication policy. + required: + - clusterCrn + - policyId + properties: + clusterCrn: + type: string + description: CRN of the destination cluster. + policyId: + type: string + description: ID of the HBase policy. + ActivateHbasePolicyResponse: + type: object + description: Response object for activateHbasePolicy. + properties: + clusterCrn: + type: string + description: The CRN of the input cluster. + message: + type: string + description: The detailed description of the action taken. + status: + type: string + description: The status of the request. + SuspendHbasePolicyRequest: + type: object + description: Suspend an HBase replication policy. + required: + - clusterCrn + - policyId + properties: + clusterCrn: + type: string + description: CRN of the destination cluster. + policyId: + type: string + description: ID of the HBase policy. + SuspendHbasePolicyResponse: + type: object + description: Response object for suspendHbasePolicy. + properties: + clusterCrn: + type: string + description: The CRN of the input cluster. + message: + type: string + description: The detailed description of the action taken. + status: + type: string + description: The status of the request. + DeleteHbasePolicyRequest: + type: object + description: Request object to delete an HBase replication policy. + required: + - clusterCrn + - policyId + properties: + clusterCrn: + type: string + description: CRN of the destination cluster. + policyId: + type: string + description: ID of the HBase policy. + force: + type: boolean + description: Option to force delete an Hbase policy. It should be used if the normal delete fails (e.g. when the source cluster is unreachable). + DeleteHbasePolicyResponse: + type: object + description: Response object for deleteHbasePolicy. + properties: + clusterCrn: + type: string + description: The CRN of the input cluster. + message: + type: string + description: The detailed description of the action taken. + status: + type: string + description: The status of the request. + ListPairedHbaseClustersRequest: + type: object + description: Request to list all paired HBase cluster CRNs. + ListPairedHbaseClustersResponse: + type: object + description: Response object for listPairedHbaseClusters. + properties: + pairings: + description: The list of CRN pairings. + type: array + items: + $ref: '#/definitions/HbaseCrnPairs' + crnsMissingHbaseService: + description: Cluster CRNs where the HBase service was missing and pairing status could not be determined. + type: array + items: + type: string + unreachableClusters: + description: The list of errors for unreachable clusters. + type: array + items: + $ref: '#/definitions/ApiError' + VerifyHbaseClusterPairRequest: + type: object + description: Request to verify a cluster pairing for HBase policy creation prerequisites. + required: + - sourceClusterCrn + - destinationClusterCrn + properties: + sourceClusterCrn: + type: string + description: CRN of the source cluster. + destinationClusterCrn: + type: string + description: CRN of the destination cluster. + VerifyHbaseClusterPairResponse: + type: object + description: Response object for verifyHbaseClusterPair. + properties: + pairingStatus: + description: The current status of pairing. + type: string + pairedStatus: + description: Substatus of an active pairing. Indicates if a pairing is resettable or in an erroneous state. + type: string + pairingMessage: + description: Description of the pairing status. + type: string + beforePolicySteps: + description: Manual steps to perform before HBase policy creation. + type: object + properties: + summary: + description: Summary of the steps to perform. + type: string + documentationLink: + description: Link to the HBase replication manual steps documentation. + type: string + source: + description: Steps to perform for the source cluster. + $ref: '#/definitions/VerificationSteps' + destination: + description: Steps to perform for the destination cluster. + $ref: '#/definitions/VerificationSteps' + afterPolicySteps: + description: Manual steps to perform after HBase policy creation. + type: object + properties: + summary: + description: Summary of the steps to perform. + type: string + source: + description: Steps to perform for the source cluster. + $ref: '#/definitions/VerificationSteps' + destination: + description: Steps to perform for the destination cluster. + $ref: '#/definitions/VerificationSteps' SuspendPolicyRequest: type: object description: Suspend a replication policy. @@ -1423,6 +1940,111 @@ definitions: sourceUser: description: Source user. type: string + HbasePolicyDefinition: + type: object + description: HBase policy definition. + required: + - hbasePolicyArguments + - sourceCluster + - targetCluster + - initialSnapshot + properties: + hbasePolicyArguments: + description: HBase policy arguments. + $ref: '#/definitions/HbasePolicyArguments' + sourceCluster: + description: 'Name of source cluster in the format: "dataCenterName$cluster name", for example "DC-Europe$My Source 42."' + type: string + targetCluster: + description: 'Name of destination cluster in the format: "dataCenterName$cluster name", for example "DC-US$My Destination 17".' + type: string + initialSnapshot: + description: 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. + type: boolean + description: + description: Description of the policy. + type: string + machineUser: + description: Machine user details to use for the replication. If not specified, an internal machine user will be created and synchronized to the required environments. + $ref: '#/definitions/MachineUser' + queueName: + description: YARN queue name to use for initial snapshot if not default. + type: string + distcpMaxMaps: + description: Maximum Map jobs to use for initial snapshot. + type: integer + format: int64 + sourceRestartType: + description: 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. + $ref: '#/definitions/RestartType' + targetRestartType: + description: Type of restart for the destination cluster. This is only accepted if the cluster has restart-type support. Default is ROLLING_RESTART. + $ref: '#/definitions/RestartType' + HbasePolicyArguments: + type: object + description: HBase replication parameters. + properties: + tables: + description: 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. + type: array + x-default: null + items: + type: string + cloudCredential: + description: Cloud credentials to use to replicate the initial snapshot if the credential location is specified as 'EXTERNAL_ACCOUNT'. + type: string + databaseArguments: + description: Optional parameters used for HBase database replication. + $ref: '#/definitions/HbaseDatabaseArguments' + HbaseDatabaseArguments: + type: object + description: HBase database replication arguments. + properties: + replicationStrategy: + description: Whether to replicate all tables or only the ones where the replication scope has been set. Defaults to ALL_TABLES. + type: string + enum: + - ALL_TABLES + - TABLES_WITH_REPLICATION_SCOPE_SET + MachineUser: + type: object + description: Username and password for the machine user. + required: + - user + - password + - createUser + properties: + user: + description: Username. + type: string + password: + description: Password. + x-sensitive: true + type: string + createUser: + description: 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. + type: boolean + HbaseCrnPairs: + type: object + description: HBase CRN pairs. + properties: + pairedCrns: + description: The list of CRNs which are peers of each other. + type: array + items: + type: string + VerificationSteps: + type: object + description: Verification steps. + properties: + clusterManagerUrl: + description: The cluster manager URL to reach the cluster's UI. + type: string + steps: + description: The list of manual steps to perform or verify. + type: array + items: + type: string AwsCloudCredentialType: type: string description: AWS cloud credential type. @@ -1435,3 +2057,9 @@ definitions: enum: - ACCESSKEY - CLIENTKEY + RestartType: + type: string + description: Type of restart for a cluster. + enum: + - RESTART + - ROLLING_RESTART