From 70a3ba195fe6a2cc18b792489f5f97eb19d7e659 Mon Sep 17 00:00:00 2001 From: SRE Service Date: Wed, 13 Nov 2024 18:18:30 -0800 Subject: [PATCH] CDP Beta API Documentation 0.9.126 --- api-docs-beta/CHANGELOG.md | 10 + api-docs-beta/README.md | 40 +- api-docs-beta/audit/index.html | 4 +- api-docs-beta/cloudprivatelinks/index.html | 56 +- api-docs-beta/compute/index.html | 34 +- api-docs-beta/consumption/index.html | 4 +- api-docs-beta/datacatalog/index.html | 4 +- api-docs-beta/datahub/index.html | 10 +- api-docs-beta/datalake/index.html | 4 +- api-docs-beta/de/index.html | 4 +- api-docs-beta/df/index.html | 4 +- api-docs-beta/dfworkload/index.html | 4 +- api-docs-beta/drscp/index.html | 4 +- api-docs-beta/dw/index.html | 18 +- api-docs-beta/environments/index.html | 743 +++- api-docs-beta/iam/index.html | 4 +- api-docs-beta/imagecatalog/index.html | 4 +- api-docs-beta/metrics/index.html | 4 +- api-docs-beta/ml/index.html | 4 +- api-docs-beta/opdb/index.html | 4 +- api-docs-beta/replicationmanager/index.html | 3646 ++++++++++++----- api-docs-beta/swagger/README.md | 40 +- api-docs-beta/swagger/audit.yaml | 2 +- api-docs-beta/swagger/cloudprivatelinks.yaml | 18 +- api-docs-beta/swagger/compute.yaml | 15 +- api-docs-beta/swagger/consumption.yaml | 2 +- api-docs-beta/swagger/datacatalog.yaml | 2 +- api-docs-beta/swagger/datahub.yaml | 8 +- api-docs-beta/swagger/datalake.yaml | 2 +- api-docs-beta/swagger/de.yaml | 2 +- api-docs-beta/swagger/df.yaml | 2 +- api-docs-beta/swagger/dfworkload.yaml | 2 +- api-docs-beta/swagger/drscp.yaml | 2 +- api-docs-beta/swagger/dw.yaml | 23 +- api-docs-beta/swagger/environments.yaml | 85 +- api-docs-beta/swagger/iam.yaml | 2 +- api-docs-beta/swagger/imagecatalog.yaml | 2 +- api-docs-beta/swagger/metrics.yaml | 2 +- api-docs-beta/swagger/ml.yaml | 2 +- api-docs-beta/swagger/opdb.yaml | 2 +- api-docs-beta/swagger/replicationmanager.yaml | 619 ++- 41 files changed, 4082 insertions(+), 1361 deletions(-) diff --git a/api-docs-beta/CHANGELOG.md b/api-docs-beta/CHANGELOG.md index cb4f2367e..c7d3f5d18 100644 --- a/api-docs-beta/CHANGELOG.md +++ b/api-docs-beta/CHANGELOG.md @@ -1,5 +1,15 @@ # CDP Control Plane Public API Changelog +## 0.9.126 (2024-11-13) +* cloudprivatelinks: Add properties `subscriptionId` and `cloudServiceProvider` to `AuthorizePrivateLinkServiceAccessRequest` and `RevokePrivateLinkServiceAccessRequest` objects. +* datahub: Change description of property `type` in `Recipe`, `RecipeSummary` and `CreateRecipeRequest` objects. +* dw: Deprecate properties `dbDas` and `dbHue` in `PrivateCloudActivationOptions` object. +* dw: Deprecate properties `dbMetastore`, `dbDas` and `dbHue` in `CreateDbcRequest` object. +* dw: Deprecate property `securityContextConstraintName` in `CreatePrivateClusterRequest` and `PrivateCloudActivationOptions` objects. +* environments: Deprecate property `s3GuardTableName` in `CreateAWSEnvironmentRequest`, `CreateAWSGovCloudEnvironmentRequest` and `Environment` object’s `awsDetails` objects. +* environments: Add new command `lastSyncStatus`. +* replicationmanager: Add new properties `clusterCrn`, `requestId`, `message` and `status` to `ActivatePolicyResponse`, `CreatePolicyResponse`, `DeletePolicyResponse` and `SuspendPolicyResponse` objects. + ## 0.9.125 (2024-10-30) * datalake: Add new object 'DiskOptions' to 'StartDatalakeVerticalScalingRequest' & 'startDatalakeVerticalScaling' object. * datalake: Add new object 'AddDisks', 'ModifyDisks' to 'DiskOptions' object. diff --git a/api-docs-beta/README.md b/api-docs-beta/README.md index 9cef60cd2..cc245cdff 100644 --- a/api-docs-beta/README.md +++ b/api-docs-beta/README.md @@ -1,30 +1,30 @@ # CDP Control Plane Public API Documentation -*Version: 0.9.125 (BETA)* +*Version: 0.9.126 (BETA)* Available documentation is listed by service below. | Service | Version | | --- | --- | -| [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 | -| [metrics](./metrics/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 | +| [audit](./audit/index.html) | 0.9.126 | +| [cloudprivatelinks](./cloudprivatelinks/index.html) | 0.9.126 | +| [compute](./compute/index.html) | 0.9.126 | +| [consumption](./consumption/index.html) | 0.9.126 | +| [datacatalog](./datacatalog/index.html) | 0.9.126 | +| [datahub](./datahub/index.html) | 0.9.126 | +| [datalake](./datalake/index.html) | 0.9.126 | +| [de](./de/index.html) | 0.9.126 | +| [df](./df/index.html) | 0.9.126 | +| [dfworkload](./dfworkload/index.html) | 0.9.126 | +| [drscp](./drscp/index.html) | 0.9.126 | +| [dw](./dw/index.html) | 0.9.126 | +| [environments](./environments/index.html) | 0.9.126 | +| [iam](./iam/index.html) | 0.9.126 | +| [imagecatalog](./imagecatalog/index.html) | 0.9.126 | +| [metrics](./metrics/index.html) | 0.9.126 | +| [ml](./ml/index.html) | 0.9.126 | +| [opdb](./opdb/index.html) | 0.9.126 | +| [replicationmanager](./replicationmanager/index.html) | 0.9.126 | 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-beta/audit/index.html b/api-docs-beta/audit/index.html index 3b534f8a5..bd7ff5832 100644 --- a/api-docs-beta/audit/index.html +++ b/api-docs-beta/audit/index.html @@ -822,7 +822,7 @@

Overview

Version information

-

Version : 0.9.125 (BETA)

+

Version : 0.9.126 (BETA)

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

MarkArchiveBatchesAsSuccessfulR


diff --git a/api-docs-beta/cloudprivatelinks/index.html b/api-docs-beta/cloudprivatelinks/index.html index c34eb7317..97803c5f0 100644 --- a/api-docs-beta/cloudprivatelinks/index.html +++ b/api-docs-beta/cloudprivatelinks/index.html @@ -775,7 +775,7 @@

Overview

Version information

-

Version : 0.9.125 (BETA)

+

Version : 0.9.126 (BETA)

@@ -1526,7 +1526,7 @@

AuthorizePrivateLinkServiceAc optional

-

Account ID to authorize access for PrivateLink.

+

AWS account ID to authorize access for PrivateLink.

string

@@ -1534,6 +1534,18 @@

AuthorizePrivateLinkServiceAc
+

cloudServiceProvider
+optional

+
+
+

Cloud Service Provider. Currently supporting AWS and AZURE.

+
+ + + +

region
optional

@@ -1556,6 +1568,18 @@

AuthorizePrivateLinkServiceAc

string

+ +
+

subscriptionId
+optional

+
+
+

Azure subscription ID to authorize access for PrivateLink.

+
+
+

string

+
+ @@ -2592,7 +2616,7 @@

RevokePrivateLinkServiceAccessRe optional

-

Account ID to revoke access for PrivateLink.

+

AWS account ID to authorize access for PrivateLink.

string

@@ -2600,6 +2624,18 @@

RevokePrivateLinkServiceAccessRe
+

cloudServiceProvider
+optional

+
+
+

Cloud Service Provider. Currently supporting AWS and AZURE.

+
+ + + +

region
optional

@@ -2622,6 +2658,18 @@

RevokePrivateLinkServiceAccessRe

string

+ +
+

subscriptionId
+optional

+
+
+

Azure subscription ID to authorize access for PrivateLink.

+
+
+

string

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

RevokePrivateLinkServiceAccessRes
diff --git a/api-docs-beta/compute/index.html b/api-docs-beta/compute/index.html index 9d5dcc68d..f400052e9 100644 --- a/api-docs-beta/compute/index.html +++ b/api-docs-beta/compute/index.html @@ -920,7 +920,7 @@

Overview

Version information

-

Version : 0.9.125 (BETA)

+

Version : 0.9.126 (BETA)

@@ -5221,24 +5221,12 @@

CommonSecretEncryption

optional

-

The KMS key ARN used.

+

AWS KMS key ARN.

string

- -
-

enabled
-optional

-
-
-

Flag to enable secret encryption (default true). Deprecated.

-
-
-

boolean

-
- @@ -5267,24 +5255,12 @@

CommonSecretEncryptionResp

optional

-

The KMS key ARN used.

+

AWS KMS key ARN.

string

- -
-

enabled
-optional

-
-
-

Flag to indicate if secret encryption is enabled.

-
-
-

boolean

-
- @@ -5763,7 +5739,7 @@

CommonVolumeEncryptionResp

optional

-

The KMS key ARN used.

+

AWS KMS key ARN.

string

@@ -10100,7 +10076,7 @@

ValidationSummary


diff --git a/api-docs-beta/consumption/index.html b/api-docs-beta/consumption/index.html index 86ea2540b..bd0872333 100644 --- a/api-docs-beta/consumption/index.html +++ b/api-docs-beta/consumption/index.html @@ -720,7 +720,7 @@

Overview

Version information

-

Version : 0.9.125 (BETA)

+

Version : 0.9.126 (BETA)

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

ListComputeUsageRecordsResponse


diff --git a/api-docs-beta/datacatalog/index.html b/api-docs-beta/datacatalog/index.html index 52b63a950..844f42b37 100644 --- a/api-docs-beta/datacatalog/index.html +++ b/api-docs-beta/datacatalog/index.html @@ -721,7 +721,7 @@

Overview

Version information

-

Version : 0.9.125 (BETA)

+

Version : 0.9.126 (BETA)

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

LaunchProfilersResponse


diff --git a/api-docs-beta/datahub/index.html b/api-docs-beta/datahub/index.html index a0ad8df06..fb208fde6 100644 --- a/api-docs-beta/datahub/index.html +++ b/api-docs-beta/datahub/index.html @@ -1406,7 +1406,7 @@

Overview

Version information

-

Version : 0.9.125 (BETA)

+

Version : 0.9.126 (BETA)

@@ -12022,7 +12022,7 @@

CreateRecipeRequest

required

-

The type of recipe. Supported values are : PRE_CLOUDERA_MANAGER_START, PRE_TERMINATION, POST_CLOUDERA_MANAGER_START, POST_CLUSTER_INSTALL.

+

The type of recipe. Supported values are : PRE_SERVICE_DEPLOYMENT, PRE_TERMINATION, POST_SERVICE_DEPLOYMENT, POST_CLOUDERA_MANAGER_START.

string

@@ -17214,7 +17214,7 @@

Recipe

optional

-

The type of recipe. Supported values are : PRE_CLOUDERA_MANAGER_START, PRE_TERMINATION, POST_CLOUDERA_MANAGER_START, POST_CLUSTER_INSTALL.

+

The type of recipe. Supported values are : PRE_SERVICE_DEPLOYMENT, PRE_TERMINATION, POST_SERVICE_DEPLOYMENT, POST_CLOUDERA_MANAGER_START.

string

@@ -17284,7 +17284,7 @@

RecipeSummary

optional

-

The type of recipe. Supported values are : PRE_CLOUDERA_MANAGER_START, PRE_TERMINATION, POST_CLOUDERA_MANAGER_START, POST_CLUSTER_INSTALL.

+

The type of recipe. Supported values are : PRE_SERVICE_DEPLOYMENT, PRE_TERMINATION, POST_SERVICE_DEPLOYMENT, POST_CLOUDERA_MANAGER_START.

string

@@ -19259,7 +19259,7 @@

VolumeEncryptionRequest


diff --git a/api-docs-beta/datalake/index.html b/api-docs-beta/datalake/index.html index 9e338619c..129f9806d 100644 --- a/api-docs-beta/datalake/index.html +++ b/api-docs-beta/datalake/index.html @@ -1240,7 +1240,7 @@

Overview

Version information

-

Version : 0.9.125 (BETA)

+

Version : 0.9.126 (BETA)

@@ -14925,7 +14925,7 @@

ValidateAzureCloudStorageResponse
diff --git a/api-docs-beta/de/index.html b/api-docs-beta/de/index.html index cee3ba731..418bd18bf 100644 --- a/api-docs-beta/de/index.html +++ b/api-docs-beta/de/index.html @@ -915,7 +915,7 @@

Overview

Version information

-

Version : 0.9.125 (BETA)

+

Version : 0.9.126 (BETA)

@@ -7494,7 +7494,7 @@

VcSummary


diff --git a/api-docs-beta/df/index.html b/api-docs-beta/df/index.html index faee14d8e..4e9a3d346 100644 --- a/api-docs-beta/df/index.html +++ b/api-docs-beta/df/index.html @@ -1212,7 +1212,7 @@

Overview

Version information

-

Version : 0.9.125 (BETA)

+

Version : 0.9.126 (BETA)

@@ -14419,7 +14419,7 @@

UpgradeServiceResponse


diff --git a/api-docs-beta/dfworkload/index.html b/api-docs-beta/dfworkload/index.html index 7d1cb9151..39f521b57 100644 --- a/api-docs-beta/dfworkload/index.html +++ b/api-docs-beta/dfworkload/index.html @@ -1214,7 +1214,7 @@

Overview

Version information

-

Version : 0.9.125 (BETA)

+

Version : 0.9.126 (BETA)

@@ -14359,7 +14359,7 @@

ValidateCustomPythonConfigur


diff --git a/api-docs-beta/drscp/index.html b/api-docs-beta/drscp/index.html index 195391f96..f9d944b3a 100644 --- a/api-docs-beta/drscp/index.html +++ b/api-docs-beta/drscp/index.html @@ -797,7 +797,7 @@

Overview

Version information

-

Version : 0.9.125 (BETA)

+

Version : 0.9.126 (BETA)

@@ -2842,7 +2842,7 @@

SimpleRestore


diff --git a/api-docs-beta/dw/index.html b/api-docs-beta/dw/index.html index 1504bbac6..1747f4d8f 100644 --- a/api-docs-beta/dw/index.html +++ b/api-docs-beta/dw/index.html @@ -1627,7 +1627,7 @@

Overview

Version information

-

Version : 0.9.125 (BETA)

+

Version : 0.9.126 (BETA)

@@ -14392,7 +14392,7 @@

CreateDbcRequest

optional

-

The name of the DAS database. Not required for embedded databases.
+

DEPRECATED: Current Private Cloud releases only support embedded database, the value of this field is ignored. The name of the DAS database. Not required for embedded databases.
Default : ""

@@ -14405,7 +14405,7 @@

CreateDbcRequest

optional

-

The name of the HUE database. Not required for embedded databases.
+

DEPRECATED: Current Private Cloud releases only support embedded database, the value of this field is ignored. The name of the HUE database. Not required for embedded databases.
Default : ""

@@ -14418,7 +14418,7 @@

CreateDbcRequest

optional

-

The name of the Metastore database.
+

DEPRECATED: Current Private Cloud releases only support embedded database, the value of this field is ignored. The name of the Metastore database.
Default : ""

@@ -14643,7 +14643,7 @@

CreatePrivateClusterRequest

optional

-

The name of the Hive Security Context Constraint.

+

DEPRECATED: This option will be removed in future releases. Instead of creating a custom Security Context Constraint, we rely on the cluster default. The name of the Hive Security Context Constraint.

string

@@ -21505,7 +21505,7 @@

PrivateCloudActivationOptions

optional

-

The name of the DAS database. Not required for embedded databases

+

DEPRECATED: Current Private Cloud releases only support embedded database, the value of this field is ignored. The name of the DAS database. Not required for embedded databases.

string

@@ -21517,7 +21517,7 @@

PrivateCloudActivationOptions

optional

-

The name of the HUE database. Not required for embedded databases.

+

DEPRECATED: Current Private Cloud releases only support embedded database, the value of this field is ignored. The name of the HUE database. Not required for embedded databases.

string

@@ -21566,7 +21566,7 @@

PrivateCloudActivationOptions

optional

-

The name of the Hive Security Context Constraint.

+

DEPRECATED: This option will be removed in future releases. Instead of creating a custom Security Context Constraint, we rely on the cluster default. The name of the Hive Security Context Constraint.

string

@@ -26375,7 +26375,7 @@

VwType


diff --git a/api-docs-beta/environments/index.html b/api-docs-beta/environments/index.html index db3cae119..eb9e188e6 100644 --- a/api-docs-beta/environments/index.html +++ b/api-docs-beta/environments/index.html @@ -1012,377 +1012,384 @@

