@@ -5717,7 +5931,7 @@ DeleteSnapshotResponse
optional
- command id
+ The submitted Command ID of the delete snapshot.
|
integer (int64)
@@ -5729,7 +5943,7 @@ DeleteSnapshotResponse
optional
|
- The name of the database
+ The name of the database.
|
string
@@ -5741,7 +5955,7 @@ DeleteSnapshotResponse
optional
|
- The name of the environment
+ The name of the environment.
|
string
@@ -5753,7 +5967,7 @@ DeleteSnapshotResponse
optional
|
- Snapshot name
+ The name of the snapshot.
|
string
@@ -5765,7 +5979,7 @@ DeleteSnapshotResponse
optional
|
- Status
+ The status of the delete snapshot.
|
|
- Reason for the status
+ Reason for the status.
|
string
@@ -6936,6 +7150,86 @@ Kind
+ ListCertificatesRequest
+
+ The request of listing SHA-1 fingerprints of certificates in Global Trust Store
+
+
+
+
+
+
+
+
+
+| Name |
+Description |
+Schema |
+
+
+
+
+ |
+
+ The name or CRN of the database.
+ |
+ |
+
+
+ |
+
+ The name or CRN of the environment.
+ |
+ |
+
+
+
+
+ ListCertificatesResponse
+
+ The response of listing fingerprints of certificates in Global Trust Store
+
+
+
+
+
+
+
+
+
+| Name |
+Description |
+Schema |
+
+
+
+
+
+ fingerprints
+optional
+ |
+
+ List of certificate SHA-1 fingerprints in Global Trust Store
+ |
+ |
+
+
+
+
ListCoprocessorsRequest
The request for listing coprocessors in a database.
@@ -7506,7 +7800,7 @@ ListRestoreSnapshotsRequest
optional
|
- Command Id
+ The submitted Command ID of the snapshot.
|
integer (int64)
@@ -7518,7 +7812,7 @@ ListRestoreSnapshotsRequest
required
|
- The name of the database
+ The name of the database.
|
string
@@ -7530,7 +7824,7 @@ ListRestoreSnapshotsRequest
required
|
- The name of the environment
+ The name of the environment.
|
string
@@ -7554,7 +7848,7 @@ ListRestoreSnapshotsRequest
optional
|
- Snapshot Name
+ The name of the snapshot.
|
string
@@ -7566,7 +7860,7 @@ ListRestoreSnapshotsRequest
optional
|
- The name of the target database
+ The name of the target database.
|
string
@@ -7578,7 +7872,7 @@ ListRestoreSnapshotsRequest
optional
|
- The name of the target environment
+ The name of the target environment.
|
string
@@ -7824,7 +8118,7 @@ ListSnapshotsRequest
optional
|
- Command Id
+ The submitted Command ID of the snapshots.
|
integer (int64)
@@ -7836,7 +8130,7 @@ ListSnapshotsRequest
required
|
- The name of the database
+ The name of the database.
|
string
@@ -7848,7 +8142,7 @@ ListSnapshotsRequest
required
|
- The name of the environment
+ The name of the environment.
|
string
@@ -7860,7 +8154,7 @@ ListSnapshotsRequest
optional
|
- The starting snapshot creation time to search snapshots (inclusive).
+ The creation time of the snapshots to search (inclusive).
|
string (date-time)
@@ -7872,7 +8166,7 @@ ListSnapshotsRequest
optional
|
- Table name
+ The table name.
|
string
@@ -7884,7 +8178,7 @@ ListSnapshotsRequest
optional
|
- The ending snapshot creation time to search snapshots (inclusive).
+ The ending time of the snapshot creation to search (inclusive).
|
string (date-time)
@@ -7918,7 +8212,7 @@ ListSnapshotsResponse
required
|
- The name of the database
+ The name of the database.
|
string
@@ -7930,7 +8224,7 @@ ListSnapshotsResponse
required
|
- The name of the environment
+ The name of the environment.
|
string
@@ -7942,7 +8236,7 @@ ListSnapshotsResponse
optional
|
- List of snapshots
+ List of snapshots.
|
< Snapshot > array
@@ -7954,7 +8248,7 @@ ListSnapshotsResponse
optional
|
- Status
+ The status of the list snapshots.
|
|
- Reason for the status
+ Reason for the status.
|
string
@@ -8121,7 +8415,7 @@ ListSupportedInstanceTypesResponse<
- supportedInstanceTypesLists
+ supportedInstances
optional
|
@@ -8391,7 +8685,7 @@ RestoreSnapshot
optional
|
- Command id
+ The submitted Command ID of the restore snapshot.
|
integer (int64)
@@ -8415,7 +8709,7 @@ RestoreSnapshot
optional
|
- When the snapshot restore was started
+ The time when the snapshot restore was started.
|
integer (int64)
@@ -8427,7 +8721,7 @@ RestoreSnapshot
optional
|
- The snapshot name
+ The name of the snapshot.
|
string
@@ -8439,7 +8733,7 @@ RestoreSnapshot
optional
|
- Status
+ The status of the restore snapshot.
|
|
- The name of the target database
+ The name of the target database.
|
string
@@ -8463,7 +8757,7 @@ RestoreSnapshot
optional
|
- The name of the target environment
+ The name of the target environment.
|
string
@@ -8497,7 +8791,7 @@ RestoreSnapshotRequest
required
|
- The name of the original database
+ The name of the original database.
|
string
@@ -8509,7 +8803,7 @@ RestoreSnapshotRequest
required
|
- The name of the original environment
+ The name of the original environment.
|
string
@@ -8521,7 +8815,7 @@ RestoreSnapshotRequest
required
|
- Snapshot name
+ The name of the snapshot.
|
string
@@ -8533,7 +8827,7 @@ RestoreSnapshotRequest
required
|
- The name of the target database where the snapshot should be restored
+ The name of the target database where the snapshot should be restored.
|
string
@@ -8545,7 +8839,7 @@ RestoreSnapshotRequest
required
|
- The name of the target environment where the snapshot should be restored
+ The name of the target environment where the snapshot should be restored.
|
string
@@ -8557,7 +8851,7 @@ RestoreSnapshotRequest
RestoreSnapshotResponse
- Restore Snapshot Response.
+ Response object for the RestoreSnapshot method.
@@ -8579,7 +8873,7 @@ RestoreSnapshotResponse
optional
- Command id
+ The submitted Command ID of the restore snapshot.
|
integer (int64)
@@ -8591,7 +8885,7 @@ RestoreSnapshotResponse
optional
|
- The name of the database
+ The name of the database.
|
string
@@ -8603,7 +8897,7 @@ RestoreSnapshotResponse
optional
|
- The name of the environment
+ The name of the environment.
|
string
@@ -8615,7 +8909,7 @@ RestoreSnapshotResponse
optional
|
- When the snapshot restore was started
+ The time when the snapshot restore was started.
|
integer (int64)
@@ -8627,7 +8921,7 @@ RestoreSnapshotResponse
optional
|
- The snapshot name
+ The name of the snapshot.
|
string
@@ -8639,7 +8933,7 @@ RestoreSnapshotResponse
optional
|
- Status
+ The status of the restore snapshot.
|
|
- Reason for the status
+ Reason for the status.
|
string
@@ -8663,7 +8957,7 @@ RestoreSnapshotResponse
optional
|
- The name of the target database
+ The name of the target database.
|
string
@@ -8675,7 +8969,7 @@ RestoreSnapshotResponse
optional
|
- The name of the target environment
+ The name of the target environment.
|
string
@@ -8813,7 +9107,7 @@ Snapshot
optional
|
- Command id
+ The submitted Command ID of the snapshot.
|
integer (int64)
@@ -8825,7 +9119,7 @@ Snapshot
optional
|
- Creation Time
+ The creation time of the snapshot.
|
integer (int64)
@@ -8849,7 +9143,7 @@ Snapshot
optional
|
- Snapshot location
+ The location of the snapshot.
|
string
@@ -8861,7 +9155,7 @@ Snapshot
required
|
- Snapshot Name
+ The name of the snapshot.
|
string
@@ -8873,7 +9167,7 @@ Snapshot
optional
|
- Status
+ The status of the snapshot.
|
|
- Table Name
+ The table name.
|
string
@@ -8901,7 +9195,7 @@ SnapshotStatusType
NEW - Expected when a snapshot request was just requested. IN_PROGRESS - When a snapshot request is in progress. FAILED - If for any reason a snapshot request has failed. SUCCESSFUL - A snapshot request has completed successfully. LOCKED - A snapshot exists, but can’t be restored or read. DELETED - A snapshot existed but was just deleted. CORRUPT - A snapshot got corrupted. DELETING - A snapshot is being deleted.
- Type : enum (NEW, IN_PROGRESS, FAILED, SUCCESSFUL, LOCKED, DELETED, CORRUPT, UNKNOWN)
+ Type : enum (NEW, IN_PROGRESS, FAILED, SUCCESSFUL, LOCKED, DELETED, CORRUPT, DELETING, UNKNOWN)
@@ -9217,7 +9511,7 @@ SupportedInstanceTypesList
The other instance types supported.
|
- string
+ < string > array
|
@@ -9808,6 +10102,98 @@ UpgradeDatabaseResponse
+ UploadCertificateRequest
+
+ The request of uploading a custom certificate to Global Trust Store
+
+
+
+
+
+
+
+
+
+| Name |
+Description |
+Schema |
+
+
+
+
+ |
+
+ Custom certificate in PEM format
+ |
+ |
+
+
+ |
+
+ The name or CRN of the database.
+ |
+ |
+
+
+ |
+
+ The name or CRN of the environment.
+ |
+ |
+
+
+
+
+
+ UploadCertificateResponse
+
+ The response of uploading a custom certificate to Global Trust Store
+
+
+
+
+
+
+
+
+
+| Name |
+Description |
+Schema |
+
+
+
+
+ |
+
+ SHA-1 fingerprint of the newly added certificate
+ |
+ |
+
+
+
+
+
VolumeEncryption
Specify volume encryption key for instance group.
@@ -9868,7 +10254,7 @@ VolumeType
diff --git a/api-docs-beta/replicationmanager/index.html b/api-docs-beta/replicationmanager/index.html
index 1f3082869..12679e76b 100644
--- a/api-docs-beta/replicationmanager/index.html
+++ b/api-docs-beta/replicationmanager/index.html
@@ -1254,7 +1254,7 @@ Overview
- Version : 0.9.126 (BETA)
+ Version : 0.9.127 (BETA)
@@ -17144,7 +17144,7 @@ VerifyHbaseClusterPairResponse
diff --git a/api-docs-beta/swagger/README.md b/api-docs-beta/swagger/README.md
index d0665ef93..5ab63ac15 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.126 (BETA)*
+*Version: 0.9.127 (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.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 |
+| [audit.yaml](./audit.yaml) | 0.9.127 |
+| [cloudprivatelinks.yaml](./cloudprivatelinks.yaml) | 0.9.127 |
+| [compute.yaml](./compute.yaml) | 0.9.127 |
+| [consumption.yaml](./consumption.yaml) | 0.9.127 |
+| [datacatalog.yaml](./datacatalog.yaml) | 0.9.127 |
+| [datahub.yaml](./datahub.yaml) | 0.9.127 |
+| [datalake.yaml](./datalake.yaml) | 0.9.127 |
+| [de.yaml](./de.yaml) | 0.9.127 |
+| [df.yaml](./df.yaml) | 0.9.127 |
+| [dfworkload.yaml](./dfworkload.yaml) | 0.9.127 |
+| [drscp.yaml](./drscp.yaml) | 0.9.127 |
+| [dw.yaml](./dw.yaml) | 0.9.127 |
+| [environments.yaml](./environments.yaml) | 0.9.127 |
+| [iam.yaml](./iam.yaml) | 0.9.127 |
+| [imagecatalog.yaml](./imagecatalog.yaml) | 0.9.127 |
+| [metrics.yaml](./metrics.yaml) | 0.9.127 |
+| [ml.yaml](./ml.yaml) | 0.9.127 |
+| [opdb.yaml](./opdb.yaml) | 0.9.127 |
+| [replicationmanager.yaml](./replicationmanager.yaml) | 0.9.127 |
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 331a2a3da..157565508 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.126 (BETA)
+ version: 0.9.127 (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 827143cae..fc4418df0 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.126 (BETA)
+ version: 0.9.127 (BETA)
title: Cloudera CloudPrivateLinks API Service
license:
name: Apache 2.0
diff --git a/api-docs-beta/swagger/compute.yaml b/api-docs-beta/swagger/compute.yaml
index de974d056..55b31d804 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.126 (BETA)
+ version: 0.9.127 (BETA)
title: Cloudera Compute Service
license:
name: Apache 2.0
@@ -93,7 +93,6 @@ paths:
description: Deletes a deployment that is currently installed and managed for this cluster.
operationId: deleteDeployment
x-entitlement: COMPUTE_API_LIFTIE_DEPLOYMENT_BETA
- x-form-factors: public
parameters:
- name: input
in: body
@@ -228,7 +227,6 @@ paths:
description: Installs a new deployment in the specified namespace.
operationId: installDeployment
x-entitlement: COMPUTE_API_LIFTIE_DEPLOYMENT_BETA
- x-form-factors: public
parameters:
- name: input
in: body
@@ -274,7 +272,6 @@ paths:
description: Lists the helm charts that are available for deployment or have already been deployed in this cluster.
operationId: listDeployments
x-entitlement: COMPUTE_API_LIFTIE
- x-form-factors: public
parameters:
- name: input
in: body
@@ -314,13 +311,35 @@ paths:
schema:
$ref: '#/definitions/Error'
x-mutating: false
+ /api/v1/compute/resumeCluster:
+ post:
+ summary: Resume Cluster
+ description: Resumes the compute cluster
+ operationId: resumeCluster
+ x-entitlement: COMPUTE_API_LIFTIE
+ x-form-factors: public
+ parameters:
+ - name: input
+ in: body
+ required: true
+ schema:
+ $ref: '#/definitions/ResumeClusterRequest'
+ responses:
+ 200:
+ description: Expected response to a valid request.
+ schema:
+ $ref: '#/definitions/ResumeClusterResponse'
+ default:
+ description: The default response on an error.
+ schema:
+ $ref: '#/definitions/Error'
+ x-mutating: true
/api/v1/compute/rollbackDeployment:
post:
summary: Rollbacks a deployment to a previous revision
description: This will perform a rollback.
operationId: rollbackDeployment
x-entitlement: COMPUTE_API_LIFTIE_DEPLOYMENT_BETA
- x-form-factors: public
parameters:
- name: input
in: body
@@ -337,6 +356,29 @@ paths:
schema:
$ref: '#/definitions/Error'
x-mutating: true
+ /api/v1/compute/suspendCluster:
+ post:
+ summary: Suspend Cluster
+ description: Suspends the compute cluster
+ operationId: suspendCluster
+ x-entitlement: COMPUTE_API_LIFTIE
+ x-form-factors: public
+ parameters:
+ - name: input
+ in: body
+ required: true
+ schema:
+ $ref: '#/definitions/SuspendClusterRequest'
+ responses:
+ 200:
+ description: Expected response to a valid request.
+ schema:
+ $ref: '#/definitions/SuspendClusterResponse'
+ default:
+ description: The default response on an error.
+ schema:
+ $ref: '#/definitions/Error'
+ x-mutating: true
/api/v1/compute/updateCluster:
post:
summary: Update cluster
@@ -504,6 +546,17 @@ definitions:
type: boolean
description: Flag to indicate if whitelist of IP Ranges (CIDR block) for public access to the kubernetes API server is enabled.
x-form-factors: public
+ AzureSecretEncryptionResp:
+ type: object
+ description: Azure Secret Encryption response structure.
+ properties:
+ encryptionKeyUrl:
+ type: string
+ description: Encryption key URI.
+ userManagedIdentity:
+ type: string
+ description: Resource ID of the user managed identity.
+ x-form-factors: public
CommonSecretEncryptionResp:
type: object
description: Secret Encryption response structure.
@@ -511,6 +564,17 @@ definitions:
customerKmsKeyArn:
type: string
description: AWS KMS key ARN.
+ azure:
+ description: Azure secret encryption details.
+ $ref: '#/definitions/AzureSecretEncryptionResp'
+ x-form-factors: public
+ AzureVolumeEncryptionResp:
+ type: object
+ description: Azure Volume Encryption response structure.
+ properties:
+ diskEncryptionSetId:
+ type: string
+ description: Disk encryption set ID.
x-form-factors: public
CommonVolumeEncryptionResp:
type: object
@@ -519,6 +583,9 @@ definitions:
customerKmsKeyArn:
type: string
description: AWS KMS key ARN.
+ azure:
+ description: Azure volume encryption details.
+ $ref: '#/definitions/AzureVolumeEncryptionResp'
x-form-factors: public
CommonSecurityResp:
type: object
@@ -777,6 +844,9 @@ definitions:
availabilityZone:
type: string
description: Availability zone.
+ subnetId:
+ type: string
+ description: Subnet ID.
x-form-factors: public
AksNodePool:
type: object
@@ -1046,6 +1116,9 @@ definitions:
availabilityZone:
type: string
description: Availability zone.
+ subnetId:
+ type: string
+ description: Subnet ID.
x-form-factors: public
AcceleratorConfigResp:
type: object
@@ -1825,6 +1898,16 @@ definitions:
enabled:
type: boolean
description: Flag to enable whitelist of IP Ranges (CIDR block) for public access to the kubernetes API server.
+ AzureSecretEncryption:
+ type: object
+ description: Azure Secret Encryption request structure.
+ properties:
+ encryptionKeyUrl:
+ type: string
+ description: Encryption key URI.
+ userManagedIdentity:
+ type: string
+ description: Resource ID of the user managed identity.
CommonSecretEncryption:
type: object
description: Secret encryption request structure.
@@ -1833,6 +1916,16 @@ definitions:
type: string
description: AWS KMS key ARN.
x-sensitive: true
+ azure:
+ description: Azure secret encryption details.
+ $ref: '#/definitions/AzureSecretEncryption'
+ AzureVolumeEncryption:
+ type: object
+ description: Azure Volume Encryption request structure.
+ properties:
+ diskEncryptionSetId:
+ type: string
+ description: Disk encryption set ID.
CommonVolumeEncryption:
type: object
description: Volume encryption request structure.
@@ -1841,6 +1934,9 @@ definitions:
type: string
description: The KMS key ARN used.
x-sensitive: true
+ azure:
+ description: Azure volume encryption details.
+ $ref: '#/definitions/AzureVolumeEncryption'
CommonSecurity:
type: object
description: Security request structure.
@@ -2098,6 +2194,16 @@ definitions:
clusterCrn:
type: string
description: Compute cluster CRN.
+ force:
+ type: boolean
+ description: Forces the cluster into the DELETED state without cleaning up resources; only valid if cluster is in DELETE_FAILED state.
+ skipWorkloadsValidation:
+ type: boolean
+ description: Whether to skip the running workloads validation for externalized clusters
+ skipValidation:
+ type: boolean
+ description: Whether to skip validation.
+ x-form-factors: public
DeleteClusterResponse:
type: object
description: Delete cluster response.
@@ -2105,6 +2211,10 @@ definitions:
clusterStatus:
description: Cluster Status.
$ref: '#/definitions/CommonStatusMessage'
+ validationResponse:
+ description: Pre-flight validation check response. Only given on a validation failure.
+ $ref: '#/definitions/ValidationResponse'
+ x-form-factors: public
InstallDeploymentRequest:
type: object
description: Request structure for installing a deployment.
@@ -2136,7 +2246,6 @@ definitions:
type: string
description: Deployment profile to use. Currently supported are cml and cde.
x-form-factors: public
- x-form-factors: public
InstallDeploymentResponse:
type: object
description: Response structure for installing a deployment.
@@ -2160,7 +2269,6 @@ definitions:
chart:
description: Chart that the deployment was created from.
$ref: '#/definitions/Chart'
- x-form-factors: public
DeleteDeploymentRequest:
type: object
description: Request structure for deleting a deployment.
@@ -2178,7 +2286,6 @@ definitions:
name:
type: string
description: The name of the deployment.
- x-form-factors: public
DeleteDeploymentResponse:
type: object
description: Response structure for deleting a deployment.
@@ -2186,7 +2293,6 @@ definitions:
message:
type: string
description: A message returned about the status of the delete operation.
- x-form-factors: public
DescribeDeploymentRequest:
type: object
description: Request structure for describing a deployment.
@@ -2386,7 +2492,6 @@ definitions:
verbose:
type: boolean
description: Set true to get detailed chart response. Default is false.
- x-form-factors: public
ListDeploymentsResponse:
type: object
description: Response structure to list deployments in the cluster.
@@ -2406,7 +2511,6 @@ definitions:
items:
$ref: '#/definitions/Deployment'
description: Array of installed deployments.
- x-form-factors: public
AddUserRequest:
type: object
description: Request object for adding a user or a role to a cluster.
@@ -2538,4 +2642,55 @@ definitions:
$ref: '#/definitions/User'
description: List of Users.
x-form-factors: public
+ SuspendClusterRequest:
+ type: object
+ description: Request structure to suspend the compute cluster
+ required:
+ - clusterCrn
+ properties:
+ clusterCrn:
+ type: string
+ description: Compute cluster CRN.
+ skipWorkloadsValidation:
+ type: boolean
+ description: Whether to skip the running workloads validation for externalized clusters
+ skipValidation:
+ type: boolean
+ description: Whether to skip validation.
+ x-form-factors: public
+ SuspendClusterResponse:
+ type: object
+ description: Response structure for suspending the compute cluster
+ properties:
+ clusterStatus:
+ description: Cluster status.
+ $ref: '#/definitions/CommonStatusMessage'
+ validationResponse:
+ description: Pre-flight validation check response. Only given on a validation failure and `skipValidation` is false.
+ $ref: '#/definitions/ValidationResponse'
+ x-form-factors: public
+ ResumeClusterRequest:
+ type: object
+ description: Request structure to resume the compute cluster
+ required:
+ - clusterCrn
+ properties:
+ clusterCrn:
+ type: string
+ description: Compute cluster CRN.
+ skipValidation:
+ type: boolean
+ description: Whether to skip validation.
+ x-form-factors: public
+ ResumeClusterResponse:
+ type: object
+ description: Response structure for resuming the compute cluster
+ properties:
+ clusterStatus:
+ description: Cluster status.
+ $ref: '#/definitions/CommonStatusMessage'
+ validationResponse:
+ description: Pre-flight validation check response. Only given on a validation failure and `skipValidation` is false.
+ $ref: '#/definitions/ValidationResponse'
+ x-form-factors: public
x-audit: true
diff --git a/api-docs-beta/swagger/consumption.yaml b/api-docs-beta/swagger/consumption.yaml
index 4e0837890..9821d8b7a 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.126 (BETA)
+ version: 0.9.127 (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 b695c2549..63963551f 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.126 (BETA)
+ version: 0.9.127 (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 a45c8f80e..a61cd7883 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.126 (BETA)
+ version: 0.9.127 (BETA)
title: Cloudera Data hub Service
license:
name: Apache 2.0
@@ -1498,6 +1498,27 @@ paths:
description: The default response on an error.
schema:
$ref: '#/definitions/Error'
+ /api/v1/datahub/setDefaultJavaVersion:
+ post:
+ summary: Configures the default Java version for the Data Hub.
+ description: Configures the default Java version for the Data Hub. This command updates the system's default Java version and will restart both the Cluster Manager and the services.
+ operationId: setDefaultJavaVersion
+ x-mutating: true
+ parameters:
+ - name: input
+ in: body
+ required: true
+ schema:
+ $ref: '#/definitions/SetDefaultJavaVersionRequest'
+ responses:
+ 200:
+ description: Expected response to a valid request.
+ schema:
+ $ref: '#/definitions/SetDefaultJavaVersionResponse'
+ default:
+ description: The default response on an error.
+ schema:
+ $ref: '#/definitions/Error'
definitions:
Error:
type: object
@@ -4991,3 +5012,23 @@ definitions:
UpdateToAwsImdsV1Response:
type: object
description: Response object for updating Data Hub to AWS IMDSv1.
+ SetDefaultJavaVersionRequest:
+ type: object
+ description: Request object for setting the default Java version on the Data Hub cluster.
+ required:
+ - clusterCrn
+ - javaVersion
+ properties:
+ clusterCrn:
+ type: string
+ description: The CRN of the Data Hub cluster.
+ javaVersion:
+ type: string
+ description: The Java version to set as default.
+ SetDefaultJavaVersionResponse:
+ type: object
+ description: Response object for setting the default Java version on the Data Hub cluster.
+ properties:
+ operationId:
+ type: string
+ description: The id of the related operation.
diff --git a/api-docs-beta/swagger/datalake.yaml b/api-docs-beta/swagger/datalake.yaml
index f7c3dfd7e..45db138ff 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.126 (BETA)
+ version: 0.9.127 (BETA)
title: Cloudera Datalake Service
license:
name: Apache 2.0
@@ -1138,6 +1138,27 @@ paths:
description: The default response on an error.
schema:
$ref: '#/definitions/Error'
+ /api/v1/datalake/setDefaultJavaVersion:
+ post:
+ summary: Configures the default Java version for the Data Lake.
+ description: Configures the default Java version for the Data Lake. This command updates the system's default Java version and will restart both the Cluster Manager and the services.
+ operationId: setDefaultJavaVersion
+ x-mutating: true
+ parameters:
+ - name: input
+ in: body
+ required: true
+ schema:
+ $ref: '#/definitions/SetDefaultJavaVersionRequest'
+ responses:
+ 200:
+ description: Expected response to a valid request.
+ schema:
+ $ref: '#/definitions/SetDefaultJavaVersionResponse'
+ default:
+ description: The default response on an error.
+ schema:
+ $ref: '#/definitions/Error'
definitions:
Error:
type: object
@@ -3796,3 +3817,23 @@ definitions:
type: integer
format: int32
description: The modified storage size for the database.
+ SetDefaultJavaVersionRequest:
+ type: object
+ description: Request object for setting the default Java version on the Data Lake cluster.
+ required:
+ - crn
+ - javaVersion
+ properties:
+ crn:
+ type: string
+ description: The CRN of the Data Lake cluster.
+ javaVersion:
+ type: string
+ description: The default Java version to be set on the Data Lake cluster.
+ SetDefaultJavaVersionResponse:
+ type: object
+ description: Response object for setting the default Java version on the Data Lake cluster.
+ properties:
+ operationId:
+ type: string
+ description: The id of the related operation.
diff --git a/api-docs-beta/swagger/de.yaml b/api-docs-beta/swagger/de.yaml
index 4596f386a..714741a1d 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.126 (BETA)
+ version: 0.9.127 (BETA)
title: Cloudera Data Engineering
license:
name: Apache 2.0
@@ -1848,7 +1848,7 @@ definitions:
description: CRN of the CDP environment with which a restored CDE service will be associated. Currently, CDE service can be restored only to the same CDP environment, with which a backed-up service was associated.
serviceId:
type: string
- description: Specify the restored service ID. If not specified, the service ID from the backup will be reused.
+ description: Specify the restored service ID. If not specified, a new service ID will be generated.
serviceName:
type: string
description: Specify the restored service name. If not specified, the service name from the backup will be reused.
diff --git a/api-docs-beta/swagger/df.yaml b/api-docs-beta/swagger/df.yaml
index 4d8a26944..2107248da 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.126 (BETA)
+ version: 0.9.127 (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 6cfa2a932..b4f734a28 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.126 (BETA)
+ version: 0.9.127 (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 6f1482209..1d7c40b45 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.126 (BETA)
+ version: 0.9.127 (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 58de2c537..876586fee 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.126 (BETA)
+ version: 0.9.127 (BETA)
title: Cloudera Data Warehouse [EXPERIMENTAL]
license:
name: Apache 2.0
@@ -2148,6 +2148,10 @@ definitions:
x-form-factors: public
description: Allowed instance types for Impala Virtual Warehouses.
$ref: '#/definitions/AllowedInstanceTypesWithDefault'
+ trino:
+ x-form-factors: public
+ description: Allowed instance types for Trino Virtual Warehouses.
+ $ref: '#/definitions/AllowedInstanceTypesWithDefault'
AllowedInstanceTypesWithDefault:
x-form-factors: public
type: object
@@ -2480,12 +2484,6 @@ definitions:
items:
type: string
description: 'NOTE: The cluster level instance type selection will be replaced by virtual warehouse level selection. AWS compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values.'
- additionalInstanceTypes:
- x-deprecated: true
- type: array
- items:
- type: string
- description: 'DEPRECATED: Additional compute instance types will be removed in subsequent releases. Additional (fallback) instance types listed in their priority order. They will be used instead of the primary compute instance type in case it is unavailable. You cannot include any instance type that was already indicated in computeInstanceTypes. Use describe-allowed-instance-types to see currently supported values and also the default value when nothing is provided for the computeInstanceTypes.'
CreateAzureClusterRequest:
type: object
description: Request object for the createAzureCluster method.
@@ -2682,7 +2680,7 @@ definitions:
description: The ID of the cluster.
data:
type: string
- description: Dump of configuration received by calling "dump-cluster" command.
+ description: Backup data of configuration received by calling "backup-cluster" command.
RestoreClusterResponse:
type: object
description: Response object for the restoreCluster method.
@@ -2790,12 +2788,6 @@ definitions:
items:
type: string
description: 'NOTE: The cluster level instance type selection will be replaced by virtual warehouse level selection. AWS compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values.'
- additionalInstanceTypes:
- x-deprecated: true
- type: array
- items:
- type: string
- description: 'DEPRECATED: Additional compute instance types will be removed in subsequent releases. Additional (fallback) instance types listed in their priority order. They will be used instead of the primary compute instance type in case it is unavailable. You cannot include any instance type that was already indicated in computeInstanceTypes. Use describe-allowed-instance-types to see currently supported values and also the default value when nothing is provided for the computeInstanceTypes.'
AzureActivationOptions:
type: object
description: Options for activating an Azure environment.
@@ -3190,10 +3182,9 @@ definitions:
type: string
description: Version of the Cloudera Data Visualization.
x-form-factors: public
- templateName:
+ resourceTemplate:
type: string
- description: 'DEPRECATED: Use resourceTemplate parameter instead that will be made available in the upcoming release. The template size for the Cloudera Data Visualization.'
- x-deprecated: true
+ description: The name of the available resource template to use for the Cloudera Data Visualization.
CreateDataVisualizationResponse:
type: object
description: Response object for the createDataVisualization method.
@@ -3371,7 +3362,8 @@ definitions:
default: false
description: Forced recreation of the diagnostic job.
downloadOptions:
- description: Cluster diagnostic options. If not provided, everything will be included in the Diagnostic Data.
+ x-deprecated: true
+ description: 'DEPRECATED: All logs are included by default. No need to specify options'
$ref: '#/definitions/ClusterCreateDiagnosticDataDownloadOptions'
CreateClusterDiagnosticDataJobResponse:
type: object
@@ -4261,10 +4253,9 @@ definitions:
description: version of the Virtual Warehouse.
default: ''
x-form-factors: public
- template:
+ tShirtSize:
type: string
- description: 'DEPRECATED: It will be replaced by the tShirtSize parameter in an upcoming release. Name of configuration template to use.'
- x-deprecated: true
+ description: Name of T-shirt size to use, which will determine the number of nodes.
enum:
- xsmall
- small
@@ -4890,8 +4881,9 @@ definitions:
description: 'DEPRECATED: Included by default, no need to specify'
ClusterCreateDiagnosticDataDownloadOptions:
type: object
- description: Flags that denote which diagnostics to include for the cluster.
x-form-factors: public
+ x-deprecated: true
+ description: 'DEPRECATED: Included by default, no need to specify'
properties:
includeClusterInfo:
x-deprecated: true
@@ -4955,6 +4947,10 @@ definitions:
version:
type: string
description: The version of the deployed CDW cluster.
+ productSupport:
+ x-form-factors: public,private
+ $ref: '#/definitions/ClusterSummaryProductSupportResponse'
+ description: 'Support lifecycle details of the given Cluster version (see version field). Learn more at Support lifecycle site: https://www.cloudera.com/services-and-support/support-lifecycle-policy.html.'
enableSpotInstances:
x-form-factors: public
type: boolean
@@ -4976,12 +4972,6 @@ definitions:
items:
type: string
description: 'NOTE: The cluster level instance type selection will be replaced by virtual warehouse level selection. Compute instance types that the environment is restricted to use. This affects the creation of the virtual warehouses where this restriction will apply.'
- additionalInstanceTypes:
- x-deprecated: true
- type: array
- items:
- type: string
- description: 'DEPRECATED: Additional compute instance types will be removed in subsequent releases. Additional (fallback) instance types listed in their priority order. They are used instead of the primary compute instance type in case it is unavailable. Since additional instance types are not supported for Azure, this is always empty for it.'
awsOptions:
$ref: '#/definitions/AwsOptionsResponse'
description: Response object of AWS related cluster options.
@@ -5016,6 +5006,21 @@ definitions:
description: External buckets attached to the environment.
items:
$ref: '#/definitions/ExternalBucket'
+ ClusterSummaryProductSupportResponse:
+ x-form-factors: public,private
+ type: object
+ description: 'Support lifecycle details of the given Cluster version (see version field). Learn more at Support lifecycle site: https://www.cloudera.com/services-and-support/support-lifecycle-policy.html.'
+ properties:
+ status:
+ type: string
+ description: 'Status of the support lifecycle. *COVERED*: The Cluster version has active support. *EXPIRED*: The Cluster version is no-longer supported. *UNKNOWN*: The Cluster version is missing or incorrect.'
+ expiryDate:
+ type: string
+ format: date-time
+ description: Shows the expiration date of the support for this Cluster version.
+ message:
+ type: string
+ description: Message.
DataVisualizationSummary:
type: object
description: A Cloudera Data Visualization.
@@ -5191,6 +5196,9 @@ definitions:
type: string
x-form-factors: private
description: Command to use impala-shell for Impala Virtual Warehouses with Kerberos authentication.
+ trinoCli:
+ type: string
+ description: Command-line client that connects to Trino Virtual Warehouse to execute SQL queries.
hue:
type: string
description: URL of Hue for both Hive and Impala Virtual Warehouses.
@@ -5495,10 +5503,9 @@ definitions:
vwId:
type: string
description: ID of the Virtual Warehouse.
- template:
+ tShirtSize:
type: string
- description: 'DEPRECATED: It will be replaced by the tShirtSize parameter in an upcoming release. Name of configuration template to use.'
- x-deprecated: true
+ description: Name of T-shirt size to use, which will determine the number of nodes.
enum:
- xsmall
- small
@@ -6949,7 +6956,7 @@ definitions:
description: Storage related information.
x-nullable: true
x-mutating: false
- x-form-factors: private
+ x-form-factors: private,public
properties:
scratch:
type: string
diff --git a/api-docs-beta/swagger/environments.yaml b/api-docs-beta/swagger/environments.yaml
index 316ae2483..2b3efe152 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.126 (BETA)
+ version: 0.9.127 (BETA)
title: Cloudera Environments Service
license:
name: Apache 2.0
@@ -2431,6 +2431,14 @@ definitions:
description:
type: string
description: A description for the credential.
+ skipOrgPolicyDecisions:
+ type: boolean
+ default: false
+ description: Skips organization policy decisions during cloud storage validation.
+ verifyPermissions:
+ type: boolean
+ default: false
+ description: When true, verifies credential permissions.
awsCredentialProperties:
description: The credential properties that closely related to those that have been created on AWS.
$ref: '#/definitions/AwsCredentialProperties'
diff --git a/api-docs-beta/swagger/iam.yaml b/api-docs-beta/swagger/iam.yaml
index e3ed03240..08b2aec98 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.126 (BETA)
+ version: 0.9.127 (BETA)
title: Cloudera IAM Service
license:
name: Apache 2.0
@@ -116,7 +116,7 @@ paths:
summary: Deletes a user and all associated resources.
description: Deletes a user. This includes deleting all associated access keys and unassigning all roles and resource roles assigned to the user. The user is also removed from all groups it belongs to. If the call succeeds the user will not be able to login interactively, or use any access keys to access the CDP control plane. This feature is under development and some resources may be left behind after a successful call. Note that user-sync is not triggered yet by this call and the caller must trigger that to ensure that the user loses access to all environments as soon as possible.
operationId: deleteUser
- x-form-factors: public
+ x-form-factors: public,private
x-right: iam/deleteUser
x-mutating: true
parameters:
diff --git a/api-docs-beta/swagger/imagecatalog.yaml b/api-docs-beta/swagger/imagecatalog.yaml
index 85f369cb0..8ee6b16b7 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.126 (BETA)
+ version: 0.9.127 (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 ebf963600..1417b97f0 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.126 (BETA)
+ version: 0.9.127 (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 dbbbe22bb..f4ba22e36 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.126 (BETA)
+ version: 0.9.127 (BETA)
title: Cloudera AI
license:
name: Apache 2.0
@@ -1479,9 +1479,6 @@ definitions:
nfsVersion:
type: string
description: The NFS Protocol version of the NFS server we are using for Azure and Private Cloud.
- mlVersion:
- type: string
- description: The version of ML workload app to install.
enableModelMetrics:
type: boolean
description: Enables the model metrics service for exporting metrics for models to a metrics store.
diff --git a/api-docs-beta/swagger/opdb.yaml b/api-docs-beta/swagger/opdb.yaml
index f2495ffc1..f8bf35dc3 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.126 (BETA)
+ version: 0.9.127 (BETA)
title: Operational Database service
license:
name: Apache 2.0
@@ -84,8 +84,8 @@ paths:
x-mutating: true
/api/v1/opdb/createSnapshot:
post:
- summary: Creates a snapshot for a specific table
- description: Returns id state and creation time
+ summary: Creates a snapshot for a specific table.
+ description: Returns id state and creation time.
operationId: createSnapshot
parameters:
- name: input
@@ -105,8 +105,8 @@ paths:
x-mutating: true
/api/v1/opdb/deleteSnapshot:
post:
- summary: Deletes a snapshot
- description: Returns state of operation
+ summary: Deletes a snapshot.
+ description: Returns the snapshot that is deleted.
operationId: deleteSnapshot
parameters:
- name: input
@@ -229,6 +229,27 @@ paths:
schema:
$ref: '#/definitions/Error'
x-mutating: true
+ /api/v1/opdb/listCertificates:
+ post:
+ summary: List certificates
+ description: List SHA-1 fingerprints of certificates in Global Trust Store
+ operationId: listCertificates
+ parameters:
+ - name: input
+ in: body
+ required: true
+ schema:
+ $ref: '#/definitions/ListCertificatesRequest'
+ responses:
+ 200:
+ description: Expected response to a valid request.
+ schema:
+ $ref: '#/definitions/ListCertificatesResponse'
+ default:
+ description: The default response on an error.
+ schema:
+ $ref: '#/definitions/Error'
+ x-mutating: false
/api/v1/opdb/listCoprocessors:
post:
summary: Lists coprocessors in a database
@@ -339,7 +360,7 @@ paths:
x-mutating: false
/api/v1/opdb/listRestoreSnapshots:
post:
- summary: Lists instances when a snapshot was restored to a database
+ summary: Lists instances when a snapshot was restored to a database.
description: Returns a list of snapshots restored into a database.
operationId: listRestoreSnapshots
parameters:
@@ -382,8 +403,8 @@ paths:
x-mutating: false
/api/v1/opdb/listSnapshots:
post:
- summary: Shows snapshot for a table name in a specific location
- description: Returns list of snapshot names
+ summary: Shows snapshot for a table name in a specific location.
+ description: Returns list of snapshot names.
operationId: listSnapshots
parameters:
- name: input
@@ -488,8 +509,8 @@ paths:
x-mutating: true
/api/v1/opdb/restoreSnapshot:
post:
- summary: Restores a snapshot
- description: Returns state of operation
+ summary: Restores a snapshot.
+ description: Returns the snapshot that was restored.
operationId: restoreSnapshot
parameters:
- name: input
@@ -633,6 +654,27 @@ paths:
schema:
$ref: '#/definitions/Error'
x-mutating: true
+ /api/v1/opdb/uploadCertificate:
+ post:
+ summary: Upload custom certificate
+ description: Upload a custom certificate to Global Trust Store
+ operationId: uploadCertificate
+ parameters:
+ - name: input
+ in: body
+ required: true
+ schema:
+ $ref: '#/definitions/UploadCertificateRequest'
+ responses:
+ 200:
+ description: Expected response to a valid request.
+ schema:
+ $ref: '#/definitions/UploadCertificateResponse'
+ default:
+ description: The default response on an error.
+ schema:
+ $ref: '#/definitions/Error'
+ x-mutating: true
definitions:
Error:
type: object
@@ -859,6 +901,9 @@ definitions:
computeClusterCrn:
type: string
description: Utilizes the existing compute cluster with the provided CRN instead of creating a new one.
+ architecture:
+ description: Specifies the Architecture of the cluster nodes.
+ $ref: '#/definitions/ArchitectureType'
customInstanceTypes:
description: Provide custom VM instance types for master, worker, gateway, leader, edge and compute groups.
$ref: '#/definitions/CustomInstanceTypes'
@@ -1373,6 +1418,9 @@ definitions:
type: integer
format: int32
description: Number of REST Worker nodes for the database.
+ architecture:
+ description: Specifies the architecture of the cluster nodes.
+ $ref: '#/definitions/ArchitectureType'
StorageDetailsForWorker:
type: object
description: Storage details for the worker node for AWS, Azure, and GCP cloud providers.
@@ -1426,6 +1474,7 @@ definitions:
- LOCKED
- DELETED
- CORRUPT
+ - DELETING
- UNKNOWN
CreateSnapshotRequest:
type: object
@@ -1439,43 +1488,43 @@ definitions:
properties:
environmentName:
type: string
- description: The name of the environment
+ description: The name of the environment.
databaseName:
type: string
description: The name of the database.
tableName:
type: string
- description: fully qualified table name
+ description: The fully qualified table name.
snapshotName:
type: string
description: Snapshot name unique per database.
snapshotLocation:
type: string
- description: Snapshot location URL on object store
+ description: The snapshot location URL on object store.
CreateSnapshotResponse:
type: object
description: Create Snapshot Response.
properties:
environmentName:
type: string
- description: The name of the environment
+ description: The name of the environment.
databaseName:
type: string
- description: The name of the database
+ description: The name of the database.
status:
- description: Status
+ description: The status of the create snapshot.
$ref: '#/definitions/SnapshotStatusType'
creationTime:
type: integer
format: int64
- description: When the snapshot was created
+ description: When the snapshot was created.
commandID:
type: integer
format: int64
- description: command id
+ description: The submitted Command ID of the create snapshot.
statusReason:
type: string
- description: Reason for the status
+ description: Reason for the status.
RestoreSnapshotRequest:
type: object
description: Restore Snapshot Request.
@@ -1488,55 +1537,55 @@ definitions:
properties:
environmentName:
type: string
- description: The name of the original environment
+ description: The name of the original environment.
databaseName:
type: string
- description: The name of the original database
+ description: The name of the original database.
snapshotName:
type: string
- description: Snapshot name
+ description: The name of the snapshot.
targetEnvironmentName:
type: string
- description: The name of the target environment where the snapshot should be restored
+ description: The name of the target environment where the snapshot should be restored.
targetDatabaseName:
type: string
- description: The name of the target database where the snapshot should be restored
+ description: The name of the target database where the snapshot should be restored.
RestoreSnapshotResponse:
type: object
- description: Restore Snapshot Response.
+ description: Response object for the RestoreSnapshot method.
properties:
environmentName:
type: string
- description: The name of the environment
+ description: The name of the environment.
databaseName:
type: string
- description: The name of the database
+ description: The name of the database.
snapshotName:
type: string
- description: The snapshot name
+ description: The name of the snapshot.
targetEnvironmentName:
type: string
- description: The name of the target environment
+ description: The name of the target environment.
targetDatabaseName:
type: string
- description: The name of the target database
+ description: The name of the target database.
status:
- description: Status
+ description: The status of the restore snapshot.
$ref: '#/definitions/SnapshotStatusType'
restoreTime:
type: integer
format: int64
- description: When the snapshot restore was started
+ description: The time when the snapshot restore was started.
commandID:
type: integer
format: int64
- description: Command id
+ description: The submitted Command ID of the restore snapshot.
statusReason:
type: string
- description: Reason for the status
+ description: Reason for the status.
DeleteSnapshotRequest:
type: object
- description: Delete Snapshot Request.
+ description: Request object for the DeleteSnapshot method.
required:
- environmentName
- databaseName
@@ -1544,36 +1593,36 @@ definitions:
properties:
environmentName:
type: string
- description: The name of the environment
+ description: The name of the environment.
databaseName:
type: string
- description: The name of the database
+ description: The name of the database.
snapshotName:
type: string
- description: Snapshot name
+ description: The name of the snapshot.
DeleteSnapshotResponse:
type: object
- description: Delete Snapshot Response.
+ description: Response object of the DeleteSnapshot method.
properties:
environmentName:
type: string
- description: The name of the environment
+ description: The name of the environment.
databaseName:
type: string
- description: The name of the database
+ description: The name of the database.
status:
- description: Status
+ description: The status of the delete snapshot.
$ref: '#/definitions/SnapshotStatusType'
commandID:
type: integer
format: int64
- description: command id
+ description: The submitted Command ID of the delete snapshot.
statusReason:
type: string
- description: Reason for the status
+ description: Reason for the status.
snapshotName:
type: string
- description: Snapshot name
+ description: The name of the snapshot.
Snapshot:
type: object
description: An instance of a table's snapshot.
@@ -1583,24 +1632,24 @@ definitions:
properties:
tableName:
type: string
- description: Table Name
+ description: The table name.
snapshotName:
type: string
- description: Snapshot Name
+ description: The name of the snapshot.
creationTime:
type: integer
format: int64
- description: Creation Time
+ description: The creation time of the snapshot.
status:
- description: Status
+ description: The status of the snapshot.
$ref: '#/definitions/SnapshotStatusType'
commandID:
type: integer
format: int64
- description: Command id
+ description: The submitted Command ID of the snapshot.
snapshotLocation:
type: string
- description: Snapshot location
+ description: The location of the snapshot.
failureReason:
type: string
description: Reason for the failure in case of snapshot creation failed.
@@ -1613,25 +1662,25 @@ definitions:
properties:
environmentName:
type: string
- description: The name of the environment
+ description: The name of the environment.
databaseName:
type: string
- description: The name of the database
+ description: The name of the database.
tableName:
type: string
- description: Table name
+ description: The table name.
commandId:
type: integer
format: int64
- description: Command Id
+ description: The submitted Command ID of the snapshots.
fromCreationTime:
type: string
format: date-time
- description: The starting snapshot creation time to search snapshots (inclusive).
+ description: The creation time of the snapshots to search (inclusive).
toCreationTime:
type: string
format: date-time
- description: The ending snapshot creation time to search snapshots (inclusive).
+ description: The ending time of the snapshot creation to search (inclusive).
ListSnapshotsResponse:
type: object
description: Show Snapshots Response.
@@ -1641,21 +1690,21 @@ definitions:
properties:
environmentName:
type: string
- description: The name of the environment
+ description: The name of the environment.
databaseName:
type: string
- description: The name of the database
+ description: The name of the database.
snapshots:
type: array
items:
$ref: '#/definitions/Snapshot'
- description: List of snapshots
+ description: List of snapshots.
status:
- description: Status
+ description: The status of the list snapshots.
$ref: '#/definitions/SnapshotStatusType'
statusReason:
type: string
- description: Reason for the status
+ description: Reason for the status.
ListRestoreSnapshotsRequest:
type: object
description: Show Restore Snapshots Request.
@@ -1665,23 +1714,23 @@ definitions:
properties:
environmentName:
type: string
- description: The name of the environment
+ description: The name of the environment.
databaseName:
type: string
- description: The name of the database
+ description: The name of the database.
snapshotName:
type: string
- description: Snapshot Name
+ description: The name of the snapshot.
targetEnvironmentName:
type: string
- description: The name of the target environment
+ description: The name of the target environment.
targetDatabaseName:
type: string
- description: The name of the target database
+ description: The name of the target database.
commandId:
type: integer
format: int64
- description: Command Id
+ description: The submitted Command ID of the snapshot.
fromRestoreTime:
type: string
format: date-time
@@ -1696,24 +1745,24 @@ definitions:
properties:
snapshotName:
type: string
- description: The snapshot name
+ description: The name of the snapshot.
targetEnvironmentName:
type: string
- description: The name of the target environment
+ description: The name of the target environment.
targetDatabaseName:
type: string
- description: The name of the target database
+ description: The name of the target database.
status:
- description: Status
+ description: The status of the restore snapshot.
$ref: '#/definitions/SnapshotStatusType'
restoreTime:
type: integer
format: int64
- description: When the snapshot restore was started
+ description: The time when the snapshot restore was started.
commandID:
type: integer
format: int64
- description: Command id
+ description: The submitted Command ID of the restore snapshot.
failureReason:
type: string
description: Reason for the failure in case of restore snapshot failed.
@@ -2430,6 +2479,53 @@ definitions:
enum:
- GATEWAY
- MASTER
+ ListCertificatesRequest:
+ type: object
+ description: The request of listing SHA-1 fingerprints of certificates in Global Trust Store
+ required:
+ - environment
+ - database
+ properties:
+ environment:
+ type: string
+ description: The name or CRN of the environment.
+ database:
+ type: string
+ description: The name or CRN of the database.
+ ListCertificatesResponse:
+ type: object
+ description: The response of listing fingerprints of certificates in Global Trust Store
+ properties:
+ fingerprints:
+ type: array
+ items:
+ type: string
+ description: List of certificate SHA-1 fingerprints in Global Trust Store
+ UploadCertificateRequest:
+ type: object
+ description: The request of uploading a custom certificate to Global Trust Store
+ required:
+ - environment
+ - database
+ - certificate
+ properties:
+ environment:
+ type: string
+ description: The name or CRN of the environment.
+ database:
+ type: string
+ description: The name or CRN of the database.
+ certificate:
+ type: string
+ description: Custom certificate in PEM format
+ x-sensitive: true
+ UploadCertificateResponse:
+ type: object
+ description: The response of uploading a custom certificate to Global Trust Store
+ properties:
+ fingerprint:
+ type: string
+ description: SHA-1 fingerprint of the newly added certificate
ListSupportedInstanceTypesRequest:
type: object
description: The request for listing supported instance types.
@@ -2457,7 +2553,7 @@ definitions:
type: object
description: The response for listing supported instance types.
properties:
- supportedInstanceTypesLists:
+ supportedInstances:
type: array
items:
$ref: '#/definitions/SupportedInstanceTypesList'
@@ -2473,6 +2569,8 @@ definitions:
type: string
description: The default instance type.
supportedInstanceTypes:
- type: string
+ type: array
+ items:
+ type: string
description: The other instance types supported.
x-audit: true
diff --git a/api-docs-beta/swagger/replicationmanager.yaml b/api-docs-beta/swagger/replicationmanager.yaml
index bade37125..60b34d351 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.126 (BETA)
+ version: 0.9.127 (BETA)
title: Cloudera Replication Manager Service
license:
name: Apache 2.0
| |