Account ID to authorize access for PrivateLink.
+AWS account ID to authorize access for PrivateLink.
From 70a3ba195fe6a2cc18b792489f5f97eb19d7e659 Mon Sep 17 00:00:00 2001
From: SRE Service Version : 0.9.125 (BETA) Version : 0.9.126 (BETA) Version : 0.9.125 (BETA) Version : 0.9.126 (BETA) Account ID to authorize access for PrivateLink. AWS account ID to authorize access for PrivateLink. string cloudServiceProvider Cloud Service Provider. Currently supporting AWS and AZURE. region string subscriptionId Azure subscription ID to authorize access for PrivateLink. string Account ID to revoke access for PrivateLink. AWS account ID to authorize access for PrivateLink. string cloudServiceProvider Cloud Service Provider. Currently supporting AWS and AZURE. region string subscriptionId Azure subscription ID to authorize access for PrivateLink. string Version : 0.9.125 (BETA) Version : 0.9.126 (BETA) The KMS key ARN used. AWS KMS key ARN. string enabled Flag to enable secret encryption (default true). Deprecated. booleanOverview
Version information
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
AuthorizePrivateLinkServiceAc
optional
AuthorizePrivateLinkServiceAc
+
+
+optional
+
+
+
+
@@ -1556,6 +1568,18 @@
optionalAuthorizePrivateLinkServiceAc
+
+
+optional
+
+RevokePrivateLinkServiceAccessRe
optional
RevokePrivateLinkServiceAccessRe
+
+
+optional
+
+
+
+
@@ -2622,6 +2658,18 @@
optionalRevokePrivateLinkServiceAccessRe
+
+
+optional
+
+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
CommonSecretEncryption
optional
-
-
@@ -5267,24 +5255,12 @@
-
-optional
-
-CommonSecretEncryptionResp
optional
The KMS key ARN used.
+AWS KMS key ARN.
string
enabled
-optional
Flag to indicate if secret encryption is enabled.
-boolean
-The KMS key ARN used.
+AWS KMS key ARN.
string
@@ -10100,7 +10076,7 @@Version : 0.9.125 (BETA)
+Version : 0.9.126 (BETA)
Version : 0.9.125 (BETA)
+Version : 0.9.126 (BETA)
Version : 0.9.125 (BETA)
+Version : 0.9.126 (BETA)
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 @@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 @@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 @@Version : 0.9.125 (BETA)
+Version : 0.9.126 (BETA)
Version : 0.9.125 (BETA)
+Version : 0.9.126 (BETA)
Version : 0.9.125 (BETA)
+Version : 0.9.126 (BETA)
Version : 0.9.125 (BETA)
+Version : 0.9.126 (BETA)
Version : 0.9.125 (BETA)
+Version : 0.9.126 (BETA)
Version : 0.9.125 (BETA)
+Version : 0.9.126 (BETA)
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 : ""
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 : ""
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 : ""
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 @@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 @@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 @@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 @@Version : 0.9.125 (BETA)
+Version : 0.9.126 (BETA)
POST /api/v1/environments2/lastSyncStatus+
Returns status of the sync operation for the environment based on crn.
+Type | +Name | +Schema | +
---|---|---|
+ Body + |
+
+ input |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
+ 200 + |
+
+ Expected response to a valid request. + |
++ |
+ default + |
+
+ The default response on an error. + |
+
+
+ |
+
Lists audit credentials.
- 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 @@Environmentoptional |
- 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.
InitializeAzureComputeClusterRequest@@ -20075,9 +20195,34 @@InitializeAzureComputeClusterRes
Response object for an initialize Azure default compute cluster request.
InstanceTemplate@@ -20196,6 +20341,158 @@LastAutomatedSyncDetails |
Type : object
-Type : object
-Request object for Sync Status.
+Name | +Description | +Schema | +
---|---|---|
+ envNameOrCrn |
+
+ Name or Crn of the environment. + |
+
+ string + |
+
Response object for Sync Operation.
+Name | +Description | +Schema | +
---|---|---|
+ endDate |
+
+ Date when the sync operation ended. Omitted if operation has not ended. + |
+
+ string (date-time) + |
+
+ error |
+
+ 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 |
+
+ List of sync operation details for all failed environments. + |
+
+ < SyncOperationDetails > array + |
+
+ operationId |
+
+ UUID of the request for this operation. This Id can be used for geting status on the operation. + |
+
+ string + |
+
+ operationType |
+
+ Operation type, set password or user sync + |
++ |
+ startDate |
+
+ Date when the sync operation started. + |
+
+ string (date-time) + |
+
+ status |
+
+ Status of this operation. Status can be one of these values (REQUESTED, RUNNING, COMPLETED, FAILED, REJECTED, TIMEDOUT) + |
+
+
+ |
+
+ success |
+
+ List of sync operation details for all succeeded environments. + |
+
+ < SyncOperationDetails > array + |
+
Request object for a list audit credentials request.
@@ -25987,7 +26284,7 @@Version : 0.9.125 (BETA)
+Version : 0.9.126 (BETA)
Version : 0.9.125 (BETA)
+Version : 0.9.126 (BETA)
Version : 0.9.125 (BETA)
+Version : 0.9.126 (BETA)
Version : 0.9.125 (BETA)
+Version : 0.9.126 (BETA)
Version : 0.9.125 (BETA)
+Version : 0.9.126 (BETA)
Version : 0.9.125 (BETA)
+Version : 0.9.126 (BETA)
POST /api/v1/replicationmanager/createAbfsCredential+
POST /api/v1/replicationmanager/createAbfsAccessKeyCredential
Creates a new ABFS cloud credential.
+Creates a new ABFS Access Key based account in DLM Engine.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/createAwsCredential+
POST /api/v1/replicationmanager/createAbfsClientKeyCredential
Creates a new AWS cloud credential.
+Creates a new Azure Active Directory Service Principal account in Cloudera Manager.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/createGcsCredential+
POST /api/v1/replicationmanager/createAbfsCredential
Creates a new GCS cloud credential.
+Creates a new ABFS cloud credential.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/createHbasePolicy+
POST /api/v1/replicationmanager/createAwsAccessKeyCredential
Creates a new HBase replication policy with the given name on a specific cluster.
+Creates a new AWS Access Key cloud credential.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/createPolicy+
POST /api/v1/replicationmanager/createAwsCredential
Creates a new replication policy with the given name on a specific cluster.
+Creates a new AWS cloud credential.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/createSnapshotPolicy+
POST /api/v1/replicationmanager/createAwsIamCredential
Creates a snapshot policy.
+Creates a new AWS IAM Role based cloud credential.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/deleteCredential+
POST /api/v1/replicationmanager/createAwsIdbrokerCredential
Permanently deletes a specific cloud credential.
+Creates a new AWS IDBroker cloud credential.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/deleteHbasePolicy+
POST /api/v1/replicationmanager/createGcsPrivateKeyCredential
Permanently deletes a specific HBase replication policy.
+Creates a new GCS Private Key cloud credential.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/deletePolicy+
POST /api/v1/replicationmanager/createHbasePolicy
Permanently deletes a specific replication policy.
+Creates a new HBase replication policy with the given name on a specific cluster.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/deleteSnapshotPolicy+
POST /api/v1/replicationmanager/createPolicy
Permanently deletes a specific snapshot policy.
+Creates a new replication policy with the given name on a specific cluster.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/downloadDiagnosticBundle+
POST /api/v1/replicationmanager/createSnapshotPolicy
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.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/getClusterConfig+
POST /api/v1/replicationmanager/deleteCredential
Retrieves configuration of a specific cluster.
+Permanently deletes a specific cloud credential.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/getCommandStatus+
POST /api/v1/replicationmanager/deleteHbasePolicy
Return the current status of the given CM command.
+Permanently deletes a specific HBase replication policy.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/getCredentials+
POST /api/v1/replicationmanager/deletePolicy
Returns cloud credentials on a specific cluster.
+Permanently deletes a specific replication policy.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/getHbaseTimeSeries+
POST /api/v1/replicationmanager/deleteSnapshotPolicy
Returns time series data for an HBase replication peer based on the provided parameters.
+Permanently deletes a specific snapshot policy.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/getSnapshotPolicy+
POST /api/v1/replicationmanager/downloadDiagnosticBundle
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.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/listAllCredentials+
POST /api/v1/replicationmanager/getClusterConfig
Provides a detailed list of cloud credentials across all available clusters.
+Retrieves configuration of a specific cluster.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/listClusterServiceStatuses+
POST /api/v1/replicationmanager/getCommandStatus
Provides a list of cluster service (e.g. HDFS, Hive, YARN, etc.) statuses.
+Return the current status of the given CM command.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/listClusters+
POST /api/v1/replicationmanager/getCredentials
Provides a detailed list of all available clusters.
+Returns cloud credentials on a specific cluster.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/listPairedHbaseClusters+
POST /api/v1/replicationmanager/getHbaseTimeSeries
Provides a list of cluster CRNs with active HBase policies.
+Returns time series data for an HBase replication peer based on the provided parameters.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/listPolicies+
POST /api/v1/replicationmanager/getSnapshotPolicy
Provides a list of all replication policies across all available clusters.
+Retrieves a specific snapshot policy from the cluster specified in the request.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/listPolicyJobs+
POST /api/v1/replicationmanager/listAllCredentials
Returns a list of jobs triggered by a replication policy.
+Provides a detailed list of cloud credentials across all available clusters.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/listSnapshotPolicies+
POST /api/v1/replicationmanager/listClusterServiceStatuses
Provides a list of all snapshot policies across all available clusters.
+Provides a list of cluster service (e.g. HDFS, Hive, YARN, etc.) statuses.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/listSnapshotPolicyJobs+
POST /api/v1/replicationmanager/listClusters
Lists jobs triggered by a snapshot policy.
+Provides a detailed list of all available clusters.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/repairHbasePolicy+
POST /api/v1/replicationmanager/listPairedHbaseClusters
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.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/rerunPolicy+
POST /api/v1/replicationmanager/listPolicies
Instantly starts a new job of a provided policy.
+Provides a list of all replication policies across all available clusters.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/restoreSnapshot+
POST /api/v1/replicationmanager/listPolicyJobs
Restores a specific snapshot.
+Returns a list of jobs triggered by a replication policy.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/retryFailedHbaseFirstTimeSetup+
POST /api/v1/replicationmanager/listSnapshotPolicies
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.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/retryFailedHbaseSnapshots+
POST /api/v1/replicationmanager/listSnapshotPolicyJobs
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.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/suspendHbasePolicy+
POST /api/v1/replicationmanager/repairHbasePolicy
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.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/suspendPolicy+
POST /api/v1/replicationmanager/rerunPolicy
Stops all replication tasks defined by the policy. Replication will resume after activating the policy.
+Instantly starts a new job of a provided policy.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/suspendSnapshotPolicy+
POST /api/v1/replicationmanager/restoreSnapshot
Suspends a specific snapshot policy.
+Restores a specific snapshot.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/updateAbfsCredential+
POST /api/v1/replicationmanager/retryFailedHbaseFirstTimeSetup
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.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/updateAwsCredential+
POST /api/v1/replicationmanager/retryFailedHbaseSnapshots
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.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/updateGcsCredential+
POST /api/v1/replicationmanager/suspendHbasePolicy
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.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/updateHbasePolicy+
POST /api/v1/replicationmanager/suspendPolicy
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.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/updatePolicy+
POST /api/v1/replicationmanager/suspendSnapshotPolicy
Updates an existing replication policy with the given parameters on a specific cluster.
+Suspends a specific snapshot policy.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/updateSnapshotPolicy+
POST /api/v1/replicationmanager/updateAbfsAccessKeyCredential
Updates a snapshot policy.
+Updates an existing ABFS Access Key based account in DLM Engine.
Describes a successful response to a valid request.
POST /api/v1/replicationmanager/verifyHbaseClusterPair+
POST /api/v1/replicationmanager/updateAbfsClientKeyCredential
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.
Describes a successful response to a valid request.
ABFS cloud credential type.
-Type : enum (ACCESSKEY, CLIENTKEY)
+POST /api/v1/replicationmanager/updateAwsAccessKeyCredential
Request object for abortPolicy.
+Updates an existing AWS Access Key cloud credential.
+Type | Name | -Description | Schema |
---|---|---|---|
- clusterCrn |
-
- The CRN of the cluster where the replication policy is. - |
-
- string +Body |
-|
- policyId input |
- The ID of the policy. - |
-
- string + |
Response object for abortPolicy.
-Name | +HTTP Code | Description | Schema |
---|---|---|---|
- clusterCrn |
-
- The CRN of the input cluster. - |
-
- string - |
-|
- message 200 |
- The detailed description of the action taken. +Describes a successful response to a valid request. |
- string + |
|
- requestId default |
- The ID of the request. Populated only for Ambari backend. +The default response on an error. |
- string + |
|
- status |
+
POST /api/v1/replicationmanager/updateAwsIamCredential+
Updates an existing AWS IAM Role based cloud credential.
+Type | +Name | +Schema | +
---|---|---|
+ Body + |
+
+ input |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
+ 200 + |
+
+ Describes a successful response to a valid request. + |
++ |
+ default + |
+
+ The default response on an error. + |
+
+
+ |
+
POST /api/v1/replicationmanager/updateAwsIdbrokerCredential+
Updates an existing AWS IDBroker cloud credential.
+Type | +Name | +Schema | +
---|---|---|
+ Body + |
+
+ input |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
+ 200 + |
+
+ Describes a successful response to a valid request. + |
++ |
+ default + |
+
+ The default response on an error. + |
+
+
+ |
+
POST /api/v1/replicationmanager/updateGcsPrivateKeyCredential+
Updates an existing GCS Private Key cloud credential.
+Type | +Name | +Schema | +
---|---|---|
+ Body + |
+
+ input |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
+ 200 + |
+
+ Describes a successful response to a valid request. + |
++ |
+ default + |
+
+ The default response on an error. + |
+
+
+ |
+
POST /api/v1/replicationmanager/updateHbasePolicy+
Updates an existing HBase replication policy with the given parameters on a specific cluster.
+Type | +Name | +Schema | +
---|---|---|
+ Body + |
+
+ input |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
+ 200 + |
+
+ Describes a successful response to a valid request. + |
++ |
+ default + |
+
+ The default response on an error. + |
+
+
+ |
+
POST /api/v1/replicationmanager/updatePolicy+
Updates an existing replication policy with the given parameters on a specific cluster.
+Type | +Name | +Schema | +
---|---|---|
+ Body + |
+
+ input |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
+ 200 + |
+
+ Describes a successful response to a valid request. + |
++ |
+ default + |
+
+ The default response on an error. + |
+
+
+ |
+
POST /api/v1/replicationmanager/updateSnapshotPolicy+
Updates a snapshot policy.
+Type | +Name | +Schema | +
---|---|---|
+ Body + |
+
+ input |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
+ 200 + |
+
+ Describes a successful response to a valid request. + |
++ |
+ default + |
+
+ The default response on an error. + |
+
+
+ |
+
POST /api/v1/replicationmanager/verifyHbaseClusterPair+
Returns whether the cluster pair is ready for policy creation, or if there are some manual steps that need to be performed before.
+Type | +Name | +Schema | +
---|---|---|
+ Body + |
+
+ input |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
+ 200 + |
+
+ Describes a successful response to a valid request. + |
++ |
+ default + |
+
+ The default response on an error. + |
+
+
+ |
+
ABFS cloud credential type.
+Type : enum (ACCESSKEY, CLIENTKEY)
+Request object for abortPolicy.
+Name | +Description | +Schema | +
---|---|---|
+ clusterCrn |
+
+ The CRN of the cluster where the replication policy is. + |
+
+ string + |
+
+ policyId |
+
+ The ID of the policy. + |
+
+ string + |
+
Response object for abortPolicy.
+Name | +Description | +Schema | +
---|---|---|
+ clusterCrn |
+
+ The CRN of the input cluster. + |
+
+ string + |
+
+ message |
+
+ The detailed description of the action taken. + |
+
+ string + |
+
+ requestId |
+
+ The ID of the request. Populated only for Ambari backend. + |
+
+ string + |
+
+ status |
+
+ The status of the request. + |
+
+ string + |
+
Activate an HBase replication policy.
+Name | +Description | +Schema | +
---|---|---|
+ clusterCrn |
+
+ CRN of the destination cluster. + |
+
+ string + |
+
+ policyId |
+
+ ID of the HBase policy. + |
+
+ string + |
+
Response object for activateHbasePolicy.
+Name | +Description | +Schema | +
---|---|---|
+ clusterCrn |
+
+ The CRN of the input cluster. + |
+
+ string + |
+
+ message |
+
+ The detailed description of the action taken. + |
+
+ string + |
+
+ status |
+
+ The status of the request. + |
+
+ string + |
+
Activate a replication policy.
+Name | +Description | +Schema | +
---|---|---|
+ clusterCrn |
+
+ CRN of the cluster where the policy is. + |
+
+ string + |
+
+ policyName |
+
+ Policy name to resume. + |
+
+ string + |
+
Response object for resumePolicy.
+Name | +Description | +Schema | +
---|---|---|
+ clusterCrn |
+
+ The CRN of the input cluster. + |
+
+ string + |
+
+ message |
+
+ The detailed description of the action taken. + |
+
+ string + |
+
+ requestId |
+
+ The ID of the request. Populated only for Ambari backend. + |
+
+ string + |
+
+ status |
+
+ The status of the request. + |
+
+ string + |
+
Request object for activateSnapshotPolicy.
+Name | +Description | +Schema | +
---|---|---|
+ clusterCrn |
+
+ CRN of the cluster where the snapshot policy is. + |
+
+ string + |
+
+ name |
+
+ The name of the snapshot policy to be resumed. + |
+
+ string + |
+
Response object for activateSnapshotPolicy.
+Name | +Description | +Schema | +
---|---|---|
+ clusterCrn |
+
+ CRN of the cluster where the snapshot policy is. + |
+
+ string + |
+
+ message |
+
+ The detailed description of the action taken. + |
+
+ string + |
+
+ status |
+
+ The status of the request. + |
+
+ string + |
+
Cloudera Manager alerting behavior.
+Name | +Description | +Schema | +
---|---|---|
+ onAbort |
+
+ Alert on abort. + |
+
+ boolean + |
+
+ onFailure |
+
+ Alert on failure. + |
+
+ boolean + |
+
+ onStart |
+
+ Alert on start. + |
+
+ boolean + |
+
+ onSuccess |
+
+ ALert on success. + |
+
+ boolean + |
+
API error.
+Name | +Description | +Schema | +
---|---|---|
+ clusterUrl |
+
+ Cluster URL. + |
+
+ string + |
+
+ code |
+
+ Error code. + |
+
+ integer (int32) + |
+
+ message |
+
+ Error message. + |
+
+ string + |
+
+ requestId |
+
+ Request ID. + |
+
+ string + |
+
+ status |
+
+ Error status. + |
+
+ string + |
+
AWS cloud credential type.
+Type : enum (IAM, ACCESSKEY)
+Describes a Datalake, Datahub or Classic cluster.
+Name | +Description | +Schema | +
---|---|---|
+ cloudAccountProvider |
+
+ Cloud account provider. + |
+
+ enum (AWS, ADLS, WASB, ABFS, GCS) + |
+
+ clusterManagerType |
+
+ Cluster Manager type. + |
+
+ enum (CLOUDERA_MANAGER, AMBARI) + |
+
+ clusterManagerUrl |
+
+ Cluster Manager URL. + |
+
+ string + |
+
+ clusterType |
+
+ Cluster type. + |
+
+ enum (CLASSIC, SDX, DISTROX) + |
+
+ clusterUrl |
+
+ Cluster URL. + |
+
+ string + |
+
+ cmName |
+
+ Cloudera Manager name. + |
+
+ string + |
+
+ codProperties |
+
+ Additional properties for operational databases. + |
++ |
+ crn |
+
+ Cluster CRN. + |
+
+ string + |
+
+ dataCenter |
+
+ Cluster data center. + |
+
+ string + |
+
+ description |
+
+ Cluster description. + |
+
+ string + |
+
+ environmentCrn |
- The status of the request. +CRN of the cluster’s environment. |
string |
Activate an HBase replication policy.
-Name | -Description | -Schema | +
+ knoxUrl |
+
+ Knox URL if the cluster was registered with one, null otherwise. + |
+
+ string + |
---|---|---|---|---|---|
- clusterCrn location |
- CRN of the destination cluster. +Cluster location. |
- string + |
|||
- policyId name |
- ID of the HBase policy. +Cluster name. |
string |
Response object for activateHbasePolicy.
-Name | -Description | -Schema | +
+ replicationEngineType |
+
+ Replication engine type. + |
+
+ enum (CM, DLM_ENGINE) + |
---|---|---|---|---|---|
- clusterCrn stackCrn |
- The CRN of the input cluster. +Stack CRN. |
string @@ -5302,11 +6681,11 @@ActivateHbasePolicyResponse | |||
- message stackMajorVersion |
- The detailed description of the action taken. +Stack major version. |
string @@ -5314,57 +6693,35 @@ActivateHbasePolicyResponse | |||
- status stackVersion |
- The status of the request. +Stack version. |
string |
Activate a replication policy.
-Name | -Description | -Schema | -
---|---|---|
- clusterCrn totalHosts |
- CRN of the cluster where the policy is. +Total hosts on the cluster. |
- string +integer (int32) |
- policyName uuid |
- Policy name to resume. +Cluster UUID from Cloudera Manager if the cluster has CM backend. |
string @@ -5374,18 +6731,9 @@ActivatePolicyRequest |
Response object for resumePolicy.
-Type : object
-Request object for activateSnapshotPolicy.
+Describes the status of services running on a cluster.
- CRN of the cluster where the snapshot policy is. +Cluster CRN. |
string @@ -5415,23 +6763,23 @@ActivateSnapshotPolicyRequest
- name serviceStatuses
- The name of the snapshot policy to be resumed. +List of service statuses.
- string +< ServiceInfo > array |
Response object for activateSnapshotPolicy.
+CM Policy submit user.
- clusterCrn |
-
- CRN of the cluster where the snapshot policy is. - |
-
- string - |
-
- message sourceUser |
- The detailed description of the action taken. +Source user. |
string @@ -5473,11 +6809,11 @@ActivateSnapshotPolicyResponse |
- status userName |
- The status of the request. +Username. |
string @@ -5487,9 +6823,9 @@ActivateSnapshotPolicyResponse |
Cloudera Manager alerting behavior.
+The user that the replication policy uses to perform operations on the source or target cluster.
- onAbort |
-
- Alert on abort. - |
-
- boolean - |
-
- onFailure |
-
- Alert on failure. - |
-
- boolean - |
-
- onStart sourceUser |
- Alert on start. +Source user. |
- boolean +string |
- onSuccess userName |
- ALert on success. +Username. |
- boolean +string |
API error.
+Additional properties for operational databases.
- clusterUrl operationalDatabaseName |
- Cluster URL. +Name of the corresponding operational database.. |
string |
Triggers a diagnostic bundle collect command for the given cluster and policyName.
+
- code |
-
- Error code. - |
-
- integer (int32) - |
-|||
- message |
-
- Error message. - |
-
- string - |
+Name | +Description | +Schema |
---|---|---|---|---|---|
- requestId clusterCrn |
- Request ID. +The CRN of the target cluster. |
string @@ -5625,11 +6935,11 @@ApiError | |||
- status policyName |
- Error status. +Name of the policy. |
string @@ -5639,18 +6949,9 @@ApiError |
AWS cloud credential type.
-Type : enum (IAM, ACCESSKEY)
-Describes a Datalake, Datahub or Classic cluster.
+Response object for collect-diagnostic-bundle.
- cloudAccountProvider active |
- Cloud account provider. +Whether the diagnostic bundle command is active. |
- enum (AWS, ADLS, WASB, ABFS, GCS) +boolean |
- clusterManagerType commandId |
- 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 name |
- Cluster Manager URL. +Name of the policy. |
string @@ -5704,23 +7005,11 @@Cluster |
- clusterType |
-
- Cluster type. - |
-
- enum (CLASSIC, SDX, DISTROX) - |
-
- clusterUrl resultMessage |
- Cluster URL. +Diagnostic bundle collection command result message. |
string @@ -5728,35 +7017,45 @@Cluster |
- cmName startTime |
- Cloudera Manager name. +Start time of the diagnostic bundle collection command. |
string |
Continue an HBase setup for Classic Cluster source.
+
- codProperties |
-
- Additional properties for operational databases. - |
-+ | Name | +Description | +Schema |
---|---|---|---|---|---|
- crn clusterCrn |
- Cluster CRN. +The CRN of the destination cluster. |
string @@ -5764,23 +7063,45 @@Cluster | |||
- dataCenter policyId |
- Cluster data center. +The ID of the HBase policy. |
string |
Response object for continueHbaseSetup.
+Name | +Description | +Schema | +
---|---|---|
- description clusterCrn |
- Cluster description. +The CRN of the input cluster. |
string @@ -5788,11 +7109,11 @@Cluster |
- environmentCrn message |
- CRN of the cluster’s environment. +The detailed description of the action taken. |
string @@ -5800,35 +7121,45 @@Cluster |
- knoxUrl status |
- Knox URL if the cluster was registered with one, null otherwise. +The status of the request. |
string |
Request object for creating ABFS Access Key based accounts in DLM Engine.
+
- location |
-
- Cluster location. - |
-
-
- |
+Name | +Description | +Schema |
---|---|---|---|---|---|
- name accessKey |
- Cluster name. +ABFS access key. |
string @@ -5836,35 +7167,23 @@Cluster | |||
- replicationEngineType clusters |
- Replication engine type. - |
-
- enum (CM, DLM_ENGINE) - |
-|||
- stackCrn |
-
- Stack CRN. +List of cluster CRNs where the credential should be created. |
- string +< string > array |
|||
- stackMajorVersion name |
- Stack major version. +Name of the credential. |
string @@ -5872,47 +7191,57 @@Cluster | |||
- stackVersion storageAccountName |
- Stack version. +ABFS storage account name. |
string |
Response object for creating ABFS Access Key based accounts in DLM Engine.
+
- totalHosts |
-
- Total hosts on the cluster. - |
-
- integer (int32) - |
+Name | +Description | +Schema |
---|---|---|---|---|---|
- uuid errors |
- 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 |
Describes the status of services running on a cluster.
+Request object for creating Azure Active Directory Service Principal accounts in Cloudera Manager.
- clusterCrn clientId |
- Cluster CRN. +Client ID of an Active Directory service principal account. |
string @@ -5942,45 +7271,35 @@ClusterServiceStatuses |
- serviceStatuses clientSecretKey |
- List of service statuses. +Client Key of an Active Directory service principal account. + |
+
+ string + |
+
+ clusters |
+
+ List of cluster CRNs where the credential should be created. |
- < ServiceInfo > array +< string > array |
CM Policy submit user.
-Name | -Description | -Schema | -
---|---|---|
- sourceUser name |
- Source user. +Name of the credential. |
string @@ -5988,11 +7307,11 @@CmPolicySubmitUser |
- userName tenantId |
- Username. +Tenant ID of an Active Directory service principal account. |
string @@ -6002,9 +7321,9 @@CmPolicySubmitUser |
Additional properties for operational databases.
+Response object for creating Azure Active Directory Service Principal accounts in Cloudera Manager.
- operationalDatabaseName errors |
- Name of the corresponding operational database.. +The list of response errors in case of a partial failure while creating the credential. |
- string +< ApiError > array |
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.
- clusterCrn accessKey |
- The CRN of the target cluster. +ABFS access key. |
string @@ -6068,69 +7387,47 @@CollectDiagnosticBundleRequest |
- policyName clientId |
- Name of the policy. +Client ID of an Active Directory service principal account. |
string |
Response object for collect-diagnostic-bundle.
-Name | -Description | -Schema | -
---|---|---|
- active clientSecretKey |
- Whether the diagnostic bundle command is active. +Client Key of an Active Directory service principal account. |
- boolean +string |
- commandId clusters |
- 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 |
- Name of the policy. +Name of the credential. |
string @@ -6138,11 +7435,11 @@CollectDiagnosticBundleResponse |
- resultMessage storageAccountName |
- Diagnostic bundle collection command result message. +ABFS storage account name. |
string @@ -6150,23 +7447,35 @@CollectDiagnosticBundleResponse |
- startTime tenantId |
- Start time of the diagnostic bundle collection command. +Tenant ID of an Active Directory service principal account. |
string |
+ type |
+
+ Type of the credential. Additional required parameters by type: ACCESSKEY: storageAccountName, accessKey; CLIENTKEY: clientId, clientSecretKey, tenantId. Superfluous parameters are ignored. Providing ACCESSKEY will create an ABFS Access Key based account in Ambari. Providing CLIENTKEY will create an Azure Active Directory Service Principal account in Cloudera Manager. ACCESSKEY is only supported on Ambari, while CLIENTKEY is only supported on Cloudera Manager. + |
++ |
Continue an HBase setup for Classic Cluster source.
+Response object for creating ABFS credentials.
- clusterCrn |
-
- The CRN of the destination cluster. - |
-
- string - |
-
- policyId errors |
- The ID of the HBase policy. +The list of response errors in case of a partial failure while creating the credential. |
- string +< ApiError > array |
Response object for continueHbaseSetup.
+Request object for creating AWS Access Key cloud credentials.
- clusterCrn accessKey |
- The CRN of the input cluster. +AWS access key. |
string @@ -6242,11 +7539,23 @@ContinueHbaseSetupResponse |
- message clusters |
- The detailed description of the action taken. +List of cluster CRNs where the credential should be created. + |
+
+ < string > array + |
+
+ name |
+
+ Name of the credential. |
string @@ -6254,11 +7563,11 @@ContinueHbaseSetupResponse |
- status secretKey |
- The status of the request. +AWS secret key. |
string @@ -6268,9 +7577,9 @@ContinueHbaseSetupResponse |
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.
- accessKey errors |
- ABFS access key. +The list of response errors in case of a partial failure while creating the credential. |
- string +< ApiError > array |
Request object for creating AWS IAM or Access & Secret Key cloud credentials.
+Name | +Description | +Schema | +
---|---|---|
- clientId accessKey |
- Client ID of an Active Directory service principal account. +AWS access key. |
string @@ -6312,35 +7643,35 @@CreateAbfsCredentialRequest |
- clientSecretKey clusters |
- Client Key of an Active Directory service principal account. +List of cluster CRNs where the credential should be created. |
- string +< string > array |
- clusters name |
- List of cluster CRNs where the credential should be created. +Name of the credential. |
- < string > array +string |
- name secretKey |
- Name of the credential. +AWS secret key. |
string @@ -6348,47 +7679,103 @@CreateAbfsCredentialRequest |
- storageAccountName type |
+
+ Type of the credential. Additional required parameters by type: IAM: none; ACCESSKEY: accessKey, secretKey. Superfluous parameters are ignored. Providing IAM will create an IAM Role-based Authentication account in Cloudera Manager. Providing ACCESSKEY will create an AWS Access Key Authentication account in Cloudera Manager. + |
++ |
Response object for creating AWS credentials.
+Name | +Description | +Schema | +
---|---|---|
+ errors |
- ABFS storage account name. +The list of response errors in case of a partial failure while creating the credential. |
- string +< ApiError > array |
Request object for creating AWS IAM Role based cloud credentials.
+Name | +Description | +Schema | +
---|---|---|
- tenantId clusters |
- Tenant ID of an Active Directory service principal account. +List of cluster CRNs where the credential should be created. |
- string +< string > array |
- type name |
- 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. |
-
+ string |
Response object for creating ABFS credentials.
+Response object for creating AWS IAM Role based cloud credentials.
Request object for creating AWS IAM or Access & Secret Key cloud credentials.
+Request object for creating AWS IDBroker cloud credentials.
- accessKey |
-
- AWS access key. - |
-
- string - |
-
clusters |
@@ -6464,11 +7839,11 @@ ||
- name idbrokerAddress |
- 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 idbrokerCabPath |
- AWS secret key. +The name of the IDBroker topology that will be used for authentication. |
string @@ -6488,23 +7863,23 @@CreateAwsCredentialRequest |
- type name |
- 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. |
-
+ string |
Response object for creating AWS credentials.
+Response object for creating AWS IDBroker cloud credentials.
Request object for creating GCS cloud credentials.
+Request object for creating GCS Private Key cloud credentials.
clientEmail |
Client email. @@ -6593,7 +7968,7 @@CreateGcsCredentialRequestprivateKey GCS private key. @@ -6605,7 +7980,7 @@CreateGcsCredentialRequestprivateKeyId GCS private key ID. @@ -6614,25 +7989,13 @@CreateGcsCredentialRequeststring |
-
- type |
-
- Type of the credential. Additional accepted parameters by type: PRIVATEKEY: clientEmail, privateKeyId, privateKey. Superfluous parameters are ignored. -
- | |
Response object for creating GCS credentials.
+Response object for creating GCS Private Key cloud credentials.
Name | +Description | +Schema | +
---|---|---|
+ clusterCrn |
+
+ The CRN of the input cluster. + |
+
+ string + |
+
+ message |
+
+ The detailed description of the action taken. + |
+
+ string + |
+
+ requestId |
+
+ The ID of the request. Populated only for Ambari backend. + |
+
+ string + |
+
+ status |
+
+ The status of the request. + |
+
+ string + |
+
Response object for deletePolicy.
Type : object
-Name | +Description | +Schema | +
---|---|---|
+ clusterCrn |
+
+ The CRN of the input cluster. + |
+
+ string + |
+
+ message |
+
+ The detailed description of the action taken. + |
+
+ string + |
+
+ requestId |
+
+ The ID of the request. Populated only for Ambari backend. + |
+
+ string + |
+
+ status |
+
+ The status of the request. + |
+
+ string + |
+
GCS cloud credential type.
-Type : enum (PRIVATEKEY)
-Request object for getClusterConfig.
@@ -8870,6 +10346,18 @@exportSnapshotUser
+optional
If set, the user specified by this parameter will be used to export the initial snapshot on the source.
+string
+hbasePolicyArguments
required
cmPolicySubmitUser
+optional
CM policy submit user.
+creationTime
@@ -13908,9 +15408,70 @@
Response object for suspendPolicy.
Type : object
-Name | +Description | +Schema | +
---|---|---|
+ clusterCrn |
+
+ The CRN of the input cluster. + |
+
+ string + |
+
+ message |
+
+ The detailed description of the action taken. + |
+
+ string + |
+
+ requestId |
+
+ The ID of the request. Populated only for Ambari backend. + |
+
+ string + |
+
+ status |
+
+ The status of the request. + |
+
+ string + |
+
name
-required
name
+required
The name of the snapshot policy to be suspended.
+string
+Response object for suspendSnapshotPolicy.
+Name | +Description | +Schema | +
---|---|---|
+ clusterCrn |
+
+ CRN of the cluster where the snapshot policy is. + |
+
+ string + |
+
+ message |
+
+ The detailed description of the action taken. + |
+
+ string + |
+
+ status |
+
+ The status of the request. + |
+
+ string + |
+
Target details.
+Name | +Description | +Schema | +
---|---|---|
+ environmentCrn |
+
+ Target’s environment CRN. + |
+
+ string + |
+
+ warehouseCrn |
+
+ Target’s warehouse CRN. + |
+
+ string + |
+
Request object for updating ABFS Access Key based accounts in DLM Engine.
+Name | +Description | +Schema | +
---|---|---|
+ accessKey |
+
+ ABFS access key. + |
+
+ string + |
+
+ name |
+
+ Name of the credential to update. + |
+
+ string + |
+
+ storageAccountName |
+
+ ABFS storage account name. + |
+
+ string + |
+
Response object for updating ABFS Access Key based accounts in DLM Engine.
+Name | +Description | +Schema | +
---|---|---|
+ errors |
- 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 |
Response object for suspendSnapshotPolicy.
+Request object for updating Azure Active Directory Service Principal accounts in Cloudera Manager.
- clusterCrn clientId |
- 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 clientSecretKey |
- The detailed description of the action taken. +Client Key of an Active Directory service principal account. |
string @@ -14003,11 +15760,23 @@SuspendSnapshotPolicyResponse |
- status name |
- The status of the request. +Name of the credential to update. + |
+
+ string + |
+
+ tenantId |
+
+ Tenant ID of an Active Directory service principal account. |
string @@ -14017,9 +15786,9 @@SuspendSnapshotPolicyResponse |
Target details.
+Response object for updating Azure Active Directory Service Principal accounts in Cloudera Manager.
- environmentCrn |
-
- Target’s environment CRN. - |
-
- string - |
-
- warehouseCrn errors |
- 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 |
Request object for updating ABFS cloud credentials.
+Request object for updating AWS Access Key cloud credentials.
accessKey |
- ABFS access key. +AWS access key. |
string @@ -14095,11 +15852,11 @@UpdateAbfsCredentialRequest |
- clientId name |
- Client ID of an Active Directory service principal account. +Name of the credential to update. |
string @@ -14107,71 +15864,91 @@UpdateAbfsCredentialRequest |
- clientSecretKey secretKey |
- Client Key of an Active Directory service principal account. +AWS secret key. |
string |
Response object for updating AWS Access Key cloud credentials.
+
- name |
-
- Name of the credential to update. - |
-
- string - |
+Name | +Description | +Schema |
---|---|---|---|---|---|
- storageAccountName errors |
- 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 |
Request object for updating AWS IAM Role based cloud credentials.
+
- tenantId |
-
- Tenant ID of an Active Directory service principal account. - |
-
- string - |
+Name | +Description | +Schema |
---|---|---|---|---|---|
- type name |
- 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. |
-
+ string |
Response object for updating ABFS credentials.
+Response object for updating AWS IAM Role based cloud credentials.
- 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 |
Request object for updating AWS cloud credentials.
+Request object for updating AWS IdBroker cloud credentials.
- accessKey |
-
- AWS access key. - |
-
- string - |
-
- name idbrokerAddress |
- 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 idbrokerCabPath |
- AWS secret key. +The name of the IDBroker topology that will be used for authentication. |
string @@ -14259,23 +16024,23 @@UpdateAwsCredentialRequest |
- type name |
- Type of the credential. Additional accepted parameters by type: IAM: none; ACCESSKEY: accessKey, secretKey. Superfluous parameters are ignored. +Name of the credential to update. |
-
+ string |
Response object for updating AWS credentials.
+Response object for updating AWS IdBroker cloud credentials.
Request object for updating GCS cloud credentials.
+Request object for updating GCS Private Key cloud credentials.
clientEmail |
Client email. @@ -14352,7 +16117,7 @@UpdateGcsCredentialRequestprivateKey GCS private key. @@ -14364,7 +16129,7 @@UpdateGcsCredentialRequestprivateKeyId GCS private key ID. @@ -14373,25 +16138,13 @@UpdateGcsCredentialRequeststring |
-
- type |
-
- Type of the credential. Additional accepted parameters by type: PRIVATEKEY: clientEmail, privateKeyId, privateKey. Superfluous parameters are ignored. -
- | |
Response object for updating GCS credentials.
+Response object for updating GCS Private Key cloud credentials.
- 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 @@UpdatePolicyResponseResponse object for updatePolicy.
-
+Type : object -
UpdateSnapshotPolicyRequest@@ -15330,7 +17144,7 @@VerifyHbaseClusterPairResponsediff --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. |