Cloudera Environments Service

  • Responses
  • -
  • Lists audit credentials. +
  • Returns status of the sync operation for the environment crn.
  • -
  • Returns the list of Data Services and their cluster names that are attached the given environment. +
  • Lists audit credentials.
  • -
  • Lists credentials. +
  • Returns the list of Data Services and their cluster names that are attached the given environment.
  • -
  • Lists environments. +
  • Lists credentials.
  • -
  • List recent FreeIPA diagnostics collections +
  • Lists environments.
  • -
  • Lists all FreeIPA related secret types. +
  • List recent FreeIPA diagnostics collections
  • -
  • Lists proxy configs. +
  • Lists all FreeIPA related secret types.
  • -
  • Recreate FreeIPA in case of disaster. +
  • Lists proxy configs.
  • -
  • Repairs the FreeIPA nodes. +
  • Recreate FreeIPA in case of disaster.
  • -
  • Retries the last failed operation on a FreeIPA. +
  • Repairs the FreeIPA nodes.
  • -
  • Rotate FreeIPA related secret for FreeIPA instances. +
  • Retries the last failed operation on a FreeIPA.
  • -
  • Rotate SaltStack user password on FreeIPA instances. +
  • Rotate FreeIPA related secret for FreeIPA instances.
  • -
  • Creates or updates the AWS audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage. +
  • Rotate SaltStack user password on FreeIPA instances.
  • -
  • Creates or updates the AWS GovCloud audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage. +
  • Creates or updates the AWS audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage.
  • -
  • Set account level telemetry settings. (telemetry features and anonymization rules) +
  • Creates or updates the AWS GovCloud audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage.
  • -
  • Creates or updates the Azure audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage. +
  • Set account level telemetry settings. (telemetry features and anonymization rules)
  • -
  • Sets a catalog for a FreeIPA installation. +
  • Creates or updates the Azure audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage.
  • -
  • Sets endpoint access gateway settings for the environment. +
  • Sets a catalog for a FreeIPA installation.
  • -
  • Read a configuration setting from the environment service. +
  • Sets endpoint access gateway settings for the environment.
  • -
  • Creates or updates the GCP audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage. +
  • Read a configuration setting from the environment service.
  • -
  • Sets all ID Broker mappings for an environment. +
  • Creates or updates the GCP audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage.
  • -
  • Sets workload user’s password and updates into all environments. +
  • Sets all ID Broker mappings for an environment.
  • -
  • Configure environment level telemetry feature setting. +
  • Sets workload user’s password and updates into all environments.
  • -
  • Start an environment. +
  • Configure environment level telemetry feature setting.
  • -
  • Initiates the vertical scaling on FreeIPA. +
  • Start an environment.
  • -
  • Stop an environment. +
  • Initiates the vertical scaling on FreeIPA.
  • -
  • Synchronizes environments with all users and groups state with CDP. +
  • Stop an environment.
  • -
  • Syncs all ID Broker mappings for an environment. +
  • Synchronizes environments with all users and groups state with CDP.
  • -
  • Returns status of the sync operation for the operation id. +
  • Syncs all ID Broker mappings for an environment.
  • -
  • Synchronizes environments with single user to the FreeIPA servers. +
  • Returns status of the sync operation for the operation id.
  • -
  • Synchronizes all environments in the calling account. +
  • Synchronizes environments with single user to the FreeIPA servers.
  • -
  • Test anonymization rules (for account telemetry) against text input. +
  • Synchronizes all environments in the calling account.
  • -
  • Updates an AWS credential that can be attached to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud provider account. +
  • Test anonymization rules (for account telemetry) against text input.
  • -
  • Update the AWS encryption key ARN for the environment. +
  • Updates an AWS credential that can be attached to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud provider account.
  • -
  • Update the Availability Zones for the Azure environment. +
  • Update the AWS encryption key ARN for the environment.
  • -
  • Updates a new certificate based Azure credential that can be attached to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud provider account. +
  • Update the Availability Zones for the Azure environment.
  • -
  • Update the Azure database resources for the environment. +
  • Updates a new certificate based Azure credential that can be attached to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud provider account.
  • -
  • Update the Azure encryption resources for the environment. +
  • Update the Azure database resources for the environment.
  • -
  • Updates account level Azure Marketplace image policy. CDP is capable to automatically accept Azure Marketplace image terms during cluster deployment. You can use this setting in your account to opt in or opt out this behaviour. +
  • Update the Azure encryption resources for the environment.
  • -
  • Updates custom docker registry CRN of an environment. +
  • Updates account level Azure Marketplace image policy. CDP is capable to automatically accept Azure Marketplace image terms during cluster deployment. You can use this setting in your account to opt in or opt out this behaviour.
  • -
  • Updates Data Service resources of an environment. +
  • Updates custom docker registry CRN of an environment.
  • -
  • Updates FreeIPA AWS cluster to use IMDSv1. +
  • Updates Data Service resources of an environment.
  • -
  • Updates FreeIPA AWS cluster to use IMDSv2. +
  • Updates FreeIPA AWS cluster to use IMDSv1.
  • -
  • Run orchestrator engine state update on the FreeIPA cluster. +
  • Updates FreeIPA AWS cluster to use IMDSv2.
  • -
  • Updates the proxy config of the given environment. +
  • Run orchestrator engine state update on the FreeIPA cluster.
  • -
  • Updates the security access settings of the given environment. +
  • Updates the proxy config of the given environment.
  • -
  • Updates the designated SSH key for the given environment. +
  • Updates the security access settings of the given environment.
  • -
  • Updates the subnet(s) of the given environment. +
  • Updates the designated SSH key for the given environment.
  • -
  • Upgrades Cluster Connectivity Manager on the environment to the latest available version. +
  • Updates the subnet(s) of the given environment.
  • -
  • Upgrades FreeIPA to the latest or defined image. +
  • Upgrades Cluster Connectivity Manager on the environment to the latest available version.
  • -
  • Upscales FreeIPA instances. +
  • Upgrades FreeIPA to the latest or defined image.
  • -
  • Validates AWS cloud storage settings of the given environment. +
  • Upscales FreeIPA instances.
  • -
  • Validates Azure cloud storage settings of the given environment. +
  • Validates AWS cloud storage settings of the given environment.
  • +
  • Validates Azure cloud storage settings of the given environment. + +
  • Definitions @@ -1543,6 +1550,8 @@

    Cloudera Environments Service

  • InitializeAzureComputeClusterResponse
  • InstanceTemplate
  • LastAutomatedSyncDetails
  • +
  • LastSyncStatusRequest
  • +
  • LastSyncStatusResponse
  • ListAuditCredentialsRequest
  • ListAuditCredentialsResponse
  • ListConnectedDataServicesRequest
  • @@ -1683,7 +1692,7 @@

    Overview

    Version information

    -

    Version : 0.9.125 (BETA)

    +

    Version : 0.9.126 (BETA)

    @@ -5681,6 +5690,92 @@

    Responses

    +

    Returns status of the sync operation for the environment crn.

    +
    +
    +
    POST /api/v1/environments2/lastSyncStatus
    +
    +
    +
    +

    Description

    +
    +

    Returns status of the sync operation for the environment based on crn.

    +
    +
    +
    +

    Parameters

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

    Body

    +
    +

    input
    +required

    +
    +
    +
    +

    Responses

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

    200

    +
    +

    Expected response to a valid request.

    +
    +

    default

    +
    +

    The default response on an error.

    +
    +

    Error

    +
    +
    +
    +

    Lists audit credentials.

    @@ -5688,13 +5783,13 @@

    Lists audit credentials.

    -

    Description

    +

    Description

    Lists audit credentials.

    -

    Parameters

    +

    Parameters

    @@ -5725,7 +5820,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -5774,13 +5869,13 @@

    Returns the list of Data Services and their
    -

    Description

    +

    Description

    Returns the list of Data Services and their cluster names that are attached to the given environment.

    -

    Parameters

    +

    Parameters

    @@ -5811,7 +5906,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -5860,13 +5955,13 @@

    Lists credentials.

    -

    Description

    +

    Description

    Lists credentials.

    -

    Parameters

    +

    Parameters

    @@ -5897,7 +5992,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -5946,13 +6041,13 @@

    Lists environments.

    -

    Description

    +

    Description

    Lists environments.

    -

    Parameters

    +

    Parameters

    @@ -5983,7 +6078,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6032,13 +6127,13 @@

    List recent FreeIPA diagnostics collections

    -

    Description

    +

    Description

    List recent FreeIPA diagnostics collection

    -

    Parameters

    +

    Parameters

    @@ -6069,7 +6164,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6118,13 +6213,13 @@

    Lists all FreeIPA related secret types.

    -

    Description

    +

    Description

    Lists FreeIPA related secret types for FreeIPA instances.

    -

    Parameters

    +

    Parameters

    @@ -6155,7 +6250,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6204,13 +6299,13 @@

    Lists proxy configs.

    -

    Description

    +

    Description

    Lists proxy configs.

    -

    Parameters

    +

    Parameters

    @@ -6241,7 +6336,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6290,13 +6385,13 @@

    Recreate FreeIPA in case of disaster.

    -

    Description

    +

    Description

    If FreeIPA backups are available and all of the FreeIPA nodes are lost, this command recreates FreeIPA from scratch and restores backup.

    -

    Parameters

    +

    Parameters

    @@ -6327,7 +6422,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6376,13 +6471,13 @@

    Repairs the FreeIPA nodes.

    -

    Description

    +

    Description

    Repairs the FreeIPA nodes if they are in a non working state.

    -

    Parameters

    +

    Parameters

    @@ -6413,7 +6508,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6462,13 +6557,13 @@

    Retries the last failed operation on a FreeIPA.

    -

    Description

    +

    Description

    Retries the last failed operation on a FreeIPA.

    -

    Parameters

    +

    Parameters

    @@ -6499,7 +6594,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6548,13 +6643,13 @@

    Rotate FreeIPA related secret for FreeIPA instanc
    -

    Description

    +

    Description

    Rotate FreeIPA related secrets for FreeIPA instances.

    -

    Parameters

    +

    Parameters

    @@ -6585,7 +6680,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6634,13 +6729,13 @@

    Rotate SaltStack user password on FreeIPA instances
    -

    Description

    +

    Description

    Rotate SaltStack user password on FreeIPA instances.

    -

    Parameters

    +

    Parameters

    @@ -6671,7 +6766,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6720,13 +6815,13 @@

    Creates or updates the AWS audit credential for
    -

    Description

    +

    Description

    Creates or updates the AWS audit credential for the account. The response will only contain details appropriate to AWS.

    -

    Parameters

    +

    Parameters

    @@ -6757,7 +6852,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6806,13 +6901,13 @@

    Creates or updates the AWS GovCloud audi
    -

    Description

    +

    Description

    Creates or updates the AWS GovCloud audit credential for the account. The response will only contain details appropriate to AWS.

    -

    Parameters

    +

    Parameters

    @@ -6843,7 +6938,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6892,13 +6987,13 @@

    Set account level telemetry settings. (telemetry f
    -

    Description

    +

    Description

    Set account level telemetry settings. (telemetry features and anonymization rules)

    -

    Parameters

    +

    Parameters

    @@ -6929,7 +7024,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6978,13 +7073,13 @@

    Creates or updates the Azure audit credential
    -

    Description

    +

    Description

    Creates or updates the Azure audit credential for the account. The response will only contain details appropriate to Azure.

    -

    Parameters

    +

    Parameters

    @@ -7015,7 +7110,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7064,13 +7159,13 @@

    Sets a catalog for a FreeIPA installation.

    -

    Description

    +

    Description

    Sets a catalog for a FreeIPA installation.

    -

    Parameters

    +

    Parameters

    @@ -7101,7 +7196,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7150,13 +7245,13 @@

    Sets endpoint access gateway settings for the
    -

    Description

    +

    Description

    Sets endpoint access gateway settings for the environment.

    -

    Parameters

    +

    Parameters

    @@ -7187,7 +7282,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7236,13 +7331,13 @@

    Read a configuration setting from the environmen
    -

    Description

    +

    Description

    Read a configuration setting from the environment service.

    -

    Parameters

    +

    Parameters

    @@ -7273,7 +7368,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7322,13 +7417,13 @@

    Creates or updates the GCP audit credential for
    -

    Description

    +

    Description

    Creates or updates the GCP audit credential for the account. The response will only contain details appropriate to GCP.

    -

    Parameters

    +

    Parameters

    @@ -7359,7 +7454,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7408,13 +7503,13 @@

    Sets all ID Broker mappings for an environment.
    -

    Description

    +

    Description

    Sets all ID Broker mappings for an environment. Overwrites all existing mappings.

    -

    Parameters

    +

    Parameters

    @@ -7445,7 +7540,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7494,13 +7589,13 @@

    Sets workload user’s password and updates into all e
    -

    Description

    +

    Description

    Deprecated. Use 'iam set-workload-password' command instead.

    -

    Parameters

    +

    Parameters

    @@ -7531,7 +7626,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7580,13 +7675,13 @@

    Configure environment level telemetry feature set
    -

    Description

    +

    Description

    Configure environment level telemetry feature setting.

    -

    Parameters

    +

    Parameters

    @@ -7617,7 +7712,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7666,13 +7761,13 @@

    Start an environment.

    -

    Description

    +

    Description

    Start an environment.

    -

    Parameters

    +

    Parameters

    @@ -7703,7 +7798,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7752,13 +7847,13 @@

    Initiates the vertical scaling on FreeIPA.
    -

    Description

    +

    Description

    Initiates the vertical scaling on FreeIPA.

    -

    Parameters

    +

    Parameters

    @@ -7789,7 +7884,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7838,13 +7933,13 @@

    Stop an environment.

    -

    Description

    +

    Description

    Stop an environment.

    -

    Parameters

    +

    Parameters

    @@ -7875,7 +7970,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7924,13 +8019,13 @@

    Synchronizes environments with all users and groups state
    -

    Description

    +

    Description

    Synchronizes environments with all users and groups state with CDP.

    -

    Parameters

    +

    Parameters

    @@ -7961,7 +8056,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8010,13 +8105,13 @@

    Syncs all ID Broker mappings for an environment.<
    -

    Description

    +

    Description

    Syncs all ID Broker mappings to all datalake clusters in an environment.

    -

    Parameters

    +

    Parameters

    @@ -8047,7 +8142,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8096,13 +8191,13 @@

    Returns status of the sync operation for the operation id.<
    -

    Description

    +

    Description

    Returns status of the sync operation for the operation id. Operation Id should be one of the previously request sync operation.

    -

    Parameters

    +

    Parameters

    @@ -8133,7 +8228,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8182,13 +8277,13 @@

    Synchronizes environments with single user to the FreeIPA ser
    -

    Description

    +

    Description

    Synchronizes environments with single user to the FreeIPA servers.

    -

    Parameters

    +

    Parameters

    @@ -8219,7 +8314,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8268,13 +8363,13 @@

    Synchronizes all environments in the callin
    -

    Description

    +

    Description

    Invokes the automated user sync service to synchronize all environments in the calling account.

    -

    Parameters

    +

    Parameters

    @@ -8305,7 +8400,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8354,13 +8449,13 @@

    Test anonymization rules (for account teleme
    -

    Description

    +

    Description

    Test anonymization rules (for account telemetry) against text input.

    -

    Parameters

    +

    Parameters

    @@ -8391,7 +8486,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8440,13 +8535,13 @@

    Updates an AWS credential that can be attached to
    -

    Description

    +

    Description

    Updates an AWS credential.

    -

    Parameters

    +

    Parameters

    @@ -8477,7 +8572,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8526,13 +8621,13 @@

    Update the AWS encryption key ARN fo
    -

    Description

    +

    Description

    Updates the AWS encryption key ARN for the environment. Enables the server side encryption with CMK for newly created AWS resources for the existing environment.

    -

    Parameters

    +

    Parameters

    @@ -8563,7 +8658,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8612,13 +8707,13 @@

    Update the Availability Zones for the Azu
    -

    Description

    +

    Description

    Updates the Availability Zones for the Azure environment.

    -

    Parameters

    +

    Parameters

    @@ -8649,7 +8744,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8698,13 +8793,13 @@

    Updates a new certificate based Azure credential
    -

    Description

    +

    Description

    Updates a certificate based Azure credential.

    -

    Parameters

    +

    Parameters

    @@ -8735,7 +8830,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8784,13 +8879,13 @@

    Update the Azure database resources for t
    -

    Description

    +

    Description

    Updates the Azure database resources for the environment. Enables deploying private Flexible Server for the existing environment.

    -

    Parameters

    +

    Parameters

    @@ -8821,7 +8916,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8870,13 +8965,13 @@

    Update the Azure encryption resources f
    -

    Description

    +

    Description

    Updates the Azure encryption resources for the environment. Enables the SSE with CMK for newly created Azure resources for the existing environment.

    -

    Parameters

    +

    Parameters

    @@ -8907,7 +9002,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8956,13 +9051,13 @@

    Updates account level Azure Marketplace im
    -

    Description

    +

    Description

    Updates account level Azure Marketplace image policy. CDP is capable to automatically accept Azure Marketplace image terms during cluster deployment. You can use this setting in your account to opt in or opt out this behaviour.

    -

    Parameters

    +

    Parameters

    @@ -8993,7 +9088,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9042,13 +9137,13 @@

    Updates custom docker registry CRN of an en
    -

    Description

    +

    Description

    Updates custom docker registry CRN of an environment.

    -

    Parameters

    +

    Parameters

    @@ -9079,7 +9174,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9128,13 +9223,13 @@

    Updates Data Service resources of an enviro
    -

    Description

    +

    Description

    Updates Data Service resources of an environment.

    -

    Parameters

    +

    Parameters

    @@ -9165,7 +9260,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9214,13 +9309,13 @@

    Updates FreeIPA AWS cluster to use IMDSv1.
    -

    Description

    +

    Description

    Updates FreeIPA AWS cluster to use IMDSv1.

    -

    Parameters

    +

    Parameters

    @@ -9251,7 +9346,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9300,13 +9395,13 @@

    Updates FreeIPA AWS cluster to use IMDSv2.
    -

    Description

    +

    Description

    Updates FreeIPA AWS cluster to use IMDSv2.

    -

    Parameters

    +

    Parameters

    @@ -9337,7 +9432,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9386,13 +9481,13 @@

    Run orchestrator engine state update on the Fr
    -

    Description

    +

    Description

    Run orchestrator engine state update on the FreeIPA cluster.

    -

    Parameters

    +

    Parameters

    @@ -9423,7 +9518,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9472,13 +9567,13 @@

    Updates the proxy config of the given environment.
    -

    Description

    +

    Description

    Updates the proxy config of the given environment.

    -

    Parameters

    +

    Parameters

    @@ -9509,7 +9604,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9558,13 +9653,13 @@

    Updates the security access settings of the given
    -

    Description

    +

    Description

    Updates the security access settings of the given environment.

    -

    Parameters

    +

    Parameters

    @@ -9595,7 +9690,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9644,13 +9739,13 @@

    Updates the designated SSH key for the given environment.
    -

    Description

    +

    Description

    Updates the designated SSH key for the given environment.

    -

    Parameters

    +

    Parameters

    @@ -9681,7 +9776,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9730,13 +9825,13 @@

    Updates the subnet(s) of the given environment.

    -

    Description

    +

    Description

    Updates the subnet(s) of the given environment.

    -

    Parameters

    +

    Parameters

    @@ -9767,7 +9862,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9816,13 +9911,13 @@

    Upgrades Cluster Connectivity Manager on the environment to
    -

    Description

    +

    Description

    Upgrades Cluster Connectivity Manager on the environment to the latest available version.

    -

    Parameters

    +

    Parameters

    @@ -9853,7 +9948,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9902,13 +9997,13 @@

    Upgrades FreeIPA to the latest or defined image.

    -

    Description

    +

    Description

    FreeIPA is an integrated Identity and Authentication solution that can be used for any of CM, CDP services.

    -

    Parameters

    +

    Parameters

    @@ -9939,7 +10034,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9988,13 +10083,13 @@

    Upscales FreeIPA instances.

    -

    Description

    +

    Description

    FreeIPA is an integrated Identity and Authentication solution that can be used for any of CM, CDP services.

    -

    Parameters

    +

    Parameters

    @@ -10025,7 +10120,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -10074,13 +10169,13 @@

    Validates AWS cloud storage settings of the gi
    -

    Description

    +

    Description

    Validates AWS cloud storage settings of the given environment.

    -

    Parameters

    +

    Parameters

    @@ -10111,7 +10206,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -10160,13 +10255,13 @@

    Validates Azure cloud storage settings of th
    -

    Description

    +

    Description

    Validates Azure cloud storage settings of the given environment.

    -

    Parameters

    +

    Parameters

    @@ -10197,7 +10292,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -13202,7 +13297,7 @@

    CreateAWSEnvironmentRequest

    optional

    -

    The name for the DynamoDB table backing S3Guard.

    +

    Deprecated. S3Guard was used to ensure consistent S3 updates when S3 was still eventually consistent. With the introduction of Consistent S3, the goal and usage of S3 Guard have become superfluous and defunct.

    string

    @@ -13639,7 +13734,7 @@

    CreateAWSGovCloudEnvironmentReques optional

    -

    The name for the DynamoDB table backing S3Guard.

    +

    Deprecated. S3Guard was used to ensure consistent S3 updates when S3 was still eventually consistent. With the introduction of Consistent S3, the goal and usage of S3 Guard have become superfluous and defunct.

    string

    @@ -16484,7 +16579,7 @@

    Environment

    optional

    -

    The name for the DynamoDB table backing S3Guard.

    +

    Deprecated. S3Guard was used to ensure consistent S3 updates when S3 was still eventually consistent. With the introduction of Consistent S3, the goal and usage of S3 Guard have become superfluous and defunct.

    string

    @@ -20020,9 +20115,34 @@

    InitializeAWSComputeClusterRespons

    Response object for an initialize AWS default compute cluster request.

    -
    -

    Type : object

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

    operationId
    +optional

    +
    +

    The id of the related operation.

    +
    +

    string

    +

    InitializeAzureComputeClusterRequest

    @@ -20075,9 +20195,34 @@

    InitializeAzureComputeClusterRes

    Response object for an initialize Azure default compute cluster request.

    -
    -

    Type : object

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

    operationId
    +optional

    +
    +

    The id of the related operation.

    +
    +

    string

    +

    InstanceTemplate

    @@ -20196,6 +20341,158 @@

    LastAutomatedSyncDetails

    +

    LastSyncStatusRequest

    +
    +

    Request object for Sync Status.

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

    envNameOrCrn
    +required

    +
    +

    Name or Crn of the environment.

    +
    +

    string

    +
    +
    +
    +

    LastSyncStatusResponse

    +
    +

    Response object for Sync Operation.

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

    endDate
    +optional

    +
    +

    Date when the sync operation ended. Omitted if operation has not ended.

    +
    +

    string (date-time)

    +
    +

    error
    +optional

    +
    +

    If there is any error associated. The error will be populated on any error and it may be populated when the operation failure details are empty.

    +
    +

    string

    +
    +

    failure
    +optional

    +
    +

    List of sync operation details for all failed environments.

    +
    +

    < SyncOperationDetails > array

    +
    +

    operationId
    +required

    +
    +

    UUID of the request for this operation. This Id can be used for geting status on the operation.

    +
    +

    string

    +
    +

    operationType
    +optional

    +
    +

    Operation type, set password or user sync

    +
    +

    startDate
    +optional

    +
    +

    Date when the sync operation started.

    +
    +

    string (date-time)

    +
    +

    status
    +optional

    +
    +

    Status of this operation. Status can be one of these values (REQUESTED, RUNNING, COMPLETED, FAILED, REJECTED, TIMEDOUT)

    +
    +

    success
    +optional

    +
    +

    List of sync operation details for all succeeded environments.

    +
    +

    < SyncOperationDetails > array

    +
    +
    +

    ListAuditCredentialsRequest

    Request object for a list audit credentials request.

    @@ -25987,7 +26284,7 @@

    ValidateAzureCloudStorageResponse
    diff --git a/api-docs-beta/iam/index.html b/api-docs-beta/iam/index.html index 96e78f867..9dcd1d07c 100644 --- a/api-docs-beta/iam/index.html +++ b/api-docs-beta/iam/index.html @@ -1435,7 +1435,7 @@

    Overview

    Version information

    -

    Version : 0.9.125 (BETA)

    +

    Version : 0.9.126 (BETA)

    @@ -15812,7 +15812,7 @@

    WorkloadPasswordPolicy


    diff --git a/api-docs-beta/imagecatalog/index.html b/api-docs-beta/imagecatalog/index.html index b073f14ab..ff7d9c3c1 100644 --- a/api-docs-beta/imagecatalog/index.html +++ b/api-docs-beta/imagecatalog/index.html @@ -853,7 +853,7 @@

    Overview

    Version information

    -

    Version : 0.9.125 (BETA)

    +

    Version : 0.9.126 (BETA)

    @@ -3915,7 +3915,7 @@

    VmImageType


    diff --git a/api-docs-beta/metrics/index.html b/api-docs-beta/metrics/index.html index 36672302c..372bc018d 100644 --- a/api-docs-beta/metrics/index.html +++ b/api-docs-beta/metrics/index.html @@ -775,7 +775,7 @@

    Overview

    Version information

    -

    Version : 0.9.125 (BETA)

    +

    Version : 0.9.126 (BETA)

    @@ -2755,7 +2755,7 @@

    UpdateRemoteWriteConfigResponse


    diff --git a/api-docs-beta/ml/index.html b/api-docs-beta/ml/index.html index 383c1159c..0f8acd435 100644 --- a/api-docs-beta/ml/index.html +++ b/api-docs-beta/ml/index.html @@ -1182,7 +1182,7 @@

    Overview

    Version information

    -

    Version : 0.9.125 (BETA)

    +

    Version : 0.9.126 (BETA)

    @@ -12602,7 +12602,7 @@

    WorkspaceSummary


    diff --git a/api-docs-beta/opdb/index.html b/api-docs-beta/opdb/index.html index db1e0e23e..d97e36def 100644 --- a/api-docs-beta/opdb/index.html +++ b/api-docs-beta/opdb/index.html @@ -1012,7 +1012,7 @@

    Overview

    Version information

    -

    Version : 0.9.125 (BETA)

    +

    Version : 0.9.126 (BETA)

    @@ -9868,7 +9868,7 @@

    VolumeType


    diff --git a/api-docs-beta/replicationmanager/index.html b/api-docs-beta/replicationmanager/index.html index 2046d5296..1f3082869 100644 --- a/api-docs-beta/replicationmanager/index.html +++ b/api-docs-beta/replicationmanager/index.html @@ -732,279 +732,335 @@

    Cloudera Replication Manager Service

  • Responses
  • -
  • Create an ABFS Cloud Credential. +
  • Create an ABFS Access Key based account in DLM Engine.
  • -
  • Create an AWS Cloud Credential. +
  • Create an Azure Active Directory Service Principal account in Cloudera Manager.
  • -
  • Create a GCS Cloud Credential. +
  • Create an ABFS Cloud Credential.
  • -
  • Create an HBase Replication Policy. +
  • Create an AWS Access Key cloud credential.
  • -
  • Create a Replication Policy. +
  • Create an AWS Cloud Credential.
  • -
  • Create snapshot policy. +
  • Create an AWS IAM Role based cloud credential.
  • -
  • Delete Cloud Credential. +
  • Create an AWS IDBroker cloud credential.
  • -
  • Delete an HBase Replication Policy. +
  • Create a GCS Private Key cloud credential.
  • -
  • Delete Replication Policy. +
  • Create an HBase Replication Policy.
  • -
  • Delete snapshot policy. +
  • Create a Replication Policy.
  • -
  • Download diagnostic bundle for a policy. +
  • Create snapshot policy.
  • -
  • Get configuration of a cluster. +
  • Delete Cloud Credential.
  • -
  • Get the status of the given CM command. +
  • Delete an HBase Replication Policy.
  • -
  • Get Cloud Credentials from a Cluster. +
  • Delete Replication Policy.
  • -
  • Retrieve time series data for an HBase replication peer. +
  • Delete snapshot policy.
  • -
  • Get Snapshot Policy. +
  • Download diagnostic bundle for a policy.
  • -
  • Lists Cloud Credentials. +
  • Get configuration of a cluster.
  • -
  • Lists Cluster Service Statuses. +
  • Get the status of the given CM command.
  • -
  • Lists all clusters. +
  • Get Cloud Credentials from a Cluster.
  • -
  • List cluster CRNs which have an active HBase policy. +
  • Retrieve time series data for an HBase replication peer.
  • -
  • Get All Replication Policies. +
  • Get Snapshot Policy.
  • -
  • List policy jobs. +
  • Lists Cloud Credentials.
  • -
  • Get All Snapshot Policies. +
  • Lists Cluster Service Statuses.
  • -
  • List snapshot policy jobs. +
  • Lists all clusters.
  • -
  • Repair a failed HBase policy. +
  • List cluster CRNs which have an active HBase policy.
  • -
  • Rerun policy job. +
  • Get All Replication Policies.
  • -
  • Restore snapshot. +
  • List policy jobs.
  • -
  • Retry failed first time setup for an HBase policy. +
  • Get All Snapshot Policies.
  • -
  • Retry failed snapshots for an HBase policy. +
  • List snapshot policy jobs.
  • -
  • Suspend an HBase replication policy. +
  • Repair a failed HBase policy.
  • -
  • Stop all replication tasks defined by the policy. +
  • Rerun policy job.
  • -
  • Suspend snapshot policy. +
  • Restore snapshot.
  • -
  • Update an ABFS Cloud Credential. +
  • Retry failed first time setup for an HBase policy.
  • -
  • Update an AWS Cloud Credential. +
  • Retry failed snapshots for an HBase policy.
  • -
  • Update a GCS Cloud Credential. +
  • Suspend an HBase replication policy.
  • -
  • Update an HBase Replication Policy. +
  • Stop all replication tasks defined by the policy.
  • -
  • Update a Replication Policy. +
  • Suspend snapshot policy.
  • -
  • Update snapshot policy. +
  • Update an ABFS Access Key based account in DLM Engine.
  • -
  • Verify a source-destination cluster pair for HBase policy creation. +
  • Update an Azure Active Directory Service Principal account in Cloudera Manager.
  • +
  • Update an AWS Access Key cloud credential. + +
  • +
  • Update an AWS IAM Role based cloud credential. + +
  • +
  • Update an AWS IDBroker cloud credential. + +
  • +
  • Update a GCS Private Key cloud credential. + +
  • +
  • Update an HBase Replication Policy. + +
  • +
  • Update a Replication Policy. + +
  • +
  • Update snapshot policy. + +
  • +
  • Verify a source-destination cluster pair for HBase policy creation. + +
  • Definitions @@ -1024,17 +1080,28 @@

    Cloudera Replication Manager Service

  • Cluster
  • ClusterServiceStatuses
  • CmPolicySubmitUser
  • +
  • CmPolicySubmitUserResponse
  • CodProperties
  • CollectDiagnosticBundleRequest
  • CollectDiagnosticBundleResponse
  • ContinueHbaseSetupRequest
  • ContinueHbaseSetupResponse
  • +
  • CreateAbfsAccessKeyCredentialRequest
  • +
  • CreateAbfsAccessKeyCredentialResponse
  • +
  • CreateAbfsClientKeyCredentialRequest
  • +
  • CreateAbfsClientKeyCredentialResponse
  • CreateAbfsCredentialRequest
  • CreateAbfsCredentialResponse
  • +
  • CreateAwsAccessKeyCredentialRequest
  • +
  • CreateAwsAccessKeyCredentialResponse
  • CreateAwsCredentialRequest
  • CreateAwsCredentialResponse
  • -
  • CreateGcsCredentialRequest
  • -
  • CreateGcsCredentialResponse
  • +
  • CreateAwsIamCredentialRequest
  • +
  • CreateAwsIamCredentialResponse
  • +
  • CreateAwsIdbrokerCredentialRequest
  • +
  • CreateAwsIdbrokerCredentialResponse
  • +
  • CreateGcsPrivateKeyCredentialRequest
  • +
  • CreateGcsPrivateKeyCredentialResponse
  • CreateHbasePolicyRequest
  • CreateHbasePolicyResponse
  • CreatePolicyRequest
  • @@ -1057,7 +1124,6 @@

    Cloudera Replication Manager Service

  • DownloadDiagnosticBundleResponse
  • Error
  • ErrorHandling
  • -
  • GcsCloudCredentialType
  • GetClusterConfigRequest
  • GetClusterConfigResponse
  • GetCommandStatusRequest
  • @@ -1150,12 +1216,18 @@

    Cloudera Replication Manager Service

  • SuspendSnapshotPolicyRequest
  • SuspendSnapshotPolicyResponse
  • TargetDetails
  • -
  • UpdateAbfsCredentialRequest
  • -
  • UpdateAbfsCredentialResponse
  • -
  • UpdateAwsCredentialRequest
  • -
  • UpdateAwsCredentialResponse
  • -
  • UpdateGcsCredentialRequest
  • -
  • UpdateGcsCredentialResponse
  • +
  • UpdateAbfsAccessKeyCredentialRequest
  • +
  • UpdateAbfsAccessKeyCredentialResponse
  • +
  • UpdateAbfsClientKeyCredentialRequest
  • +
  • UpdateAbfsClientKeyCredentialResponse
  • +
  • UpdateAwsAccessKeyCredentialRequest
  • +
  • UpdateAwsAccessKeyCredentialResponse
  • +
  • UpdateAwsIamCredentialRequest
  • +
  • UpdateAwsIamCredentialResponse
  • +
  • UpdateAwsIdbrokerCredentialRequest
  • +
  • UpdateAwsIdbrokerCredentialResponse
  • +
  • UpdateGcsPrivateKeyCredentialRequest
  • +
  • UpdateGcsPrivateKeyCredentialResponse
  • UpdateHbasePolicyDefinition
  • UpdateHbasePolicyRequest
  • UpdateHbasePolicyResponse
  • @@ -1182,7 +1254,7 @@

    Overview

    Version information

    -

    Version : 0.9.125 (BETA)

    +

    Version : 0.9.126 (BETA)

    @@ -1740,16 +1812,16 @@

    Responses

    -

    Create an ABFS Cloud Credential.

    +

    Create an ABFS Access Key based account in DLM Engine.

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

    Description

    -

    Creates a new ABFS cloud credential.

    +

    Creates a new ABFS Access Key based account in DLM Engine.

    @@ -1777,7 +1849,7 @@

    Parameters

    required

    @@ -1807,7 +1879,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -1826,16 +1898,16 @@

    Responses

    -

    Create an AWS Cloud Credential.

    +

    Create an Azure Active Directory Service Principal account in Cloudera Manager.

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

    Description

    -

    Creates a new AWS cloud credential.

    +

    Creates a new Azure Active Directory Service Principal account in Cloudera Manager.

    @@ -1863,7 +1935,7 @@

    Parameters

    required

    @@ -1893,7 +1965,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -1912,16 +1984,16 @@

    Responses

    -

    Create a GCS Cloud Credential.

    +

    Create an ABFS Cloud Credential.

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

    Description

    -

    Creates a new GCS cloud credential.

    +

    Creates a new ABFS cloud credential.

    @@ -1949,7 +2021,7 @@

    Parameters

    required

    @@ -1979,7 +2051,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -1998,16 +2070,16 @@

    Responses

    -

    Create an HBase Replication Policy.

    +

    Create an AWS Access Key cloud credential.

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

    Description

    -

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

    +

    Creates a new AWS Access Key cloud credential.

    @@ -2035,7 +2107,7 @@

    Parameters

    required

    @@ -2065,7 +2137,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -2084,16 +2156,16 @@

    Responses

    -

    Create a Replication Policy.

    +

    Create an AWS Cloud Credential.

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

    Description

    -

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

    +

    Creates a new AWS cloud credential.

    @@ -2121,7 +2193,7 @@

    Parameters

    required

    @@ -2151,7 +2223,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -2170,16 +2242,16 @@

    Responses

    -

    Create snapshot policy.

    +

    Create an AWS IAM Role based cloud credential.

    -
    POST /api/v1/replicationmanager/createSnapshotPolicy
    +
    POST /api/v1/replicationmanager/createAwsIamCredential

    Description

    -

    Creates a snapshot policy.

    +

    Creates a new AWS IAM Role based cloud credential.

    @@ -2207,7 +2279,7 @@

    Parameters

    required

    @@ -2237,7 +2309,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -2256,16 +2328,16 @@

    Responses

    -

    Delete Cloud Credential.

    +

    Create an AWS IDBroker cloud credential.

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

    Description

    -

    Permanently deletes a specific cloud credential.

    +

    Creates a new AWS IDBroker cloud credential.

    @@ -2293,7 +2365,7 @@

    Parameters

    required

    @@ -2323,7 +2395,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -2342,16 +2414,16 @@

    Responses

    -

    Delete an HBase Replication Policy.

    +

    Create a GCS Private Key cloud credential.

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

    Description

    -

    Permanently deletes a specific HBase replication policy.

    +

    Creates a new GCS Private Key cloud credential.

    @@ -2379,7 +2451,7 @@

    Parameters

    required

    @@ -2409,7 +2481,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -2428,16 +2500,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.

    @@ -2465,7 +2537,7 @@

    Parameters

    required

    @@ -2495,7 +2567,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -2514,16 +2586,16 @@

    Responses

    -

    Delete snapshot policy.

    +

    Create a Replication Policy.

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

    Description

    -

    Permanently deletes a specific snapshot policy.

    +

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

    @@ -2551,7 +2623,7 @@

    Parameters

    required

    @@ -2581,7 +2653,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -2600,16 +2672,16 @@

    Responses

    -

    Download diagnostic bundle for a policy.

    +

    Create snapshot policy.

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

    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 snapshot policy.

    @@ -2637,7 +2709,7 @@

    Parameters

    required

    @@ -2667,7 +2739,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -2686,16 +2758,16 @@

    Responses

    -

    Get configuration of a cluster.

    +

    Delete Cloud Credential.

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

    Description

    -

    Retrieves configuration of a specific cluster.

    +

    Permanently deletes a specific cloud credential.

    @@ -2723,7 +2795,7 @@

    Parameters

    required

    @@ -2753,7 +2825,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -2772,16 +2844,16 @@

    Responses

    -

    Get the status of the given CM command.

    +

    Delete an HBase Replication Policy.

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

    Description

    -

    Return the current status of the given CM command.

    +

    Permanently deletes a specific HBase replication policy.

    @@ -2809,7 +2881,7 @@

    Parameters

    required

    @@ -2839,7 +2911,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -2858,16 +2930,16 @@

    Responses

    -

    Get Cloud Credentials from a Cluster.

    +

    Delete Replication Policy.

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

    Description

    -

    Returns cloud credentials on a specific cluster.

    +

    Permanently deletes a specific replication policy.

    @@ -2895,7 +2967,7 @@

    Parameters

    required

    @@ -2925,7 +2997,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -2944,16 +3016,16 @@

    Responses

    -

    Retrieve time series data for an HBase replication peer.

    +

    Delete snapshot policy.

    -
    POST /api/v1/replicationmanager/getHbaseTimeSeries
    +
    POST /api/v1/replicationmanager/deleteSnapshotPolicy

    Description

    -

    Returns time series data for an HBase replication peer based on the provided parameters.

    +

    Permanently deletes a specific snapshot policy.

    @@ -2981,7 +3053,7 @@

    Parameters

    required

    @@ -3011,7 +3083,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -3030,16 +3102,16 @@

    Responses

    -

    Get Snapshot Policy.

    +

    Download diagnostic bundle for a policy.

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

    Description

    -

    Retrieves a specific snapshot policy from the cluster specified in the request.

    +

    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.

    @@ -3067,7 +3139,7 @@

    Parameters

    required

    @@ -3097,7 +3169,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -3116,16 +3188,16 @@

    Responses

    -

    Lists Cloud Credentials.

    +

    Get configuration of a cluster.

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

    Description

    -

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

    +

    Retrieves configuration of a specific cluster.

    @@ -3153,7 +3225,7 @@

    Parameters

    required

    @@ -3183,7 +3255,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -3202,16 +3274,16 @@

    Responses

    -

    Lists Cluster Service Statuses.

    +

    Get the status of the given CM command.

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

    Description

    -

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

    +

    Return the current status of the given CM command.

    @@ -3239,7 +3311,7 @@

    Parameters

    required

    @@ -3269,7 +3341,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -3288,16 +3360,16 @@

    Responses

    -

    Lists all clusters.

    +

    Get Cloud Credentials from a Cluster.

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

    Description

    -

    Provides a detailed list of all available clusters.

    +

    Returns cloud credentials on a specific cluster.

    @@ -3325,7 +3397,7 @@

    Parameters

    required

    @@ -3355,7 +3427,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -3374,16 +3446,16 @@

    Responses

    -

    List cluster CRNs which have an active HBase policy.

    +

    Retrieve time series data for an HBase replication peer.

    -
    POST /api/v1/replicationmanager/listPairedHbaseClusters
    +
    POST /api/v1/replicationmanager/getHbaseTimeSeries

    Description

    -

    Provides a list of cluster CRNs with active HBase policies.

    +

    Returns time series data for an HBase replication peer based on the provided parameters.

    @@ -3411,7 +3483,7 @@

    Parameters

    required

    @@ -3441,7 +3513,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -3460,16 +3532,16 @@

    Responses

    -

    Get All Replication Policies.

    +

    Get Snapshot Policy.

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

    Description

    -

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

    +

    Retrieves a specific snapshot policy from the cluster specified in the request.

    @@ -3497,7 +3569,7 @@

    Parameters

    required

    @@ -3527,7 +3599,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -3546,16 +3618,16 @@

    Responses

    -

    List policy jobs.

    +

    Lists Cloud Credentials.

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

    Description

    -

    Returns a list of jobs triggered by a replication policy.

    +

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

    @@ -3583,7 +3655,7 @@

    Parameters

    required

    @@ -3613,7 +3685,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -3632,16 +3704,16 @@

    Responses

    -

    Get All Snapshot Policies.

    +

    Lists Cluster Service Statuses.

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

    Description

    -

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

    +

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

    @@ -3669,7 +3741,7 @@

    Parameters

    required

    @@ -3699,7 +3771,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -3718,16 +3790,16 @@

    Responses

    -

    List snapshot policy jobs.

    +

    Lists all clusters.

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

    Description

    -

    Lists jobs triggered by a snapshot policy.

    +

    Provides a detailed list of all available clusters.

    @@ -3755,7 +3827,7 @@

    Parameters

    required

    @@ -3785,7 +3857,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -3804,16 +3876,16 @@

    Responses

    -

    Repair a failed HBase policy.

    +

    List cluster CRNs which have an active HBase policy.

    -
    POST /api/v1/replicationmanager/repairHbasePolicy
    +
    POST /api/v1/replicationmanager/listPairedHbaseClusters

    Description

    -

    Attempts to repair an HBase policy in failed update state by resending the last update.

    +

    Provides a list of cluster CRNs with active HBase policies.

    @@ -3841,7 +3913,7 @@

    Parameters

    required

    @@ -3871,7 +3943,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -3890,16 +3962,16 @@

    Responses

    -

    Rerun policy job.

    +

    Get All Replication Policies.

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

    Description

    -

    Instantly starts a new job of a provided policy.

    +

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

    @@ -3927,7 +3999,7 @@

    Parameters

    required

    @@ -3957,7 +4029,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -3976,16 +4048,16 @@

    Responses

    -

    Restore snapshot.

    +

    List policy jobs.

    -
    POST /api/v1/replicationmanager/restoreSnapshot
    +
    POST /api/v1/replicationmanager/listPolicyJobs

    Description

    -

    Restores a specific snapshot.

    +

    Returns a list of jobs triggered by a replication policy.

    @@ -4013,7 +4085,7 @@

    Parameters

    required

    @@ -4043,7 +4115,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -4062,16 +4134,16 @@

    Responses

    -

    Retry failed first time setup for an HBase policy.

    +

    Get All Snapshot Policies.

    -
    POST /api/v1/replicationmanager/retryFailedHbaseFirstTimeSetup
    +
    POST /api/v1/replicationmanager/listSnapshotPolicies

    Description

    -

    Runs the first time setup configuration between the source and destination clusters if the first time setup has failed for the given policy.

    +

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

    @@ -4099,7 +4171,7 @@

    Parameters

    required

    @@ -4129,7 +4201,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -4148,16 +4220,16 @@

    Responses

    -

    Retry failed snapshots for an HBase policy.

    +

    List snapshot policy jobs.

    -
    POST /api/v1/replicationmanager/retryFailedHbaseSnapshots
    +
    POST /api/v1/replicationmanager/listSnapshotPolicyJobs

    Description

    -

    Reruns the failed initial snapshots (and only the failed ones) in the replication policy if it has failed to replicate the existing data of some or all tables.

    +

    Lists jobs triggered by a snapshot policy.

    @@ -4185,7 +4257,7 @@

    Parameters

    required

    @@ -4215,7 +4287,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -4234,16 +4306,16 @@

    Responses

    -

    Suspend an HBase replication policy.

    +

    Repair a failed HBase policy.

    -
    POST /api/v1/replicationmanager/suspendHbasePolicy
    +
    POST /api/v1/replicationmanager/repairHbasePolicy

    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.

    +

    Attempts to repair an HBase policy in failed update state by resending the last update.

    @@ -4271,7 +4343,7 @@

    Parameters

    required

    @@ -4301,7 +4373,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -4320,16 +4392,16 @@

    Responses

    -

    Stop all replication tasks defined by the policy.

    +

    Rerun policy job.

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

    Description

    -

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

    +

    Instantly starts a new job of a provided policy.

    @@ -4357,7 +4429,7 @@

    Parameters

    required

    @@ -4387,7 +4459,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -4406,16 +4478,16 @@

    Responses

    -

    Suspend snapshot policy.

    +

    Restore snapshot.

    -
    POST /api/v1/replicationmanager/suspendSnapshotPolicy
    +
    POST /api/v1/replicationmanager/restoreSnapshot

    Description

    -

    Suspends a specific snapshot policy.

    +

    Restores a specific snapshot.

    @@ -4443,7 +4515,7 @@

    Parameters

    required

    @@ -4473,7 +4545,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -4492,16 +4564,16 @@

    Responses

    -

    Update an ABFS Cloud Credential.

    +

    Retry failed first time setup for an HBase policy.

    -
    POST /api/v1/replicationmanager/updateAbfsCredential
    +
    POST /api/v1/replicationmanager/retryFailedHbaseFirstTimeSetup

    Description

    -

    Updates an existing ABFS cloud credential.

    +

    Runs the first time setup configuration between the source and destination clusters if the first time setup has failed for the given policy.

    @@ -4529,7 +4601,7 @@

    Parameters

    required

    @@ -4559,7 +4631,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -4578,16 +4650,16 @@

    Responses

    -

    Update an AWS Cloud Credential.

    +

    Retry failed snapshots for an HBase policy.

    -
    POST /api/v1/replicationmanager/updateAwsCredential
    +
    POST /api/v1/replicationmanager/retryFailedHbaseSnapshots

    Description

    -

    Updates an existing AWS cloud credential.

    +

    Reruns the failed initial snapshots (and only the failed ones) in the replication policy if it has failed to replicate the existing data of some or all tables.

    @@ -4615,7 +4687,7 @@

    Parameters

    required

    @@ -4645,7 +4717,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -4664,16 +4736,16 @@

    Responses

    -

    Update a GCS Cloud Credential.

    +

    Suspend an HBase replication policy.

    -
    POST /api/v1/replicationmanager/updateGcsCredential
    +
    POST /api/v1/replicationmanager/suspendHbasePolicy

    Description

    -

    Updates an existing GCS cloud credential.

    +

    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.

    @@ -4701,7 +4773,7 @@

    Parameters

    required

    @@ -4731,7 +4803,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -4750,16 +4822,16 @@

    Responses

    -

    Update an HBase Replication Policy.

    +

    Stop all replication tasks defined by the policy.

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

    Description

    -

    Updates an existing HBase replication policy with the given parameters on a specific cluster.

    +

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

    @@ -4787,7 +4859,7 @@

    Parameters

    required

    @@ -4817,7 +4889,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -4836,16 +4908,16 @@

    Responses

    -

    Update a Replication Policy.

    +

    Suspend snapshot policy.

    -
    POST /api/v1/replicationmanager/updatePolicy
    +
    POST /api/v1/replicationmanager/suspendSnapshotPolicy

    Description

    -

    Updates an existing replication policy with the given parameters on a specific cluster.

    +

    Suspends a specific snapshot policy.

    @@ -4873,7 +4945,7 @@

    Parameters

    required

    @@ -4903,7 +4975,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -4922,16 +4994,16 @@

    Responses

    -

    Update snapshot policy.

    +

    Update an ABFS Access Key based account in DLM Engine.

    -
    POST /api/v1/replicationmanager/updateSnapshotPolicy
    +
    POST /api/v1/replicationmanager/updateAbfsAccessKeyCredential

    Description

    -

    Updates a snapshot policy.

    +

    Updates an existing ABFS Access Key based account in DLM Engine.

    @@ -4959,7 +5031,7 @@

    Parameters

    required

    @@ -4989,7 +5061,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -5008,16 +5080,16 @@

    Responses

    -

    Verify a source-destination cluster pair for HBase policy creation.

    +

    Update an Azure Active Directory Service Principal account in Cloudera Manager.

    -
    POST /api/v1/replicationmanager/verifyHbaseClusterPair
    +
    POST /api/v1/replicationmanager/updateAbfsClientKeyCredential

    Description

    -

    Returns whether the cluster pair is ready for policy creation, or if there are some manual steps that need to be performed before.

    +

    Updates an existing Azure Active Directory Service Principal account in Cloudera Manager.

    @@ -5045,7 +5117,7 @@

    Parameters

    required

    @@ -5075,7 +5147,7 @@

    Responses

    Describes a successful response to a valid request.

    @@ -5093,80 +5165,61 @@

    Responses

    - - -
    -

    Definitions

    -
    -

    AbfsCloudCredentialType

    -
    -

    ABFS cloud credential type.

    -
    -
    -

    Type : enum (ACCESSKEY, CLIENTKEY)

    +

    Update an AWS Access Key cloud credential.

    +
    +
    +
    POST /api/v1/replicationmanager/updateAwsAccessKeyCredential
    -
    -

    AbortPolicyRequest

    +
    +

    Description

    -

    Request object for abortPolicy.

    +

    Updates an existing AWS Access Key cloud credential.

    +
    +
    +

    Parameters

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

    clusterCrn
    -required

    -
    -

    The CRN of the cluster where the replication policy is.

    -
    -

    string

    +

    Body

    -

    policyId
    +

    input
    required

    -

    The ID of the policy.

    -
    -
    -

    AbortPolicyResponse

    -
    -

    Response object for abortPolicy.

    -
    +
    +

    Responses

    ---+++ - + @@ -5174,127 +5227,1453 @@

    AbortPolicyResponse

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

    clusterCrn
    -optional

    -
    -

    The CRN of the input cluster.

    -
    -

    string

    -
    -

    message
    -optional

    +

    200

    -

    The detailed description of the action taken.

    +

    Describes a successful response to a valid request.

    -

    requestId
    -optional

    +

    default

    -

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

    +

    The default response on an error.

    -

    string

    +

    Error

    -

    status
    -optional

    -
    +
    +
    +
    +

    Update an AWS IAM Role based cloud credential.

    +
    +
    +
    POST /api/v1/replicationmanager/updateAwsIamCredential
    +
    +
    +
    +

    Description

    +
    +

    Updates an existing AWS IAM Role based cloud credential.

    +
    +
    +
    +

    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 AWS IDBroker cloud credential.

    +
    +
    +
    POST /api/v1/replicationmanager/updateAwsIdbrokerCredential
    +
    +
    +
    +

    Description

    +
    +

    Updates an existing AWS IDBroker cloud credential.

    +
    +
    +
    +

    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 a GCS Private Key cloud credential.

    +
    +
    +
    POST /api/v1/replicationmanager/updateGcsPrivateKeyCredential
    +
    +
    +
    +

    Description

    +
    +

    Updates an existing GCS Private Key cloud credential.

    +
    +
    +
    +

    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

    +
    +
    +
    +
    +

    Update a Replication Policy.

    +
    +
    +
    POST /api/v1/replicationmanager/updatePolicy
    +
    +
    +
    +

    Description

    +
    +

    Updates an existing 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

    +
    +
    +
    +
    +

    Update snapshot policy.

    +
    +
    +
    POST /api/v1/replicationmanager/updateSnapshotPolicy
    +
    +
    +
    +

    Description

    +
    +

    Updates a snapshot 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

    +
    +
    +
    +
    +

    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)

    +
    +
    +
    +

    AbortPolicyRequest

    +
    +

    Request object for abortPolicy.

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

    clusterCrn
    +required

    +
    +

    The CRN of the cluster where the replication policy is.

    +
    +

    string

    +
    +

    policyId
    +required

    +
    +

    The ID of the policy.

    +
    +

    string

    +
    +
    +
    +

    AbortPolicyResponse

    +
    +

    Response object for abortPolicy.

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

    clusterCrn
    +optional

    +
    +

    The CRN of the input cluster.

    +
    +

    string

    +
    +

    message
    +optional

    +
    +

    The detailed description of the action taken.

    +
    +

    string

    +
    +

    requestId
    +optional

    +
    +

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

    +
    +

    string

    +
    +

    status
    +optional

    +
    +

    The status of the request.

    +
    +

    string

    +
    +
    +
    +

    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.

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

    clusterCrn
    +optional

    +
    +

    The CRN of the input cluster.

    +
    +

    string

    +
    +

    message
    +optional

    +
    +

    The detailed description of the action taken.

    +
    +

    string

    +
    +

    requestId
    +optional

    +
    +

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

    +
    +

    string

    +
    +

    status
    +optional

    +
    +

    The status of the request.

    +
    +

    string

    +
    +
    +
    +

    ActivateSnapshotPolicyRequest

    +
    +

    Request object for activateSnapshotPolicy.

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

    clusterCrn
    +required

    +
    +

    CRN of the cluster where the snapshot policy is.

    +
    +

    string

    +
    +

    name
    +required

    +
    +

    The name of the snapshot policy to be resumed.

    +
    +

    string

    +
    +
    +
    +

    ActivateSnapshotPolicyResponse

    +
    +

    Response object for activateSnapshotPolicy.

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

    clusterCrn
    +optional

    +
    +

    CRN of the cluster where the snapshot policy is.

    +
    +

    string

    +
    +

    message
    +optional

    +
    +

    The detailed description of the action taken.

    +
    +

    string

    +
    +

    status
    +optional

    +
    +

    The status of the request.

    +
    +

    string

    +
    +
    +
    +

    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.

    +
    +

    string

    +
    +

    dataCenter
    +required

    +
    +

    Cluster data center.

    +
    +

    string

    +
    +

    description
    +optional

    +
    +

    Cluster description.

    +
    +

    string

    +
    +

    environmentCrn
    +optional

    +
    -

    The status of the request.

    +

    CRN of the cluster’s environment.

    string

    -
    -
    -

    ActivateHbasePolicyRequest

    -
    -

    Activate an HBase replication policy.

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

    knoxUrl
    +optional

    +
    +

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

    +
    +

    string

    +
    -

    clusterCrn
    -required

    +

    location
    +optional

    -

    CRN of the destination cluster.

    +

    Cluster location.

    -

    string

    +

    Location

    -

    policyId
    +

    name
    required

    -

    ID of the HBase policy.

    +

    Cluster name.

    string

    -
    -
    -

    ActivateHbasePolicyResponse

    -
    -

    Response object for activateHbasePolicy.

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

    replicationEngineType
    +required

    +
    +

    Replication engine type.

    +
    +

    enum (CM, DLM_ENGINE)

    +
    -

    clusterCrn
    +

    stackCrn
    optional

    -

    The CRN of the input cluster.

    +

    Stack CRN.

    string

    @@ -5302,11 +6681,11 @@

    ActivateHbasePolicyResponse

    -

    message
    +

    stackMajorVersion
    optional

    -

    The detailed description of the action taken.

    +

    Stack major version.

    string

    @@ -5314,57 +6693,35 @@

    ActivateHbasePolicyResponse

    -

    status
    +

    stackVersion
    optional

    -

    The status of the request.

    +

    Stack version.

    string

    -
    -
    -

    ActivatePolicyRequest

    -
    -

    Activate a replication policy.

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

    clusterCrn
    -required

    +

    totalHosts
    +optional

    -

    CRN of the cluster where the policy is.

    +

    Total hosts on the cluster.

    -

    string

    +

    integer (int32)

    -

    policyName
    -required

    +

    uuid
    +optional

    -

    Policy name to resume.

    +

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

    string

    @@ -5374,18 +6731,9 @@

    ActivatePolicyRequest

    -

    ActivatePolicyResponse

    -
    -

    Response object for resumePolicy.

    -
    -
    -

    Type : object

    -
    -
    -
    -

    ActivateSnapshotPolicyRequest

    +

    ClusterServiceStatuses

    -

    Request object for activateSnapshotPolicy.

    +

    Describes the status of services running on a cluster.

    @@ -5407,7 +6755,7 @@

    ActivateSnapshotPolicyRequest

    required

    -

    CRN of the cluster where the snapshot policy is.

    +

    Cluster CRN.

    string

    @@ -5415,23 +6763,23 @@

    ActivateSnapshotPolicyRequest

    -

    name
    +

    serviceStatuses
    required

    -

    The name of the snapshot policy to be resumed.

    +

    List of service statuses.

    -

    string

    +

    < ServiceInfo > array

    -

    ActivateSnapshotPolicyResponse

    +

    CmPolicySubmitUser

    -

    Response object for activateSnapshotPolicy.

    +

    CM Policy submit user.

    @@ -5449,23 +6797,11 @@

    ActivateSnapshotPolicyResponse

    - - - - -
    -

    clusterCrn
    -optional

    -
    -

    CRN of the cluster where the snapshot policy is.

    -
    -

    string

    -
    -

    message
    +

    sourceUser
    optional

    -

    The detailed description of the action taken.

    +

    Source user.

    string

    @@ -5473,11 +6809,11 @@

    ActivateSnapshotPolicyResponse

    -

    status
    +

    userName
    optional

    -

    The status of the request.

    +

    Username.

    string

    @@ -5487,9 +6823,9 @@

    ActivateSnapshotPolicyResponse

    -

    Alert

    +

    CmPolicySubmitUserResponse

    -

    Cloudera Manager alerting behavior.

    +

    The user that the replication policy uses to perform operations on the source or target cluster.

    @@ -5507,59 +6843,35 @@

    Alert

    - - - - - - - - - -
    -

    onAbort
    -required

    -
    -

    Alert on abort.

    -
    -

    boolean

    -
    -

    onFailure
    -required

    -
    -

    Alert on failure.

    -
    -

    boolean

    -
    -

    onStart
    -required

    +

    sourceUser
    +optional

    -

    Alert on start.

    +

    Source user.

    -

    boolean

    +

    string

    -

    onSuccess
    -required

    +

    userName
    +optional

    -

    ALert on success.

    +

    Username.

    -

    boolean

    +

    string

    -

    ApiError

    +

    CodProperties

    -

    API error.

    +

    Additional properties for operational databases.

    @@ -5577,47 +6889,45 @@

    ApiError

    + +
    -

    clusterUrl
    +

    operationalDatabaseName
    optional

    -

    Cluster URL.

    +

    Name of the corresponding operational database..

    string

    +
    +
    +

    CollectDiagnosticBundleRequest

    +
    +

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

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

    code
    -required

    -
    -

    Error code.

    -
    -

    integer (int32)

    -
    -

    message
    -required

    -
    -

    Error message.

    -
    -

    string

    -
    NameDescriptionSchema
    -

    requestId
    -optional

    +

    clusterCrn
    +required

    -

    Request ID.

    +

    The CRN of the target cluster.

    string

    @@ -5625,11 +6935,11 @@

    ApiError

    -

    status
    +

    policyName
    required

    -

    Error status.

    +

    Name of the policy.

    string

    @@ -5639,18 +6949,9 @@

    ApiError

    -

    AwsCloudCredentialType

    -
    -

    AWS cloud credential type.

    -
    -
    -

    Type : enum (IAM, ACCESSKEY)

    -
    -
    -
    -

    Cluster

    +

    CollectDiagnosticBundleResponse

    -

    Describes a Datalake, Datahub or Classic cluster.

    +

    Response object for collect-diagnostic-bundle.

    @@ -5668,35 +6969,35 @@

    Cluster

    - - - - - + +
    -

    cloudAccountProvider
    +

    active
    optional

    -

    Cloud account provider.

    +

    Whether the diagnostic bundle command is active.

    -

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

    +

    boolean

    -

    clusterManagerType
    +

    commandId
    required

    -

    Cluster Manager type.

    +

    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.

    -

    enum (CLOUDERA_MANAGER, AMBARI)

    +

    integer (int64)

    -

    clusterManagerUrl
    -required

    +

    name
    +optional

    -

    Cluster Manager URL.

    +

    Name of the policy.

    string

    @@ -5704,23 +7005,11 @@

    Cluster

    -

    clusterType
    -required

    -
    -

    Cluster type.

    -
    -

    enum (CLASSIC, SDX, DISTROX)

    -
    -

    clusterUrl
    -required

    +

    resultMessage
    +optional

    -

    Cluster URL.

    +

    Diagnostic bundle collection command result message.

    string

    @@ -5728,35 +7017,45 @@

    Cluster

    -

    cmName
    +

    startTime
    optional

    -

    Cloudera Manager name.

    +

    Start time of the diagnostic bundle collection command.

    string

    +
    +
    +

    ContinueHbaseSetupRequest

    +
    +

    Continue an HBase setup for Classic Cluster source.

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

    codProperties
    -optional

    -
    -

    Additional properties for operational databases.

    -
    NameDescriptionSchema
    -

    crn
    +

    clusterCrn
    required

    -

    Cluster CRN.

    +

    The CRN of the destination cluster.

    string

    @@ -5764,23 +7063,45 @@

    Cluster

    -

    dataCenter
    +

    policyId
    required

    -

    Cluster data center.

    +

    The ID of the HBase policy.

    string

    +
    +
    +

    ContinueHbaseSetupResponse

    +
    +

    Response object for continueHbaseSetup.

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

    description
    +

    clusterCrn
    optional

    -

    Cluster description.

    +

    The CRN of the input cluster.

    string

    @@ -5788,11 +7109,11 @@

    Cluster

    -

    environmentCrn
    +

    message
    optional

    -

    CRN of the cluster’s environment.

    +

    The detailed description of the action taken.

    string

    @@ -5800,35 +7121,45 @@

    Cluster

    -

    knoxUrl
    +

    status
    optional

    -

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

    +

    The status of the request.

    string

    +
    +
    +

    CreateAbfsAccessKeyCredentialRequest

    +
    +

    Request object for creating ABFS Access Key based accounts in DLM Engine.

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

    location
    -optional

    -
    -

    Cluster location.

    -
    NameDescriptionSchema
    -

    name
    +

    accessKey
    required

    -

    Cluster name.

    +

    ABFS access key.

    string

    @@ -5836,35 +7167,23 @@

    Cluster

    -

    replicationEngineType
    +

    clusters
    required

    -

    Replication engine type.

    -
    -

    enum (CM, DLM_ENGINE)

    -
    -

    stackCrn
    -optional

    -
    -

    Stack CRN.

    +

    List of cluster CRNs where the credential should be created.

    -

    string

    +

    < string > array

    -

    stackMajorVersion
    -optional

    +

    name
    +required

    -

    Stack major version.

    +

    Name of the credential.

    string

    @@ -5872,47 +7191,57 @@

    Cluster

    -

    stackVersion
    -optional

    +

    storageAccountName
    +required

    -

    Stack version.

    +

    ABFS storage account name.

    string

    +
    +
    +

    CreateAbfsAccessKeyCredentialResponse

    +
    +

    Response object for creating ABFS Access Key based accounts in DLM Engine.

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

    totalHosts
    -optional

    -
    -

    Total hosts on the cluster.

    -
    -

    integer (int32)

    -
    NameDescriptionSchema
    -

    uuid
    +

    errors
    optional

    -

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

    +

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

    -

    string

    +

    < ApiError > array

    -

    ClusterServiceStatuses

    +

    CreateAbfsClientKeyCredentialRequest

    -

    Describes the status of services running on a cluster.

    +

    Request object for creating Azure Active Directory Service Principal accounts in Cloudera Manager.

    @@ -5930,11 +7259,11 @@

    ClusterServiceStatuses

    + + + + + - -
    -

    clusterCrn
    +

    clientId
    required

    -

    Cluster CRN.

    +

    Client ID of an Active Directory service principal account.

    string

    @@ -5942,45 +7271,35 @@

    ClusterServiceStatuses

    -

    serviceStatuses
    +

    clientSecretKey
    required

    -

    List of service statuses.

    +

    Client Key of an Active Directory service principal account.

    +
    +

    string

    +
    +

    clusters
    +required

    +
    +

    List of cluster CRNs where the credential should be created.

    -

    < ServiceInfo > array

    +

    < string > array

    -
    -
    -

    CmPolicySubmitUser

    -
    -

    CM Policy submit user.

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

    sourceUser
    -optional

    +

    name
    +required

    -

    Source user.

    +

    Name of the credential.

    string

    @@ -5988,11 +7307,11 @@

    CmPolicySubmitUser

    -

    userName
    -optional

    +

    tenantId
    +required

    -

    Username.

    +

    Tenant ID of an Active Directory service principal account.

    string

    @@ -6002,9 +7321,9 @@

    CmPolicySubmitUser

    -

    CodProperties

    +

    CreateAbfsClientKeyCredentialResponse

    -

    Additional properties for operational databases.

    +

    Response object for creating Azure Active Directory Service Principal accounts in Cloudera Manager.

    @@ -6022,23 +7341,23 @@

    CodProperties

    -

    operationalDatabaseName
    +

    errors
    optional

    -

    Name of the corresponding operational database..

    +

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

    -

    string

    +

    < ApiError > array

    -

    CollectDiagnosticBundleRequest

    +

    CreateAbfsCredentialRequest

    -

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

    +

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

    @@ -6056,11 +7375,11 @@

    CollectDiagnosticBundleRequest

    - -
    -

    clusterCrn
    -required

    +

    accessKey
    +optional

    -

    The CRN of the target cluster.

    +

    ABFS access key.

    string

    @@ -6068,69 +7387,47 @@

    CollectDiagnosticBundleRequest

    -

    policyName
    -required

    +

    clientId
    +optional

    -

    Name of the policy.

    +

    Client ID of an Active Directory service principal account.

    string

    -
    -
    -

    CollectDiagnosticBundleResponse

    -
    -

    Response object for collect-diagnostic-bundle.

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

    active
    +

    clientSecretKey
    optional

    -

    Whether the diagnostic bundle command is active.

    +

    Client Key of an Active Directory service principal account.

    -

    boolean

    +

    string

    -

    commandId
    +

    clusters
    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.

    +

    List of cluster CRNs where the credential should be created.

    -

    integer (int64)

    +

    < string > array

    name
    -optional

    +required

    -

    Name of the policy.

    +

    Name of the credential.

    string

    @@ -6138,11 +7435,11 @@

    CollectDiagnosticBundleResponse

    -

    resultMessage
    +

    storageAccountName
    optional

    -

    Diagnostic bundle collection command result message.

    +

    ABFS storage account name.

    string

    @@ -6150,23 +7447,35 @@

    CollectDiagnosticBundleResponse

    -

    startTime
    +

    tenantId
    optional

    -

    Start time of the diagnostic bundle collection command.

    +

    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.

    +
    -

    ContinueHbaseSetupRequest

    +

    CreateAbfsCredentialResponse

    -

    Continue an HBase setup for Classic Cluster source.

    +

    Response object for creating ABFS credentials.

    @@ -6184,35 +7493,23 @@

    ContinueHbaseSetupRequest

    - - - - -
    -

    clusterCrn
    -required

    -
    -

    The CRN of the destination cluster.

    -
    -

    string

    -
    -

    policyId
    -required

    +

    errors
    +optional

    -

    The ID of the HBase policy.

    +

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

    -

    string

    +

    < ApiError > array

    -

    ContinueHbaseSetupResponse

    +

    CreateAwsAccessKeyCredentialRequest

    -

    Response object for continueHbaseSetup.

    +

    Request object for creating AWS Access Key cloud credentials.

    @@ -6230,11 +7527,11 @@

    ContinueHbaseSetupResponse

    + + + + +
    -

    clusterCrn
    -optional

    +

    accessKey
    +required

    -

    The CRN of the input cluster.

    +

    AWS access key.

    string

    @@ -6242,11 +7539,23 @@

    ContinueHbaseSetupResponse

    -

    message
    -optional

    +

    clusters
    +required

    -

    The detailed description of the action taken.

    +

    List of cluster CRNs where the credential should be created.

    +
    +

    < string > array

    +
    +

    name
    +required

    +
    +

    Name of the credential.

    string

    @@ -6254,11 +7563,11 @@

    ContinueHbaseSetupResponse

    -

    status
    -optional

    +

    secretKey
    +required

    -

    The status of the request.

    +

    AWS secret key.

    string

    @@ -6268,9 +7577,9 @@

    ContinueHbaseSetupResponse

    -

    CreateAbfsCredentialRequest

    +

    CreateAwsAccessKeyCredentialResponse

    -

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

    +

    Response object for creating AWS Access Key cloud credentials.

    @@ -6288,23 +7597,45 @@

    CreateAbfsCredentialRequest

    + +
    -

    accessKey
    +

    errors
    optional

    -

    ABFS access key.

    +

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

    -

    string

    +

    < ApiError > array

    +
    +
    +

    CreateAwsCredentialRequest

    +
    +

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

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

    clientId
    +

    accessKey
    optional

    -

    Client ID of an Active Directory service principal account.

    +

    AWS access key.

    string

    @@ -6312,35 +7643,35 @@

    CreateAbfsCredentialRequest

    -

    clientSecretKey
    -optional

    +

    clusters
    +required

    -

    Client Key of an Active Directory service principal account.

    +

    List of cluster CRNs where the credential should be created.

    -

    string

    +

    < string > array

    -

    clusters
    +

    name
    required

    -

    List of cluster CRNs where the credential should be created.

    +

    Name of the credential.

    -

    < string > array

    +

    string

    -

    name
    -required

    +

    secretKey
    +optional

    -

    Name of the credential.

    +

    AWS secret key.

    string

    @@ -6348,47 +7679,103 @@

    CreateAbfsCredentialRequest

    -

    storageAccountName
    +

    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

    -

    ABFS storage account name.

    +

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

    -

    string

    +

    < ApiError > array

    +
    +
    +

    CreateAwsIamCredentialRequest

    +
    +

    Request object for creating AWS IAM Role based cloud credentials.

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

    tenantId
    -optional

    +

    clusters
    +required

    -

    Tenant ID of an Active Directory service principal account.

    +

    List of cluster CRNs where the credential should be created.

    -

    string

    +

    < string > array

    -

    type
    +

    name
    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.

    +

    Name of the credential.

    -

    CreateAbfsCredentialResponse

    +

    CreateAwsIamCredentialResponse

    -

    Response object for creating ABFS credentials.

    +

    Response object for creating AWS IAM Role based cloud credentials.

    @@ -6420,9 +7807,9 @@

    CreateAbfsCredentialResponse

    -

    CreateAwsCredentialRequest

    +

    CreateAwsIdbrokerCredentialRequest

    -

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

    +

    Request object for creating AWS IDBroker cloud credentials.

    @@ -6440,18 +7827,6 @@

    CreateAwsCredentialRequest

    - - - - - @@ -6464,11 +7839,11 @@

    CreateAwsCredentialRequest

    -

    accessKey
    -optional

    -
    -

    AWS access key.

    -
    -

    string

    -

    clusters
    required

    -

    name
    +

    idbrokerAddress
    required

    -

    Name of the credential.

    +

    The address of the IDBroker endpoint that will be used for authentication, for example http(s)://[IDBROKER_HOST]:[IDBROKER_PORT]/gateway.

    string

    @@ -6476,11 +7851,11 @@

    CreateAwsCredentialRequest

    -

    secretKey
    -optional

    +

    idbrokerCabPath
    +required

    -

    AWS secret key.

    +

    The name of the IDBroker topology that will be used for authentication.

    string

    @@ -6488,23 +7863,23 @@

    CreateAwsCredentialRequest

    -

    type
    +

    name
    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.

    +

    Name of the credential.

    -

    CreateAwsCredentialResponse

    +

    CreateAwsIdbrokerCredentialResponse

    -

    Response object for creating AWS credentials.

    +

    Response object for creating AWS IDBroker cloud credentials.

    @@ -6536,9 +7911,9 @@

    CreateAwsCredentialResponse

    -

    CreateGcsCredentialRequest

    +

    CreateGcsPrivateKeyCredentialRequest

    -

    Request object for creating GCS cloud credentials.

    +

    Request object for creating GCS Private Key cloud credentials.

    @@ -6557,7 +7932,7 @@

    CreateGcsCredentialRequest

    - - - - -

    clientEmail
    -optional

    +required

    Client email.

    @@ -6593,7 +7968,7 @@

    CreateGcsCredentialRequest

    privateKey
    -optional

    +required

    GCS private key.

    @@ -6605,7 +7980,7 @@

    CreateGcsCredentialRequest

    privateKeyId
    -optional

    +required

    GCS private key ID.

    @@ -6614,25 +7989,13 @@

    CreateGcsCredentialRequest

    string

    -

    type
    -required

    -
    -

    Type of the credential. Additional accepted parameters by type: PRIVATEKEY: clientEmail, privateKeyId, privateKey. Superfluous parameters are ignored.

    -
    -

    CreateGcsCredentialResponse

    +

    CreateGcsPrivateKeyCredentialResponse

    -

    Response object for creating GCS credentials.

    +

    Response object for creating GCS Private Key cloud credentials.

    @@ -6842,9 +8205,70 @@

    CreatePolicyResponse

    Response object for createPolicy.

    -
    -

    Type : object

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

    clusterCrn
    +optional

    +
    +

    The CRN of the input cluster.

    +
    +

    string

    +
    +

    message
    +optional

    +
    +

    The detailed description of the action taken.

    +
    +

    string

    +
    +

    requestId
    +optional

    +
    +

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

    +
    +

    string

    +
    +

    status
    +optional

    +
    +

    The status of the request.

    +
    +

    string

    +

    CreateSnapshotPolicyRequest

    @@ -7489,9 +8913,70 @@

    DeletePolicyResponse

    Response object for deletePolicy.

    -
    -

    Type : object

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

    clusterCrn
    +optional

    +
    +

    The CRN of the input cluster.

    +
    +

    string

    +
    +

    message
    +optional

    +
    +

    The detailed description of the action taken.

    +
    +

    string

    +
    +

    requestId
    +optional

    +
    +

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

    +
    +

    string

    +
    +

    status
    +optional

    +
    +

    The status of the request.

    +
    +

    string

    +

    DeleteSnapshotPolicyRequest

    @@ -7795,15 +9280,6 @@

    ErrorHandling

    -

    GcsCloudCredentialType

    -
    -

    GCS cloud credential type.

    -
    -
    -

    Type : enum (PRIVATEKEY)

    -
    -
    -

    GetClusterConfigRequest

    Request object for getClusterConfig.

    @@ -8870,6 +10346,18 @@

    HbasePolicyDefinition

    +

    exportSnapshotUser
    +optional

    +
    +
    +

    If set, the user specified by this parameter will be used to export the initial snapshot on the source.

    +
    +
    +

    string

    +
    + + +

    hbasePolicyArguments
    required

    @@ -10693,8 +12181,20 @@

    Policy

    Description Schema - - + + + +
    +

    cmPolicySubmitUser
    +optional

    +
    +
    +

    CM policy submit user.

    +
    + +

    creationTime
    @@ -13908,9 +15408,70 @@

    SuspendPolicyResponse

    Response object for suspendPolicy.

    -
    -

    Type : object

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

    clusterCrn
    +optional

    +
    +

    The CRN of the input cluster.

    +
    +

    string

    +
    +

    message
    +optional

    +
    +

    The detailed description of the action taken.

    +
    +

    string

    +
    +

    requestId
    +optional

    +
    +

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

    +
    +

    string

    +
    +

    status
    +optional

    +
    +

    The status of the request.

    +
    +

    string

    +

    SuspendSnapshotPolicyRequest

    @@ -13945,23 +15506,219 @@

    SuspendSnapshotPolicyRequest

    -

    name
    -required

    +

    name
    +required

    +
    +
    +

    The name of the snapshot policy to be suspended.

    +
    +
    +

    string

    +
    + + + +
    +
    +

    SuspendSnapshotPolicyResponse

    +
    +

    Response object for suspendSnapshotPolicy.

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

    clusterCrn
    +optional

    +
    +

    CRN of the cluster where the snapshot policy is.

    +
    +

    string

    +
    +

    message
    +optional

    +
    +

    The detailed description of the action taken.

    +
    +

    string

    +
    +

    status
    +optional

    +
    +

    The status of the request.

    +
    +

    string

    +
    +
    +
    +

    TargetDetails

    +
    +

    Target details.

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

    environmentCrn
    +required

    +
    +

    Target’s environment CRN.

    +
    +

    string

    +
    +

    warehouseCrn
    +optional

    +
    +

    Target’s warehouse CRN.

    +
    +

    string

    +
    +
    +
    +

    UpdateAbfsAccessKeyCredentialRequest

    +
    +

    Request object for updating ABFS Access Key based accounts in DLM Engine.

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

    accessKey
    +required

    +
    +

    ABFS access key.

    +
    +

    string

    +
    +

    name
    +required

    +
    +

    Name of the credential to update.

    +
    +

    string

    +
    +

    storageAccountName
    +required

    +
    +

    ABFS storage account name.

    +
    +

    string

    +
    +
    +
    +

    UpdateAbfsAccessKeyCredentialResponse

    +
    +

    Response object for updating ABFS Access Key based accounts in DLM Engine.

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

    errors
    +optional

    -

    The name of the snapshot policy to be suspended.

    +

    The list of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters).

    -

    string

    +

    < ApiError > array

    -

    SuspendSnapshotPolicyResponse

    +

    UpdateAbfsClientKeyCredentialRequest

    -

    Response object for suspendSnapshotPolicy.

    +

    Request object for updating Azure Active Directory Service Principal accounts in Cloudera Manager.

    @@ -13979,11 +15736,11 @@

    SuspendSnapshotPolicyResponse

    + + + + +
    -

    clusterCrn
    -optional

    +

    clientId
    +required

    -

    CRN of the cluster where the snapshot policy is.

    +

    Client ID of an Active Directory service principal account.

    string

    @@ -13991,11 +15748,11 @@

    SuspendSnapshotPolicyResponse

    -

    message
    -optional

    +

    clientSecretKey
    +required

    -

    The detailed description of the action taken.

    +

    Client Key of an Active Directory service principal account.

    string

    @@ -14003,11 +15760,23 @@

    SuspendSnapshotPolicyResponse

    -

    status
    -optional

    +

    name
    +required

    -

    The status of the request.

    +

    Name of the credential to update.

    +
    +

    string

    +
    +

    tenantId
    +required

    +
    +

    Tenant ID of an Active Directory service principal account.

    string

    @@ -14017,9 +15786,9 @@

    SuspendSnapshotPolicyResponse

    -

    TargetDetails

    +

    UpdateAbfsClientKeyCredentialResponse

    -

    Target details.

    +

    Response object for updating Azure Active Directory Service Principal accounts in Cloudera Manager.

    @@ -14037,35 +15806,23 @@

    TargetDetails

    - - - - -
    -

    environmentCrn
    -required

    -
    -

    Target’s environment CRN.

    -
    -

    string

    -
    -

    warehouseCrn
    +

    errors
    optional

    -

    Target’s warehouse CRN.

    +

    The list of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters).

    -

    string

    +

    < ApiError > array

    -

    UpdateAbfsCredentialRequest

    +

    UpdateAwsAccessKeyCredentialRequest

    -

    Request object for updating ABFS cloud credentials.

    +

    Request object for updating AWS Access Key cloud credentials.

    @@ -14084,10 +15841,10 @@

    UpdateAbfsCredentialRequest

    + +

    accessKey
    -optional

    +required

    -

    ABFS access key.

    +

    AWS access key.

    string

    @@ -14095,11 +15852,11 @@

    UpdateAbfsCredentialRequest

    -

    clientId
    -optional

    +

    name
    +required

    -

    Client ID of an Active Directory service principal account.

    +

    Name of the credential to update.

    string

    @@ -14107,71 +15864,91 @@

    UpdateAbfsCredentialRequest

    -

    clientSecretKey
    -optional

    +

    secretKey
    +required

    -

    Client Key of an Active Directory service principal account.

    +

    AWS secret key.

    string

    +
    +
    +

    UpdateAwsAccessKeyCredentialResponse

    +
    +

    Response object for updating AWS Access Key cloud credentials.

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

    name
    -required

    -
    -

    Name of the credential to update.

    -
    -

    string

    -
    NameDescriptionSchema
    -

    storageAccountName
    +

    errors
    optional

    -

    ABFS storage account name.

    +

    The list of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters).

    -

    string

    +

    < ApiError > array

    +
    +
    +

    UpdateAwsIamCredentialRequest

    +
    +

    Request object for updating AWS IAM Role based cloud credentials.

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

    tenantId
    -optional

    -
    -

    Tenant ID of an Active Directory service principal account.

    -
    -

    string

    -
    NameDescriptionSchema
    -

    type
    +

    name
    required

    -

    Type of the credential. Additional accepted parameters by type: ACCESSKEY: storageAccountName, accessKey; CLIENTKEY: clientId, clientSecretKey, tenantId. Superfluous parameters are ignored. ACCESSKEY is only supported on Ambari, while CLIENTKEY is only supported on Cloudera Manager.

    +

    Name of the credential to update.

    -

    UpdateAbfsCredentialResponse

    +

    UpdateAwsIamCredentialResponse

    -

    Response object for updating ABFS credentials.

    +

    Response object for updating AWS IAM Role based cloud credentials.

    @@ -14193,7 +15970,7 @@

    UpdateAbfsCredentialResponse

    optional

    -

    List of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters).

    +

    The list of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters).

    < ApiError > array

    @@ -14203,9 +15980,9 @@

    UpdateAbfsCredentialResponse

    -

    UpdateAwsCredentialRequest

    +

    UpdateAwsIdbrokerCredentialRequest

    -

    Request object for updating AWS cloud credentials.

    +

    Request object for updating AWS IdBroker cloud credentials.

    @@ -14223,23 +16000,11 @@

    UpdateAwsCredentialRequest

    - - - - -
    -

    accessKey
    -optional

    -
    -

    AWS access key.

    -
    -

    string

    -
    -

    name
    +

    idbrokerAddress
    required

    -

    Name of the credential to update.

    +

    The address of the IDBroker endpoint that will be used for authentication, for example http(s)://[IDBROKER_HOST]:[IDBROKER_PORT]/gateway.

    string

    @@ -14247,11 +16012,11 @@

    UpdateAwsCredentialRequest

    -

    secretKey
    -optional

    +

    idbrokerCabPath
    +required

    -

    AWS secret key.

    +

    The name of the IDBroker topology that will be used for authentication.

    string

    @@ -14259,23 +16024,23 @@

    UpdateAwsCredentialRequest

    -

    type
    +

    name
    required

    -

    Type of the credential. Additional accepted parameters by type: IAM: none; ACCESSKEY: accessKey, secretKey. Superfluous parameters are ignored.

    +

    Name of the credential to update.

    -

    UpdateAwsCredentialResponse

    +

    UpdateAwsIdbrokerCredentialResponse

    -

    Response object for updating AWS credentials.

    +

    Response object for updating AWS IdBroker cloud credentials.

    @@ -14307,9 +16072,9 @@

    UpdateAwsCredentialResponse

    -

    UpdateGcsCredentialRequest

    +

    UpdateGcsPrivateKeyCredentialRequest

    -

    Request object for updating GCS cloud credentials.

    +

    Request object for updating GCS Private Key cloud credentials.

    @@ -14328,7 +16093,7 @@

    UpdateGcsCredentialRequest

    - - - - -

    clientEmail
    -optional

    +required

    Client email.

    @@ -14352,7 +16117,7 @@

    UpdateGcsCredentialRequest

    privateKey
    -optional

    +required

    GCS private key.

    @@ -14364,7 +16129,7 @@

    UpdateGcsCredentialRequest

    privateKeyId
    -optional

    +required

    GCS private key ID.

    @@ -14373,25 +16138,13 @@

    UpdateGcsCredentialRequest

    string

    -

    type
    -required

    -
    -

    Type of the credential. Additional accepted parameters by type: PRIVATEKEY: clientEmail, privateKeyId, privateKey. Superfluous parameters are ignored.

    -
    -

    UpdateGcsCredentialResponse

    +

    UpdateGcsPrivateKeyCredentialResponse

    -

    Response object for updating GCS credentials.

    +

    Response object for updating GCS Private Key cloud credentials.

    @@ -14413,7 +16166,7 @@

    UpdateGcsCredentialResponse

    optional

    -

    List of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters).

    +

    The list of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters).

    < ApiError > array

    @@ -14909,9 +16662,70 @@

    UpdatePolicyResponse

    Response object for updatePolicy.

    -
    -

    Type : object

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

    clusterCrn
    +optional

    +
    +

    The CRN of the input cluster.

    +
    +

    string

    +
    +

    message
    +optional

    +
    +

    The detailed description of the action taken.

    +
    +

    string

    +
    +

    requestId
    +optional

    +
    +

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

    +
    +

    string

    +
    +

    status
    +optional

    +
    +

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

    +
    +

    string

    +

    UpdateSnapshotPolicyRequest

    @@ -15330,7 +17144,7 @@

    VerifyHbaseClusterPairResponse


    diff --git a/api-docs-beta/swagger/README.md b/api-docs-beta/swagger/README.md index 7ac73f667..d0665ef93 100644 --- a/api-docs-beta/swagger/README.md +++ b/api-docs-beta/swagger/README.md @@ -1,6 +1,6 @@ # CDP Control Plane Public API Swagger Service Definitions -*Version: 0.9.125 (BETA)* +*Version: 0.9.126 (BETA)* 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,25 +15,25 @@ API requests must be signed according to the | Service Definition | Version | | --- | --- | -| [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 | -| [metrics.yaml](./metrics.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 | +| [audit.yaml](./audit.yaml) | 0.9.126 | +| [cloudprivatelinks.yaml](./cloudprivatelinks.yaml) | 0.9.126 | +| [compute.yaml](./compute.yaml) | 0.9.126 | +| [consumption.yaml](./consumption.yaml) | 0.9.126 | +| [datacatalog.yaml](./datacatalog.yaml) | 0.9.126 | +| [datahub.yaml](./datahub.yaml) | 0.9.126 | +| [datalake.yaml](./datalake.yaml) | 0.9.126 | +| [de.yaml](./de.yaml) | 0.9.126 | +| [df.yaml](./df.yaml) | 0.9.126 | +| [dfworkload.yaml](./dfworkload.yaml) | 0.9.126 | +| [drscp.yaml](./drscp.yaml) | 0.9.126 | +| [dw.yaml](./dw.yaml) | 0.9.126 | +| [environments.yaml](./environments.yaml) | 0.9.126 | +| [iam.yaml](./iam.yaml) | 0.9.126 | +| [imagecatalog.yaml](./imagecatalog.yaml) | 0.9.126 | +| [metrics.yaml](./metrics.yaml) | 0.9.126 | +| [ml.yaml](./ml.yaml) | 0.9.126 | +| [opdb.yaml](./opdb.yaml) | 0.9.126 | +| [replicationmanager.yaml](./replicationmanager.yaml) | 0.9.126 | 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-beta/swagger/audit.yaml b/api-docs-beta/swagger/audit.yaml index a17591a67..331a2a3da 100644 --- a/api-docs-beta/swagger/audit.yaml +++ b/api-docs-beta/swagger/audit.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.125 (BETA) + version: 0.9.126 (BETA) title: Cloudera Audit Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/cloudprivatelinks.yaml b/api-docs-beta/swagger/cloudprivatelinks.yaml index 2a3de14c7..827143cae 100644 --- a/api-docs-beta/swagger/cloudprivatelinks.yaml +++ b/api-docs-beta/swagger/cloudprivatelinks.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.125 (BETA) + version: 0.9.126 (BETA) title: Cloudera CloudPrivateLinks API Service license: name: Apache 2.0 @@ -247,13 +247,19 @@ definitions: properties: cloudAccountId: type: string - description: Account ID to authorize access for PrivateLink. + description: AWS account ID to authorize access for PrivateLink. + subscriptionId: + type: string + description: Azure subscription ID to authorize access for PrivateLink. region: type: string description: Region where the private link service exists. serviceGroup: type: string description: CDP service group. Currently supported "CDP-CONTROL-PLANE" for PaaS. + cloudServiceProvider: + description: Cloud Service Provider. Currently supporting AWS and AZURE. + $ref: '#/definitions/CloudServiceProvider' AuthorizePrivateLinkServiceAccessResponse: type: object description: Response object for the AuthorizePrivateLinkServicesAccess method. @@ -462,13 +468,19 @@ definitions: properties: cloudAccountId: type: string - description: Account ID to revoke access for PrivateLink. + description: AWS account ID to authorize access for PrivateLink. + subscriptionId: + type: string + description: Azure subscription ID to authorize access for PrivateLink. region: type: string description: Region where the private link service exists. serviceGroup: type: string description: CDP service group. Currently supported "CDP-CONTROL-PLANE" for PaaS. + cloudServiceProvider: + description: Cloud Service Provider. Currently supporting AWS and AZURE. + $ref: '#/definitions/CloudServiceProvider' RevokePrivateLinkServiceAccessResponse: type: object description: Response object for the RevokePrivateLinkServiceAccess method. diff --git a/api-docs-beta/swagger/compute.yaml b/api-docs-beta/swagger/compute.yaml index 68d0551b8..de974d056 100644 --- a/api-docs-beta/swagger/compute.yaml +++ b/api-docs-beta/swagger/compute.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public,private x-cdp-releases: PUBLIC info: - version: 0.9.125 (BETA) + version: 0.9.126 (BETA) title: Cloudera Compute Service license: name: Apache 2.0 @@ -510,10 +510,7 @@ definitions: properties: customerKmsKeyArn: type: string - description: The KMS key ARN used. - enabled: - type: boolean - description: Flag to indicate if secret encryption is enabled. + description: AWS KMS key ARN. x-form-factors: public CommonVolumeEncryptionResp: type: object @@ -521,7 +518,7 @@ definitions: properties: customerKmsKeyArn: type: string - description: The KMS key ARN used. + description: AWS KMS key ARN. x-form-factors: public CommonSecurityResp: type: object @@ -1834,12 +1831,8 @@ definitions: properties: customerKmsKeyArn: type: string - description: The KMS key ARN used. + description: AWS KMS key ARN. x-sensitive: true - enabled: - type: boolean - description: Flag to enable secret encryption (default true). Deprecated. - x-deprecated: true CommonVolumeEncryption: type: object description: Volume encryption request structure. diff --git a/api-docs-beta/swagger/consumption.yaml b/api-docs-beta/swagger/consumption.yaml index 958196ac5..4e0837890 100644 --- a/api-docs-beta/swagger/consumption.yaml +++ b/api-docs-beta/swagger/consumption.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.125 (BETA) + version: 0.9.126 (BETA) title: Cloudera Consumption API Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/datacatalog.yaml b/api-docs-beta/swagger/datacatalog.yaml index a40c26b24..b695c2549 100644 --- a/api-docs-beta/swagger/datacatalog.yaml +++ b/api-docs-beta/swagger/datacatalog.yaml @@ -5,7 +5,7 @@ x-form-factors: public x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.125 (BETA) + version: 0.9.126 (BETA) title: Cloudera DataCatalog Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/datahub.yaml b/api-docs-beta/swagger/datahub.yaml index e08ec35b1..a45c8f80e 100644 --- a/api-docs-beta/swagger/datahub.yaml +++ b/api-docs-beta/swagger/datahub.yaml @@ -6,7 +6,7 @@ x-form-factors: public x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.125 (BETA) + version: 0.9.126 (BETA) title: Cloudera Data hub Service license: name: Apache 2.0 @@ -1952,7 +1952,7 @@ definitions: description: The content of the recipe. type: type: string - description: 'The type of recipe. Supported values are : PRE_CLOUDERA_MANAGER_START, PRE_TERMINATION, POST_CLOUDERA_MANAGER_START, POST_CLUSTER_INSTALL.' + description: 'The type of recipe. Supported values are : PRE_SERVICE_DEPLOYMENT, PRE_TERMINATION, POST_SERVICE_DEPLOYMENT, POST_CLOUDERA_MANAGER_START.' creatorCrn: type: string description: The CRN of the creator of the recipe. @@ -1974,7 +1974,7 @@ definitions: description: The CRN of the recipe. type: type: string - description: 'The type of recipe. Supported values are : PRE_CLOUDERA_MANAGER_START, PRE_TERMINATION, POST_CLOUDERA_MANAGER_START, POST_CLUSTER_INSTALL.' + description: 'The type of recipe. Supported values are : PRE_SERVICE_DEPLOYMENT, PRE_TERMINATION, POST_SERVICE_DEPLOYMENT, POST_CLOUDERA_MANAGER_START.' description: type: string description: The description of the recipe. @@ -3302,7 +3302,7 @@ definitions: description: The content of the recipe. type: type: string - description: 'The type of recipe. Supported values are : PRE_CLOUDERA_MANAGER_START, PRE_TERMINATION, POST_CLOUDERA_MANAGER_START, POST_CLUSTER_INSTALL.' + description: 'The type of recipe. Supported values are : PRE_SERVICE_DEPLOYMENT, PRE_TERMINATION, POST_SERVICE_DEPLOYMENT, POST_CLOUDERA_MANAGER_START.' description: type: string description: The description of the recipe. The description can have a maximum of 1000 characters. diff --git a/api-docs-beta/swagger/datalake.yaml b/api-docs-beta/swagger/datalake.yaml index aa1b52a41..f7c3dfd7e 100644 --- a/api-docs-beta/swagger/datalake.yaml +++ b/api-docs-beta/swagger/datalake.yaml @@ -6,7 +6,7 @@ x-form-factors: public x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.125 (BETA) + version: 0.9.126 (BETA) title: Cloudera Datalake Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/de.yaml b/api-docs-beta/swagger/de.yaml index 8c4e16381..4596f386a 100644 --- a/api-docs-beta/swagger/de.yaml +++ b/api-docs-beta/swagger/de.yaml @@ -5,7 +5,7 @@ x-form-factors: public,private x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.125 (BETA) + version: 0.9.126 (BETA) title: Cloudera Data Engineering license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/df.yaml b/api-docs-beta/swagger/df.yaml index a25642245..4d8a26944 100644 --- a/api-docs-beta/swagger/df.yaml +++ b/api-docs-beta/swagger/df.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.125 (BETA) + version: 0.9.126 (BETA) title: Cloudera DataFlow Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/dfworkload.yaml b/api-docs-beta/swagger/dfworkload.yaml index 4ab4dd097..6cfa2a932 100644 --- a/api-docs-beta/swagger/dfworkload.yaml +++ b/api-docs-beta/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.125 (BETA) + version: 0.9.126 (BETA) title: Cloudera DataFlow Workload Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/drscp.yaml b/api-docs-beta/swagger/drscp.yaml index 7537cbdd8..6f1482209 100644 --- a/api-docs-beta/swagger/drscp.yaml +++ b/api-docs-beta/swagger/drscp.yaml @@ -5,7 +5,7 @@ x-form-factors: private x-audit: true x-cdp-releases: PUBLIC info: - version: 0.9.125 (BETA) + version: 0.9.126 (BETA) title: CDP Control Plane Data Recovery Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/dw.yaml b/api-docs-beta/swagger/dw.yaml index 53fc5e52c..58de2c537 100644 --- a/api-docs-beta/swagger/dw.yaml +++ b/api-docs-beta/swagger/dw.yaml @@ -4,7 +4,7 @@ x-products: CDP x-form-factors: public,private x-cdp-releases: PUBLIC info: - version: 0.9.125 (BETA) + version: 0.9.126 (BETA) title: Cloudera Data Warehouse [EXPERIMENTAL] license: name: Apache 2.0 @@ -2620,8 +2620,9 @@ definitions: type: string description: 'DEPRECATED: As of PVC 1.5.4 we no longer use delegation user. Password of delegation user.' securityContextConstraintName: + x-deprecated: true type: string - description: The name of the Hive Security Context Constraint. + description: 'DEPRECATED: This option will be removed in future releases. Instead of creating a custom Security Context Constraint, we rely on the cluster default. The name of the Hive Security Context Constraint.' storageClass: type: string description: The storage class for the Local Storage Operator. @@ -2864,17 +2865,20 @@ definitions: type: string description: 'DEPRECATED: As of PVC 1.5.4 we no longer use delegation user. Password of delegation user.' securityContextConstraintName: + x-deprecated: true type: string - description: The name of the Hive Security Context Constraint. + description: 'DEPRECATED: This option will be removed in future releases. Instead of creating a custom Security Context Constraint, we rely on the cluster default. The name of the Hive Security Context Constraint.' storageClass: type: string description: The storage class for the Local Storage Operator. dbDas: + x-deprecated: true type: string - description: The name of the DAS database. Not required for embedded databases + description: 'DEPRECATED: Current Private Cloud releases only support embedded database, the value of this field is ignored. The name of the DAS database. Not required for embedded databases.' dbHue: + x-deprecated: true type: string - description: The name of the HUE database. Not required for embedded databases. + description: 'DEPRECATED: Current Private Cloud releases only support embedded database, the value of this field is ignored. The name of the HUE database. Not required for embedded databases.' dedicatedExecutorNodes: type: boolean description: Enable to use dedicated nodes exclusively for executors and coordinators, and improve performance. You can enable this only if you reserved nodes while adding a CDP Private Cloud containerized ECS cluster. When disabled, non-compute pods such as MetaStore and Data Visualization can also use the reserved nodes. @@ -3312,18 +3316,21 @@ definitions: description: 'NOTE: creating Default Database Catalogs is deprecated and explicitly disabled. Denotes if Default Database Catalog creation needed.' default: false dbMetastore: + x-deprecated: true type: string - description: The name of the Metastore database. + description: 'DEPRECATED: Current Private Cloud releases only support embedded database, the value of this field is ignored. The name of the Metastore database.' default: '' x-form-factors: private dbDas: + x-deprecated: true type: string - description: The name of the DAS database. Not required for embedded databases. + description: 'DEPRECATED: Current Private Cloud releases only support embedded database, the value of this field is ignored. The name of the DAS database. Not required for embedded databases.' default: '' x-form-factors: private dbHue: + x-deprecated: true type: string - description: The name of the HUE database. Not required for embedded databases. + description: 'DEPRECATED: Current Private Cloud releases only support embedded database, the value of this field is ignored. The name of the HUE database. Not required for embedded databases.' default: '' x-form-factors: private CreateClusterDiagnosticDataJobRequest: diff --git a/api-docs-beta/swagger/environments.yaml b/api-docs-beta/swagger/environments.yaml index 72933dd9f..316ae2483 100644 --- a/api-docs-beta/swagger/environments.yaml +++ b/api-docs-beta/swagger/environments.yaml @@ -6,7 +6,7 @@ x-form-factors: public,private x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.125 (BETA) + version: 0.9.126 (BETA) title: Cloudera Environments Service license: name: Apache 2.0 @@ -588,6 +588,27 @@ paths: description: The default response on an error. schema: $ref: '#/definitions/Error' + /api/v1/environments2/lastSyncStatus: + post: + summary: Returns status of the sync operation for the environment crn. + description: Returns status of the sync operation for the environment based on crn. + operationId: lastSyncStatus + x-mutating: false + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/LastSyncStatusRequest' + responses: + 200: + description: Expected response to a valid request. + schema: + $ref: '#/definitions/LastSyncStatusResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' /api/v1/environments2/listConnectedDataServices: post: summary: Returns the list of Data Services and their cluster names that are attached the given environment. @@ -2682,7 +2703,8 @@ definitions: description: The subnets to use for endpoint access gateway. s3GuardTableName: type: string - description: The name for the DynamoDB table backing S3Guard. + description: Deprecated. S3Guard was used to ensure consistent S3 updates when S3 was still eventually consistent. With the introduction of Consistent S3, the goal and usage of S3 Guard have become superfluous and defunct. + x-deprecated: true description: type: string description: An description of the environment. @@ -2782,7 +2804,8 @@ definitions: description: The subnets to use for endpoint access gateway. s3GuardTableName: type: string - description: The name for the DynamoDB table backing S3Guard. + description: Deprecated. S3Guard was used to ensure consistent S3 updates when S3 was still eventually consistent. With the introduction of Consistent S3, the goal and usage of S3 Guard have become superfluous and defunct. + x-deprecated: true description: type: string description: An description of the environment. @@ -3121,9 +3144,17 @@ definitions: InitializeAWSComputeClusterResponse: type: object description: Response object for an initialize AWS default compute cluster request. + properties: + operationId: + type: string + description: The id of the related operation. InitializeAzureComputeClusterResponse: type: object description: Response object for an initialize Azure default compute cluster request. + properties: + operationId: + type: string + description: The id of the related operation. CreateAzureEnvironmentResponse: type: object description: Response object for a create Azure environment request. @@ -3783,7 +3814,8 @@ definitions: properties: s3GuardTableName: type: string - description: The name for the DynamoDB table backing S3Guard. + description: Deprecated. S3Guard was used to ensure consistent S3 updates when S3 was still eventually consistent. With the introduction of Consistent S3, the goal and usage of S3 Guard have become superfluous and defunct. + x-deprecated: true azureDetails: type: object description: Azure specific environment configuration information. @@ -4203,6 +4235,15 @@ definitions: endTime: type: string description: Sync operation end timestamp. + LastSyncStatusRequest: + type: object + description: Request object for Sync Status. + required: + - envNameOrCrn + properties: + envNameOrCrn: + type: string + description: Name or Crn of the environment. ListConnectedDataServicesRequest: type: object description: Request object for listing connected Data Service(s) for a given environment. @@ -4238,6 +4279,42 @@ definitions: description: List of resource names for the given Data Service. items: type: string + LastSyncStatusResponse: + type: object + description: Response object for Sync Operation. + required: + - operationId + properties: + operationId: + type: string + description: UUID of the request for this operation. This Id can be used for geting status on the operation. + operationType: + description: Operation type, set password or user sync + $ref: '#/definitions/OperationType' + status: + description: Status of this operation. Status can be one of these values (REQUESTED, RUNNING, COMPLETED, FAILED, REJECTED, TIMEDOUT) + $ref: '#/definitions/SyncStatus' + success: + type: array + description: List of sync operation details for all succeeded environments. + items: + $ref: '#/definitions/SyncOperationDetails' + failure: + type: array + description: List of sync operation details for all failed environments. + items: + $ref: '#/definitions/SyncOperationDetails' + error: + type: string + description: If there is any error associated. The error will be populated on any error and it may be populated when the operation failure details are empty. + startDate: + type: string + format: date-time + description: Date when the sync operation started. + endDate: + type: string + format: date-time + description: Date when the sync operation ended. Omitted if operation has not ended. GetEnvironmentUserSyncStateRequest: type: object description: Request object for retrieving the user sync state of an environment. diff --git a/api-docs-beta/swagger/iam.yaml b/api-docs-beta/swagger/iam.yaml index 074482175..e3ed03240 100644 --- a/api-docs-beta/swagger/iam.yaml +++ b/api-docs-beta/swagger/iam.yaml @@ -7,7 +7,7 @@ x-cdp-releases: PUBLIC x-audit: true x-extensions: pvcapipath info: - version: 0.9.125 (BETA) + version: 0.9.126 (BETA) title: Cloudera IAM Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/imagecatalog.yaml b/api-docs-beta/swagger/imagecatalog.yaml index 0bcdc0cd7..85f369cb0 100644 --- a/api-docs-beta/swagger/imagecatalog.yaml +++ b/api-docs-beta/swagger/imagecatalog.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.125 (BETA) + version: 0.9.126 (BETA) title: Image catalog service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/metrics.yaml b/api-docs-beta/swagger/metrics.yaml index 87da26159..ebf963600 100644 --- a/api-docs-beta/swagger/metrics.yaml +++ b/api-docs-beta/swagger/metrics.yaml @@ -14,7 +14,7 @@ info: license: name: Apache 2.0 title: Cloudera Control Plane Monitoring Metrics Administration - version: 0.9.125 (BETA) + version: 0.9.126 (BETA) x-audit: true paths: /api/v1/metrics/createRemoteWriteConfig: diff --git a/api-docs-beta/swagger/ml.yaml b/api-docs-beta/swagger/ml.yaml index 5839d9830..dbbbe22bb 100644 --- a/api-docs-beta/swagger/ml.yaml +++ b/api-docs-beta/swagger/ml.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public,private x-cdp-releases: PUBLIC info: - version: 0.9.125 (BETA) + version: 0.9.126 (BETA) title: Cloudera AI license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/opdb.yaml b/api-docs-beta/swagger/opdb.yaml index ee9e21b69..f2495ffc1 100644 --- a/api-docs-beta/swagger/opdb.yaml +++ b/api-docs-beta/swagger/opdb.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.125 (BETA) + version: 0.9.126 (BETA) title: Operational Database service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/replicationmanager.yaml b/api-docs-beta/swagger/replicationmanager.yaml index b3ab93709..bade37125 100644 --- a/api-docs-beta/swagger/replicationmanager.yaml +++ b/api-docs-beta/swagger/replicationmanager.yaml @@ -5,7 +5,7 @@ x-form-factors: public x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.125 (BETA) + version: 0.9.126 (BETA) title: Cloudera Replication Manager Service license: name: Apache 2.0 @@ -123,23 +123,128 @@ paths: description: The default response on an error. schema: $ref: '#/definitions/Error' - /api/v1/replicationmanager/updateAwsCredential: + /api/v1/replicationmanager/createAwsAccessKeyCredential: post: - summary: Update an AWS Cloud Credential. - description: Updates an existing AWS cloud credential. - operationId: updateAwsCredential + summary: Create an AWS Access Key cloud credential. + description: Creates a new AWS Access Key cloud credential. + operationId: createAwsAccessKeyCredential x-mutating: true parameters: - name: input in: body required: true schema: - $ref: '#/definitions/UpdateAwsCredentialRequest' + $ref: '#/definitions/CreateAwsAccessKeyCredentialRequest' responses: 200: description: Describes a successful response to a valid request. schema: - $ref: '#/definitions/UpdateAwsCredentialResponse' + $ref: '#/definitions/CreateAwsAccessKeyCredentialResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' + /api/v1/replicationmanager/updateAwsAccessKeyCredential: + post: + summary: Update an AWS Access Key cloud credential. + description: Updates an existing AWS Access Key cloud credential. + operationId: updateAwsAccessKeyCredential + x-mutating: true + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/UpdateAwsAccessKeyCredentialRequest' + responses: + 200: + description: Describes a successful response to a valid request. + schema: + $ref: '#/definitions/UpdateAwsAccessKeyCredentialResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' + /api/v1/replicationmanager/createAwsIamCredential: + post: + summary: Create an AWS IAM Role based cloud credential. + description: Creates a new AWS IAM Role based cloud credential. + operationId: createAwsIamCredential + x-mutating: true + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/CreateAwsIamCredentialRequest' + responses: + 200: + description: Describes a successful response to a valid request. + schema: + $ref: '#/definitions/CreateAwsIamCredentialResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' + /api/v1/replicationmanager/updateAwsIamCredential: + post: + summary: Update an AWS IAM Role based cloud credential. + description: Updates an existing AWS IAM Role based cloud credential. + operationId: updateAwsIamCredential + x-mutating: true + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/UpdateAwsIamCredentialRequest' + responses: + 200: + description: Describes a successful response to a valid request. + schema: + $ref: '#/definitions/UpdateAwsIamCredentialResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' + /api/v1/replicationmanager/createAwsIdbrokerCredential: + post: + summary: Create an AWS IDBroker cloud credential. + description: Creates a new AWS IDBroker cloud credential. + operationId: createAwsIdbrokerCredential + x-mutating: true + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/CreateAwsIdbrokerCredentialRequest' + responses: + 200: + description: Describes a successful response to a valid request. + schema: + $ref: '#/definitions/CreateAwsIdbrokerCredentialResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' + /api/v1/replicationmanager/updateAwsIdbrokerCredential: + post: + summary: Update an AWS IDBroker cloud credential. + description: Updates an existing AWS IDBroker cloud credential. + operationId: updateAwsIdbrokerCredential + x-mutating: true + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/UpdateAwsIdbrokerCredentialRequest' + responses: + 200: + description: Describes a successful response to a valid request. + schema: + $ref: '#/definitions/UpdateAwsIdbrokerCredentialResponse' default: description: The default response on an error. schema: @@ -165,65 +270,128 @@ paths: description: The default response on an error. schema: $ref: '#/definitions/Error' - /api/v1/replicationmanager/updateAbfsCredential: + /api/v1/replicationmanager/createAbfsAccessKeyCredential: + post: + summary: Create an ABFS Access Key based account in DLM Engine. + description: Creates a new ABFS Access Key based account in DLM Engine. + operationId: createAbfsAccessKeyCredential + x-mutating: true + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/CreateAbfsAccessKeyCredentialRequest' + responses: + 200: + description: Describes a successful response to a valid request. + schema: + $ref: '#/definitions/CreateAbfsAccessKeyCredentialResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' + /api/v1/replicationmanager/updateAbfsAccessKeyCredential: post: - summary: Update an ABFS Cloud Credential. - description: Updates an existing ABFS cloud credential. - operationId: updateAbfsCredential + summary: Update an ABFS Access Key based account in DLM Engine. + description: Updates an existing ABFS Access Key based account in DLM Engine. + operationId: updateAbfsAccessKeyCredential x-mutating: true parameters: - name: input in: body required: true schema: - $ref: '#/definitions/UpdateAbfsCredentialRequest' + $ref: '#/definitions/UpdateAbfsAccessKeyCredentialRequest' responses: 200: description: Describes a successful response to a valid request. schema: - $ref: '#/definitions/UpdateAbfsCredentialResponse' + $ref: '#/definitions/UpdateAbfsAccessKeyCredentialResponse' default: description: The default response on an error. schema: $ref: '#/definitions/Error' - /api/v1/replicationmanager/createGcsCredential: + /api/v1/replicationmanager/createAbfsClientKeyCredential: post: - summary: Create a GCS Cloud Credential. - description: Creates a new GCS cloud credential. - operationId: createGcsCredential + summary: Create an Azure Active Directory Service Principal account in Cloudera Manager. + description: Creates a new Azure Active Directory Service Principal account in Cloudera Manager. + operationId: createAbfsClientKeyCredential x-mutating: true parameters: - name: input in: body required: true schema: - $ref: '#/definitions/CreateGcsCredentialRequest' + $ref: '#/definitions/CreateAbfsClientKeyCredentialRequest' responses: 200: description: Describes a successful response to a valid request. schema: - $ref: '#/definitions/CreateGcsCredentialResponse' + $ref: '#/definitions/CreateAbfsClientKeyCredentialResponse' default: description: The default response on an error. schema: $ref: '#/definitions/Error' - /api/v1/replicationmanager/updateGcsCredential: + /api/v1/replicationmanager/updateAbfsClientKeyCredential: post: - summary: Update a GCS Cloud Credential. - description: Updates an existing GCS cloud credential. - operationId: updateGcsCredential + summary: Update an Azure Active Directory Service Principal account in Cloudera Manager. + description: Updates an existing Azure Active Directory Service Principal account in Cloudera Manager. + operationId: updateAbfsClientKeyCredential x-mutating: true parameters: - name: input in: body required: true schema: - $ref: '#/definitions/UpdateGcsCredentialRequest' + $ref: '#/definitions/UpdateAbfsClientKeyCredentialRequest' responses: 200: description: Describes a successful response to a valid request. schema: - $ref: '#/definitions/UpdateGcsCredentialResponse' + $ref: '#/definitions/UpdateAbfsClientKeyCredentialResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' + /api/v1/replicationmanager/createGcsPrivateKeyCredential: + post: + summary: Create a GCS Private Key cloud credential. + description: Creates a new GCS Private Key cloud credential. + operationId: createGcsPrivateKeyCredential + x-mutating: true + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/CreateGcsPrivateKeyCredentialRequest' + responses: + 200: + description: Describes a successful response to a valid request. + schema: + $ref: '#/definitions/CreateGcsPrivateKeyCredentialResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' + /api/v1/replicationmanager/updateGcsPrivateKeyCredential: + post: + summary: Update a GCS Private Key cloud credential. + description: Updates an existing GCS Private Key cloud credential. + operationId: updateGcsPrivateKeyCredential + x-mutating: true + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/UpdateGcsPrivateKeyCredentialRequest' + responses: + 200: + description: Describes a successful response to a valid request. + schema: + $ref: '#/definitions/UpdateGcsPrivateKeyCredentialResponse' default: description: The default response on an error. schema: @@ -1105,19 +1273,121 @@ definitions: type: array items: $ref: '#/definitions/ApiError' - UpdateAwsCredentialRequest: + CreateAwsIdbrokerCredentialRequest: + type: object + description: Request object for creating AWS IDBroker cloud credentials. + required: + - clusters + - name + - idbrokerAddress + - idbrokerCabPath + properties: + clusters: + description: List of cluster CRNs where the credential should be created. + type: array + items: + type: string + x-sensitive: false + name: + description: Name of the credential. + type: string + x-sensitive: false + idbrokerAddress: + description: The address of the IDBroker endpoint that will be used for authentication, for example http(s)://[IDBROKER_HOST]:[IDBROKER_PORT]/gateway. + type: string + x-sensitive: false + x-no-paramfile: true + idbrokerCabPath: + description: The name of the IDBroker topology that will be used for authentication. + type: string + x-sensitive: false + CreateAwsIdbrokerCredentialResponse: + type: object + description: Response object for creating AWS IDBroker cloud credentials. + properties: + errors: + description: The list of response errors in case of a partial failure while creating the credential. + type: array + items: + $ref: '#/definitions/ApiError' + UpdateAwsIdbrokerCredentialRequest: type: object - description: Request object for updating AWS cloud credentials. + description: Request object for updating AWS IdBroker cloud credentials. required: - name - - type + - idbrokerAddress + - idbrokerCabPath properties: name: description: Name of the credential to update. type: string - type: - description: 'Type of the credential. Additional accepted parameters by type: IAM: none; ACCESSKEY: accessKey, secretKey. Superfluous parameters are ignored.' - $ref: '#/definitions/AwsCloudCredentialType' + x-sensitive: false + idbrokerAddress: + description: The address of the IDBroker endpoint that will be used for authentication, for example http(s)://[IDBROKER_HOST]:[IDBROKER_PORT]/gateway. + type: string + x-sensitive: false + x-no-paramfile: true + idbrokerCabPath: + description: The name of the IDBroker topology that will be used for authentication. + type: string + x-sensitive: false + UpdateAwsIdbrokerCredentialResponse: + type: object + description: Response object for updating AWS IdBroker cloud credentials. + properties: + errors: + description: The list of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters). + type: array + items: + $ref: '#/definitions/ApiError' + CreateAwsAccessKeyCredentialRequest: + type: object + description: Request object for creating AWS Access Key cloud credentials. + required: + - clusters + - name + - accessKey + - secretKey + properties: + clusters: + description: List of cluster CRNs where the credential should be created. + type: array + items: + type: string + x-sensitive: false + name: + description: Name of the credential. + type: string + x-sensitive: false + accessKey: + description: AWS access key. + type: string + x-sensitive: true + secretKey: + description: AWS secret key. + type: string + x-sensitive: true + CreateAwsAccessKeyCredentialResponse: + type: object + description: Response object for creating AWS Access Key cloud credentials. + properties: + errors: + description: The list of response errors in case of a partial failure while creating the credential. + type: array + items: + $ref: '#/definitions/ApiError' + UpdateAwsAccessKeyCredentialRequest: + type: object + description: Request object for updating AWS Access Key cloud credentials. + required: + - name + - accessKey + - secretKey + properties: + name: + description: Name of the credential to update. + type: string + x-sensitive: false accessKey: description: AWS access key. type: string @@ -1126,9 +1396,54 @@ definitions: description: AWS secret key. type: string x-sensitive: true - UpdateAwsCredentialResponse: + UpdateAwsAccessKeyCredentialResponse: type: object - description: Response object for updating AWS credentials. + description: Response object for updating AWS Access Key cloud credentials. + properties: + errors: + description: The list of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters). + type: array + items: + $ref: '#/definitions/ApiError' + CreateAwsIamCredentialRequest: + type: object + description: Request object for creating AWS IAM Role based cloud credentials. + required: + - clusters + - name + properties: + clusters: + description: List of cluster CRNs where the credential should be created. + type: array + items: + type: string + x-sensitive: false + name: + description: Name of the credential. + type: string + x-sensitive: false + CreateAwsIamCredentialResponse: + type: object + description: Response object for creating AWS IAM Role based cloud credentials. + properties: + errors: + description: The list of response errors in case of a partial failure while creating the credential. + type: array + items: + $ref: '#/definitions/ApiError' + UpdateAwsIamCredentialRequest: + type: object + description: Request object for updating AWS IAM Role based cloud credentials. + required: + - name + properties: + name: + description: Name of the credential to update. + type: string + x-sensitive: false + UpdateAwsIamCredentialResponse: + type: object + description: Response object for updating AWS IAM Role based cloud credentials. properties: errors: description: The list of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters). @@ -1180,19 +1495,53 @@ definitions: type: array items: $ref: '#/definitions/ApiError' - UpdateAbfsCredentialRequest: + CreateAbfsAccessKeyCredentialRequest: type: object - description: Request object for updating ABFS cloud credentials. + description: Request object for creating ABFS Access Key based accounts in DLM Engine. required: + - clusters - name - - type + - accessKey + - storageAccountName + properties: + clusters: + description: List of cluster CRNs where the credential should be created. + type: array + items: + type: string + x-sensitive: false + name: + description: Name of the credential. + type: string + x-sensitive: false + accessKey: + description: ABFS access key. + type: string + x-sensitive: true + storageAccountName: + description: ABFS storage account name. + type: string + CreateAbfsAccessKeyCredentialResponse: + type: object + description: Response object for creating ABFS Access Key based accounts in DLM Engine. + properties: + errors: + description: The list of response errors in case of a partial failure while creating the credential. + type: array + items: + $ref: '#/definitions/ApiError' + UpdateAbfsAccessKeyCredentialRequest: + type: object + description: Request object for updating ABFS Access Key based accounts in DLM Engine. + required: + - name + - accessKey + - storageAccountName properties: name: description: Name of the credential to update. type: string - type: - description: 'Type of the credential. Additional accepted parameters by type: ACCESSKEY: storageAccountName, accessKey; CLIENTKEY: clientId, clientSecretKey, tenantId. Superfluous parameters are ignored. ACCESSKEY is only supported on Ambari, while CLIENTKEY is only supported on Cloudera Manager.' - $ref: '#/definitions/AbfsCloudCredentialType' + x-sensitive: false accessKey: description: ABFS access key. type: string @@ -1200,6 +1549,35 @@ definitions: storageAccountName: description: ABFS storage account name. type: string + UpdateAbfsAccessKeyCredentialResponse: + type: object + description: Response object for updating ABFS Access Key based accounts in DLM Engine. + properties: + errors: + description: The list of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters). + type: array + items: + $ref: '#/definitions/ApiError' + CreateAbfsClientKeyCredentialRequest: + type: object + description: Request object for creating Azure Active Directory Service Principal accounts in Cloudera Manager. + required: + - clusters + - name + - clientId + - clientSecretKey + - tenantId + properties: + clusters: + description: List of cluster CRNs where the credential should be created. + type: array + items: + type: string + x-sensitive: false + name: + description: Name of the credential. + type: string + x-sensitive: false clientId: description: Client ID of an Active Directory service principal account. type: string @@ -1210,34 +1588,67 @@ definitions: tenantId: description: Tenant ID of an Active Directory service principal account. type: string - UpdateAbfsCredentialResponse: + CreateAbfsClientKeyCredentialResponse: type: object - description: Response object for updating ABFS credentials. + description: Response object for creating Azure Active Directory Service Principal accounts in Cloudera Manager. properties: errors: - description: List of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters). + description: The list of response errors in case of a partial failure while creating the credential. type: array items: $ref: '#/definitions/ApiError' - CreateGcsCredentialRequest: + UpdateAbfsClientKeyCredentialRequest: type: object - description: Request object for creating GCS cloud credentials. + description: Request object for updating Azure Active Directory Service Principal accounts in Cloudera Manager. required: - name - - clusters - - type + - clientId + - clientSecretKey + - tenantId properties: name: - description: Name of the credential. + description: Name of the credential to update. + type: string + x-sensitive: false + clientId: + description: Client ID of an Active Directory service principal account. + type: string + clientSecretKey: + description: Client Key of an Active Directory service principal account. + type: string + x-sensitive: true + tenantId: + description: Tenant ID of an Active Directory service principal account. type: string + UpdateAbfsClientKeyCredentialResponse: + type: object + description: Response object for updating Azure Active Directory Service Principal accounts in Cloudera Manager. + properties: + errors: + description: The list of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters). + type: array + items: + $ref: '#/definitions/ApiError' + CreateGcsPrivateKeyCredentialRequest: + type: object + description: Request object for creating GCS Private Key cloud credentials. + required: + - clusters + - name + - clientEmail + - privateKeyId + - privateKey + properties: clusters: description: List of cluster CRNs where the credential should be created. type: array items: type: string - type: - description: 'Type of the credential. Additional accepted parameters by type: PRIVATEKEY: clientEmail, privateKeyId, privateKey. Superfluous parameters are ignored.' - $ref: '#/definitions/GcsCloudCredentialType' + x-sensitive: false + name: + description: Name of the credential. + type: string + x-sensitive: false clientEmail: description: Client email. type: string @@ -1248,28 +1659,28 @@ definitions: description: GCS private key. type: string x-sensitive: true - CreateGcsCredentialResponse: + CreateGcsPrivateKeyCredentialResponse: type: object - description: Response object for creating GCS credentials. + description: Response object for creating GCS Private Key cloud credentials. properties: errors: description: The list of response errors in case of a partial failure while creating the credential. type: array items: $ref: '#/definitions/ApiError' - UpdateGcsCredentialRequest: + UpdateGcsPrivateKeyCredentialRequest: type: object - description: Request object for updating GCS cloud credentials. + description: Request object for updating GCS Private Key cloud credentials. required: - name - - type + - clientEmail + - privateKeyId + - privateKey properties: name: description: Name of the credential to update. type: string - type: - description: 'Type of the credential. Additional accepted parameters by type: PRIVATEKEY: clientEmail, privateKeyId, privateKey. Superfluous parameters are ignored.' - $ref: '#/definitions/GcsCloudCredentialType' + x-sensitive: false clientEmail: description: Client email. type: string @@ -1280,12 +1691,12 @@ definitions: description: GCS private key. type: string x-sensitive: true - UpdateGcsCredentialResponse: + UpdateGcsPrivateKeyCredentialResponse: type: object - description: Response object for updating GCS credentials. + description: Response object for updating GCS Private Key cloud credentials. properties: errors: - description: List of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters). + description: The list of response errors in case of partial failure (e.g. updating the credential failed on one of three clusters). type: array items: $ref: '#/definitions/ApiError' @@ -1400,6 +1811,19 @@ definitions: DeletePolicyResponse: type: object description: Response object for deletePolicy. + 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. CreatePolicyRequest: type: object description: Create a replication policy. @@ -1420,6 +1844,19 @@ definitions: CreatePolicyResponse: type: object description: Response object for createPolicy. + 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. UpdatePolicyRequest: type: object description: Update a replication policy request. @@ -1506,6 +1943,19 @@ definitions: UpdatePolicyResponse: type: object description: Response object for updatePolicy. + 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). CreateHbasePolicyRequest: type: object description: Create an HBase replication policy. @@ -2003,6 +2453,19 @@ definitions: SuspendPolicyResponse: type: object description: Response object for suspendPolicy. + 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. ActivatePolicyRequest: type: object description: Activate a replication policy. @@ -2019,6 +2482,19 @@ definitions: ActivatePolicyResponse: type: object description: Response object for resumePolicy. + 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. DownloadDiagnosticBundleRequest: type: object description: Request to download the diagnostic bundle for the given cluster and command id. @@ -2794,6 +3270,9 @@ definitions: target: description: Replication target details. $ref: '#/definitions/TargetDetails' + cmPolicySubmitUser: + description: CM policy submit user. + $ref: '#/definitions/CmPolicySubmitUserResponse' PolicyInstanceResponse: type: object description: Policy execution details. @@ -3166,6 +3645,16 @@ definitions: sourceUser: description: Source user. type: string + CmPolicySubmitUserResponse: + type: object + description: The user that the replication policy uses to perform operations on the source or target cluster. + properties: + userName: + description: Username. + type: string + sourceUser: + description: Source user. + type: string HbasePolicyDefinition: type: object description: HBase policy definition. @@ -3187,6 +3676,9 @@ definitions: 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 + exportSnapshotUser: + description: If set, the user specified by this parameter will be used to export the initial snapshot on the source. + type: string description: description: Description of the policy. type: string @@ -3299,11 +3791,6 @@ definitions: enum: - ACCESSKEY - CLIENTKEY - GcsCloudCredentialType: - type: string - description: GCS cloud credential type. - enum: - - PRIVATEKEY SnapshotPolicyType: type: string description: The snapshot type of snapshot policies.