From 971febe3a56937a594182af31c79d377af83a0b0 Mon Sep 17 00:00:00 2001 From: SRE Service Date: Tue, 10 Dec 2024 07:16:33 -0800 Subject: [PATCH] CDP Beta API Documentation 0.9.127 --- api-docs-beta/CHANGELOG.md | 14 + api-docs-beta/README.md | 40 +- api-docs-beta/audit/index.html | 4 +- api-docs-beta/cloudprivatelinks/index.html | 4 +- api-docs-beta/compute/index.html | 710 ++++++++++++++++- api-docs-beta/consumption/index.html | 4 +- api-docs-beta/datacatalog/index.html | 4 +- api-docs-beta/datahub/index.html | 283 +++++-- api-docs-beta/datalake/index.html | 267 +++++-- api-docs-beta/de/index.html | 6 +- api-docs-beta/df/index.html | 4 +- api-docs-beta/dfworkload/index.html | 4 +- api-docs-beta/drscp/index.html | 4 +- api-docs-beta/dw/index.html | 147 ++-- api-docs-beta/environments/index.html | 30 +- api-docs-beta/iam/index.html | 4 +- api-docs-beta/imagecatalog/index.html | 4 +- api-docs-beta/metrics/index.html | 4 +- api-docs-beta/ml/index.html | 16 +- api-docs-beta/opdb/index.html | 732 +++++++++++++----- api-docs-beta/replicationmanager/index.html | 4 +- api-docs-beta/swagger/README.md | 40 +- api-docs-beta/swagger/audit.yaml | 2 +- api-docs-beta/swagger/cloudprivatelinks.yaml | 2 +- api-docs-beta/swagger/compute.yaml | 177 ++++- api-docs-beta/swagger/consumption.yaml | 2 +- api-docs-beta/swagger/datacatalog.yaml | 2 +- api-docs-beta/swagger/datahub.yaml | 43 +- api-docs-beta/swagger/datalake.yaml | 43 +- api-docs-beta/swagger/de.yaml | 4 +- api-docs-beta/swagger/df.yaml | 2 +- api-docs-beta/swagger/dfworkload.yaml | 2 +- api-docs-beta/swagger/drscp.yaml | 2 +- api-docs-beta/swagger/dw.yaml | 71 +- api-docs-beta/swagger/environments.yaml | 10 +- api-docs-beta/swagger/iam.yaml | 4 +- api-docs-beta/swagger/imagecatalog.yaml | 2 +- api-docs-beta/swagger/metrics.yaml | 2 +- api-docs-beta/swagger/ml.yaml | 5 +- api-docs-beta/swagger/opdb.yaml | 250 ++++-- api-docs-beta/swagger/replicationmanager.yaml | 2 +- 41 files changed, 2398 insertions(+), 558 deletions(-) diff --git a/api-docs-beta/CHANGELOG.md b/api-docs-beta/CHANGELOG.md index c7d3f5d18..75294b9a1 100644 --- a/api-docs-beta/CHANGELOG.md +++ b/api-docs-beta/CHANGELOG.md @@ -1,5 +1,19 @@ # CDP Control Plane Public API Changelog +## 0.9.127 (2024-12-06) +* compute: Add `resume-cluster` and `suspend-cluster` commands. +* dw: Deprecate property `downloadOptions` in `CreateClusterDiagnosticDataJobRequest` object. +* dw: the Cluster EOL Support information is available under `list-clusters` and `describe-cluster` command's `productSupport` field. +* dw: the `instanceType` field made available in the `create-vw`, `list-vws`, `describe-vw` commands. +* environments: Add property `operationId` in `InitializeAzureComputeClusterResponse` and `InitializeAWSComputeClusterResponse` objects. +* ml: Remove property `mlVersion` from `CreateWorkspaceRequest` object. +* opdb: Add `create-snapshot`, `delete-snapshot`, `list-restore-snapshots`, `list-snapshots`, and `restore-snapshot` commands. + +BACKWARD INCOMPATIBILITIES: +* dw: The `additionalInstanceTypes` field has been removed from the `create-cluster`, `create-aws-cluster`, `create-azure-cluster` commands in favor of the `instanceType` field in `create-vw` command. +* dw: The `templateName` filed has been renamed to `resourceTemplate` in the `create-data-visualization` command. +* dw: The `template` field has been removed in favor of `tShirtSize` in the `create-vw`, `update-vw` commands. + ## 0.9.126 (2024-11-13) * cloudprivatelinks: Add properties `subscriptionId` and `cloudServiceProvider` to `AuthorizePrivateLinkServiceAccessRequest` and `RevokePrivateLinkServiceAccessRequest` objects. * datahub: Change description of property `type` in `Recipe`, `RecipeSummary` and `CreateRecipeRequest` objects. diff --git a/api-docs-beta/README.md b/api-docs-beta/README.md index cc245cdff..bb08455ad 100644 --- a/api-docs-beta/README.md +++ b/api-docs-beta/README.md @@ -1,30 +1,30 @@ # CDP Control Plane Public API Documentation -*Version: 0.9.126 (BETA)* +*Version: 0.9.127 (BETA)* Available documentation is listed by service below. | Service | Version | | --- | --- | -| [audit](./audit/index.html) | 0.9.126 | -| [cloudprivatelinks](./cloudprivatelinks/index.html) | 0.9.126 | -| [compute](./compute/index.html) | 0.9.126 | -| [consumption](./consumption/index.html) | 0.9.126 | -| [datacatalog](./datacatalog/index.html) | 0.9.126 | -| [datahub](./datahub/index.html) | 0.9.126 | -| [datalake](./datalake/index.html) | 0.9.126 | -| [de](./de/index.html) | 0.9.126 | -| [df](./df/index.html) | 0.9.126 | -| [dfworkload](./dfworkload/index.html) | 0.9.126 | -| [drscp](./drscp/index.html) | 0.9.126 | -| [dw](./dw/index.html) | 0.9.126 | -| [environments](./environments/index.html) | 0.9.126 | -| [iam](./iam/index.html) | 0.9.126 | -| [imagecatalog](./imagecatalog/index.html) | 0.9.126 | -| [metrics](./metrics/index.html) | 0.9.126 | -| [ml](./ml/index.html) | 0.9.126 | -| [opdb](./opdb/index.html) | 0.9.126 | -| [replicationmanager](./replicationmanager/index.html) | 0.9.126 | +| [audit](./audit/index.html) | 0.9.127 | +| [cloudprivatelinks](./cloudprivatelinks/index.html) | 0.9.127 | +| [compute](./compute/index.html) | 0.9.127 | +| [consumption](./consumption/index.html) | 0.9.127 | +| [datacatalog](./datacatalog/index.html) | 0.9.127 | +| [datahub](./datahub/index.html) | 0.9.127 | +| [datalake](./datalake/index.html) | 0.9.127 | +| [de](./de/index.html) | 0.9.127 | +| [df](./df/index.html) | 0.9.127 | +| [dfworkload](./dfworkload/index.html) | 0.9.127 | +| [drscp](./drscp/index.html) | 0.9.127 | +| [dw](./dw/index.html) | 0.9.127 | +| [environments](./environments/index.html) | 0.9.127 | +| [iam](./iam/index.html) | 0.9.127 | +| [imagecatalog](./imagecatalog/index.html) | 0.9.127 | +| [metrics](./metrics/index.html) | 0.9.127 | +| [ml](./ml/index.html) | 0.9.127 | +| [opdb](./opdb/index.html) | 0.9.127 | +| [replicationmanager](./replicationmanager/index.html) | 0.9.127 | API documentation uses the Adoc Riak stylesheet from [https://github.com/darshandsoni/asciidoctor-skins](https://github.com/darshandsoni/asciidoctor-skins). diff --git a/api-docs-beta/audit/index.html b/api-docs-beta/audit/index.html index bd7ff5832..687254e0c 100644 --- a/api-docs-beta/audit/index.html +++ b/api-docs-beta/audit/index.html @@ -822,7 +822,7 @@

Overview

Version information

-

Version : 0.9.126 (BETA)

+

Version : 0.9.127 (BETA)

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

MarkArchiveBatchesAsSuccessfulR


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

Overview

Version information

-

Version : 0.9.126 (BETA)

+

Version : 0.9.127 (BETA)

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

RevokePrivateLinkServiceAccessRes


diff --git a/api-docs-beta/compute/index.html b/api-docs-beta/compute/index.html index f400052e9..9715a1874 100644 --- a/api-docs-beta/compute/index.html +++ b/api-docs-beta/compute/index.html @@ -781,34 +781,48 @@

Cloudera Compute Service

  • Responses
    • -
  • Rollbacks a deployment to a previous revision +
  • Resume Cluster
    • -
  • Update cluster +
  • Rollbacks a deployment to a previous revision
    • -
  • Upgrades a deployment to a different chart. +
  • Suspend Cluster
    • -
  • Validate compute cluster +
  • Update cluster
    • +
  • Upgrades a deployment to a different chart. + +
    • +
  • Validate compute cluster + +
  • Definitions @@ -821,6 +835,10 @@

    Cloudera Compute Service

  • AksPoolInstance
  • AksState
  • AvailableDeploymentUpgrade
    • +
  • AzureSecretEncryption
    • +
  • AzureSecretEncryptionResp
    • +
  • AzureVolumeEncryption
    • +
  • AzureVolumeEncryptionResp
  • Chart
  • CommonAlertmanagerResp
  • CommonApiServer
    • @@ -893,8 +911,12 @@

    Cloudera Compute Service

  • ListDeploymentsResponse
  • ListUsersRequest
  • ListUsersResponse
    • +
  • ResumeClusterRequest
    • +
  • ResumeClusterResponse
  • RollbackDeploymentRequest
  • RollbackDeploymentResponse
    • +
  • SuspendClusterRequest
    • +
  • SuspendClusterResponse
  • UpdateClusterRequest
  • UpdateClusterResponse
  • UpgradeDeploymentRequest
    • @@ -920,7 +942,7 @@

    Overview

    Version information

    -

    Version : 0.9.126 (BETA)

    +

    Version : 0.9.127 (BETA)

    @@ -2080,6 +2102,92 @@

    Responses

    +

    Resume Cluster

    +
    +
    +
    POST /api/v1/compute/resumeCluster
    +
    +
    +
    +

    Description

    +
    +

    Resumes the compute cluster

    +
    +
    +
    +

    Parameters

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

    Body

    +
    +

    input
    +required

    +
    +

    ResumeClusterRequest

    +
    +
    +
    +

    Responses

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

    200

    +
    +

    Expected response to a valid request.

    +
    +

    ResumeClusterResponse

    +
    +

    default

    +
    +

    The default response on an error.

    +
    +

    Error

    +
    +
    +
    +

    Rollbacks a deployment to a previous revision

    @@ -2087,13 +2195,13 @@

    Rollbacks a deployment to a previous revision

    -

    Description

    +

    Description

    This will perform a rollback.

    -

    Parameters

    +

    Parameters

    @@ -2124,7 +2232,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2166,6 +2274,92 @@

    Responses

    +

    Suspend Cluster

    +
    +
    +
    POST /api/v1/compute/suspendCluster
    +
    +
    +
    +

    Description

    +
    +

    Suspends the compute cluster

    +
    +
    +
    +

    Parameters

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

    Body

    +
    +

    input
    +required

    +
    +

    SuspendClusterRequest

    +
    +
    +
    +

    Responses

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

    200

    +
    +

    Expected response to a valid request.

    +
    +

    SuspendClusterResponse

    +
    +

    default

    +
    +

    The default response on an error.

    +
    +

    Error

    +
    +
    +
    +

    Update cluster

    @@ -2173,13 +2367,13 @@

    Update cluster

    -

    Description

    +

    Description

    Updates compute cluster.

    -

    Parameters

    +

    Parameters

    @@ -2210,7 +2404,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2259,13 +2453,13 @@

    Upgrades a deployment to a different chart.

    -

    Description

    +

    Description

    Upgrades a deployment to a different chart.

    -

    Parameters

    +

    Parameters

    @@ -2296,7 +2490,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2345,13 +2539,13 @@

    Validate compute cluster

    -

    Description

    +

    Description

    Validates compute cluster.

    -

    Parameters

    +

    Parameters

    @@ -2382,7 +2576,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -3061,6 +3255,18 @@

    AksPoolInstance

    string

    + + + + +
    +

    subnetId
    +optional

    +
    +

    Subnet ID.

    +
    +

    string

    +
    @@ -3505,6 +3711,166 @@

    AvailableDeploymentUpgrade

    +

    AzureSecretEncryption

    +
    +

    Azure Secret Encryption request structure.

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

    encryptionKeyUrl
    +optional

    +
    +

    Encryption key URI.

    +
    +

    string

    +
    +

    userManagedIdentity
    +optional

    +
    +

    Resource ID of the user managed identity.

    +
    +

    string

    +
    +
    +
    +

    AzureSecretEncryptionResp

    +
    +

    Azure Secret Encryption response structure.

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

    encryptionKeyUrl
    +optional

    +
    +

    Encryption key URI.

    +
    +

    string

    +
    +

    userManagedIdentity
    +optional

    +
    +

    Resource ID of the user managed identity.

    +
    +

    string

    +
    +
    +
    +

    AzureVolumeEncryption

    +
    +

    Azure Volume Encryption request structure.

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

    diskEncryptionSetId
    +optional

    +
    +

    Disk encryption set ID.

    +
    +

    string

    +
    +
    +
    +

    AzureVolumeEncryptionResp

    +
    +

    Azure Volume Encryption response structure.

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

    diskEncryptionSetId
    +optional

    +
    +

    Disk encryption set ID.

    +
    +

    string

    +
    +
    +

    Chart

    Chart structure.

    @@ -5217,6 +5583,18 @@

    CommonSecretEncryption

    +

    azure
    +optional

    +
    +
    +

    Azure secret encryption details.

    +
    +
    +

    AzureSecretEncryption

    +
    + + +

    customerKmsKeyArn
    optional

    @@ -5251,6 +5629,18 @@

    CommonSecretEncryptionResp

    +

    azure
    +optional

    +
    +
    +

    Azure secret encryption details.

    +
    +
    +

    AzureSecretEncryptionResp

    +
    + + +

    customerKmsKeyArn
    optional

    @@ -5697,8 +6087,20 @@

    CommonVolumeEncryption

    Description Schema - - + + + +
    +

    azure
    +optional

    +
    +
    +

    Azure volume encryption details.

    +
    +
    +

    AzureVolumeEncryption

    +
    +

    customerKmsKeyArn
    @@ -5735,6 +6137,18 @@

    CommonVolumeEncryptionResp

    +

    azure
    +optional

    +
    +
    +

    Azure volume encryption details.

    +
    +
    +

    AzureVolumeEncryptionResp

    +
    + + +

    customerKmsKeyArn
    optional

    @@ -6139,6 +6553,42 @@

    DeleteClusterRequest

    string

    + +
    +

    force
    +optional

    +
    +
    +

    Forces the cluster into the DELETED state without cleaning up resources; only valid if cluster is in DELETE_FAILED state.

    +
    +
    +

    boolean

    +
    + + +
    +

    skipValidation
    +optional

    +
    +
    +

    Whether to skip validation.

    +
    +
    +

    boolean

    +
    + + +
    +

    skipWorkloadsValidation
    +optional

    +
    +
    +

    Whether to skip the running workloads validation for externalized clusters

    +
    +
    +

    boolean

    +
    +
    @@ -6173,6 +6623,18 @@

    DeleteClusterResponse

    CommonStatusMessage

    + +
    +

    validationResponse
    +optional

    +
    +
    +

    Pre-flight validation check response. Only given on a validation failure.

    +
    +
    +

    ValidationResponse

    +
    + @@ -7205,6 +7667,18 @@

    EksInstance

    string

    + +
    +

    subnetId
    +optional

    +
    +
    +

    Subnet ID.

    +
    +
    +

    string

    +
    + @@ -9148,6 +9622,98 @@

    ListUsersResponse

    +

    ResumeClusterRequest

    +
    +

    Request structure to resume the compute cluster

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

    clusterCrn
    +required

    +
    +

    Compute cluster CRN.

    +
    +

    string

    +
    +

    skipValidation
    +optional

    +
    +

    Whether to skip validation.

    +
    +

    boolean

    +
    +
    +
    +

    ResumeClusterResponse

    +
    +

    Response structure for resuming the compute cluster

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

    clusterStatus
    +optional

    +
    +

    Cluster status.

    +
    +

    CommonStatusMessage

    +
    +

    validationResponse
    +optional

    +
    +

    Pre-flight validation check response. Only given on a validation failure and skipValidation is false.

    +
    +

    ValidationResponse

    +
    +
    +

    RollbackDeploymentRequest

    Request structure to rollback a deployment.

    @@ -9252,6 +9818,110 @@

    RollbackDeploymentResponse

    +

    SuspendClusterRequest

    +
    +

    Request structure to suspend the compute cluster

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

    clusterCrn
    +required

    +
    +

    Compute cluster CRN.

    +
    +

    string

    +
    +

    skipValidation
    +optional

    +
    +

    Whether to skip validation.

    +
    +

    boolean

    +
    +

    skipWorkloadsValidation
    +optional

    +
    +

    Whether to skip the running workloads validation for externalized clusters

    +
    +

    boolean

    +
    +
    +
    +

    SuspendClusterResponse

    +
    +

    Response structure for suspending the compute cluster

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

    clusterStatus
    +optional

    +
    +

    Cluster status.

    +
    +

    CommonStatusMessage

    +
    +

    validationResponse
    +optional

    +
    +

    Pre-flight validation check response. Only given on a validation failure and skipValidation is false.

    +
    +

    ValidationResponse

    +
    +
    +

    UpdateClusterRequest

    Update compute cluster request.

    @@ -10076,7 +10746,7 @@

    ValidationSummary


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

    Overview

    Version information

    -

    Version : 0.9.126 (BETA)

    +

    Version : 0.9.127 (BETA)

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

    ListComputeUsageRecordsResponse


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

    Overview

    Version information

    -

    Version : 0.9.126 (BETA)

    +

    Version : 0.9.127 (BETA)

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

    LaunchProfilersResponse


    diff --git a/api-docs-beta/datahub/index.html b/api-docs-beta/datahub/index.html index fb208fde6..8200c67ea 100644 --- a/api-docs-beta/datahub/index.html +++ b/api-docs-beta/datahub/index.html @@ -1089,97 +1089,104 @@

    Cloudera Data hub Service

  • Responses
    • -
  • Starts a stopped workload cluster. +
  • Configures the default Java version for the Data Hub.
    • -
  • Initiates the vertical scaling on Data Hub cluster. +
  • Starts a stopped workload cluster.
    • -
  • Upgrades the database of the Data Hub cluster. +
  • Initiates the vertical scaling on Data Hub cluster.
    • -
  • Starts instances of a particular host group in the Data Hub cluster. +
  • Upgrades the database of the Data Hub cluster.
    • -
  • Stops a workload cluster. +
  • Starts instances of a particular host group in the Data Hub cluster.
    • -
  • Stops instances of particular host group in the Data Hub cluster. +
  • Stops a workload cluster.
    • -
  • Synchronizes the state of a cluster with the cloud provider and Cloudera Manager. +
  • Stops instances of particular host group in the Data Hub cluster.
    • -
  • Syncs component versions from CM after a failed upgrade. +
  • Synchronizes the state of a cluster with the cloud provider and Cloudera Manager.
    • -
  • Modify AutoScaling for a DataHub cluster +
  • Syncs component versions from CM after a failed upgrade.
    • -
  • Run orchestrator engine state update on the Data Hub cluster. +
  • Modify AutoScaling for a DataHub cluster
    • -
  • Updates Data Hub AWS cluster to use IMDSv1. +
  • Run orchestrator engine state update on the Data Hub cluster.
    • -
  • Updates Data Hub AWS cluster to use IMDSv2. +
  • Updates Data Hub AWS cluster to use IMDSv1.
    • -
  • Upgrades the OS or data platform on a datahub cluster. +
  • Updates Data Hub AWS cluster to use IMDSv2.
    • +
  • Upgrades the OS or data platform on a datahub cluster. + +
  • Definitions @@ -1362,6 +1369,8 @@

    Cloudera Data hub Service

  • ServiceStatus
  • SetCatalogRequest
  • SetCatalogResponse
    • +
  • SetDefaultJavaVersionRequest
    • +
  • SetDefaultJavaVersionResponse
  • StackStatus
  • StartClusterRequest
  • StartClusterResponse
    • @@ -1406,7 +1415,7 @@

    Overview

    Version information

    -

    Version : 0.9.126 (BETA)

    +

    Version : 0.9.127 (BETA)

    @@ -6350,6 +6359,92 @@

    Responses

    +

    Configures the default Java version for the Data Hub.

    +
    +
    +
    POST /api/v1/datahub/setDefaultJavaVersion
    +
    +
    +
    +

    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.

    +
    +
    +
    +

    Parameters

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

    Body

    +
    +

    input
    +required

    +
    +

    SetDefaultJavaVersionRequest

    +
    +
    +
    +

    Responses

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

    200

    +
    +

    Expected response to a valid request.

    +
    +

    SetDefaultJavaVersionResponse

    +
    +

    default

    +
    +

    The default response on an error.

    +
    +

    Error

    +
    +
    +
    +

    Starts a stopped workload cluster.

    @@ -6357,13 +6452,13 @@

    Starts a stopped workload cluster.

    -

    Description

    +

    Description

    Starts a stopped workload cluster.

    -

    Parameters

    +

    Parameters

    @@ -6394,7 +6489,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6443,13 +6538,13 @@

    Initiates the vertical scaling on Data Hub
    -

    Description

    +

    Description

    Initiates the vertical scaling on Data Hub cluster. You have the option to either specify one of 'modifyDisks' or 'instanceTemplate' as parameter.

    -

    Parameters

    +

    Parameters

    @@ -6480,7 +6575,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6529,13 +6624,13 @@

    Upgrades the database of the Data Hub cluster.
    -

    Description

    +

    Description

    This command initiates the upgrade of the database of the Data Hub cluster.

    -

    Parameters

    +

    Parameters

    @@ -6566,7 +6661,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6615,13 +6710,13 @@

    Starts instances of a particular host group in the Data
    -

    Description

    +

    Description

    Starts instances of a particular host group in the Data Hub cluster.

    -

    Parameters

    +

    Parameters

    @@ -6652,7 +6747,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6701,13 +6796,13 @@

    Stops a workload cluster.

    -

    Description

    +

    Description

    Stops a workload cluster. When a cluster is put in the stopped state, cluster VMs are given back to the cloud provider. To provision new VMs, start the cluster.

    -

    Parameters

    +

    Parameters

    @@ -6738,7 +6833,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6787,13 +6882,13 @@

    Stops instances of particular host group in the Data Hub
    -

    Description

    +

    Description

    Stops instances of a particular host group in the Data Hub cluster.

    -

    Parameters

    +

    Parameters

    @@ -6824,7 +6919,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6873,13 +6968,13 @@

    Synchronizes the state of a cluster with the cloud provide
    -

    Description

    +

    Description

    Synchronizes the state of a cluster with the cloud provider and Cloudera Manager.

    -

    Parameters

    +

    Parameters

    @@ -6910,7 +7005,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6959,13 +7054,13 @@

    Syncs component versions from CM after a f
    -

    Description

    +

    Description

    Syncs component versions from CM after a failed upgrade.

    -

    Parameters

    +

    Parameters

    @@ -6996,7 +7091,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7045,13 +7140,13 @@

    Modify AutoScaling for a DataHub cluster

    -

    Description

    +

    Description

    Modify AutoScaling for a DataHub cluster

    -

    Parameters

    +

    Parameters

    @@ -7082,7 +7177,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7131,13 +7226,13 @@

    Run orchestrator engine state update on the Da
    -

    Description

    +

    Description

    Run orchestrator engine state update on the Data Hub cluster.

    -

    Parameters

    +

    Parameters

    @@ -7168,7 +7263,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7217,13 +7312,13 @@

    Updates Data Hub AWS cluster to use IMDSv1.

    -

    Description

    +

    Description

    Updates Data Hub AWS cluster to use IMDSv1.

    -

    Parameters

    +

    Parameters

    @@ -7254,7 +7349,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7303,13 +7398,13 @@

    Updates Data Hub AWS cluster to use IMDSv2.

    -

    Description

    +

    Description

    Updates Data Hub AWS cluster to use IMDSv2.

    -

    Parameters

    +

    Parameters

    @@ -7340,7 +7435,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7389,13 +7484,13 @@

    Upgrades the OS or data platform on a datahub cluster.<
    -

    Description

    +

    Description

    Upgrades the OS or data platform on a datahub cluster. You have the option to either specify one of 'imageId', 'runtime' or 'lockComponents' or both 'imageId' and 'lockComponents' or none of the parameters.

    -

    Parameters

    +

    Parameters

    @@ -7426,7 +7521,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -18242,6 +18337,86 @@

    SetCatalogResponse

    +

    SetDefaultJavaVersionRequest

    +
    +

    Request object for setting the default Java version on the Data Hub cluster.

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

    clusterCrn
    +required

    +
    +

    The CRN of the Data Hub cluster.

    +
    +

    string

    +
    +

    javaVersion
    +required

    +
    +

    The Java version to set as default.

    +
    +

    string

    +
    +
    +
    +

    SetDefaultJavaVersionResponse

    +
    +

    Response object for setting the default Java version on the Data Hub cluster.

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

    operationId
    +optional

    +
    +

    The id of the related operation.

    +
    +

    string

    +
    +
    +

    StackStatus

    Status of the stack.

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

    VolumeEncryptionRequest


    diff --git a/api-docs-beta/datalake/index.html b/api-docs-beta/datalake/index.html index 129f9806d..4f825c32b 100644 --- a/api-docs-beta/datalake/index.html +++ b/api-docs-beta/datalake/index.html @@ -984,83 +984,90 @@

    Cloudera Datalake Service

  • Responses
    • -
  • Upgrades the database of the Data Lake cluster. +
  • Configures the default Java version for the Data Lake.
    • -
  • Start Datalake +
  • Upgrades the database of the Data Lake cluster.
    • -
  • Initiates the vertical scaling on Data Lake. +
  • Start Datalake
    • -
  • Stop Datalake +
  • Initiates the vertical scaling on Data Lake.
    • -
  • Syncs component versions from CM after a failed upgrade. +
  • Stop Datalake
    • -
  • Run orchestrator engine state update on the Data Lake cluster. +
  • Syncs component versions from CM after a failed upgrade.
    • -
  • Updates Data Lake AWS cluster to use IMDSv1. +
  • Run orchestrator engine state update on the Data Lake cluster.
    • -
  • Updates Data Lake AWS cluster to use IMDSv2. +
  • Updates Data Lake AWS cluster to use IMDSv1.
    • -
  • OS or data platform upgrade for the SDX cluster. +
  • Updates Data Lake AWS cluster to use IMDSv2.
    • -
  • Validates AWS cloud storage. +
  • OS or data platform upgrade for the SDX cluster.
    • -
  • Validates Azure cloud storage. +
  • Validates AWS cloud storage.
    • +
  • Validates Azure cloud storage. + +
  • Definitions @@ -1202,6 +1209,8 @@

    Cloudera Datalake Service

  • ServiceStatus
  • SetCatalogRequest
  • SetCatalogResponse
    • +
  • SetDefaultJavaVersionRequest
    • +
  • SetDefaultJavaVersionResponse
  • SolrBackupRestoreState
  • StartDatabaseUpgradeRequest
  • StartDatabaseUpgradeResponse
    • @@ -1240,7 +1249,7 @@

    Overview

    Version information

    -

    Version : 0.9.126 (BETA)

    +

    Version : 0.9.127 (BETA)

    @@ -4894,6 +4903,92 @@

    Responses

    +

    Configures the default Java version for the Data Lake.

    +
    +
    +
    POST /api/v1/datalake/setDefaultJavaVersion
    +
    +
    +
    +

    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.

    +
    +
    +
    +

    Parameters

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

    Body

    +
    +

    input
    +required

    +
    +

    SetDefaultJavaVersionRequest

    +
    +
    +
    +

    Responses

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

    200

    +
    +

    Expected response to a valid request.

    +
    +

    SetDefaultJavaVersionResponse

    +
    +

    default

    +
    +

    The default response on an error.

    +
    +

    Error

    +
    +
    +
    +

    Upgrades the database of the Data Lake cluster.

    @@ -4901,13 +4996,13 @@

    Upgrades the database of the Data Lake cluster.

    -

    Description

    +

    Description

    This command initiates the upgrade of the database of the Data Lake cluster.

    -

    Parameters

    +

    Parameters

    @@ -4938,7 +5033,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -4987,13 +5082,13 @@

    Start Datalake

    -

    Description

    +

    Description

    Deprecated, please use 'cdp environments start-environment' instead.

    -

    Parameters

    +

    Parameters

    @@ -5024,7 +5119,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -5073,13 +5168,13 @@

    Initiates the vertical scaling on Data La
    -

    Description

    +

    Description

    Initiates the vertical scaling on Data Lake. You have the option to specify 'modifyDisks' or 'instanceTemplate' as parameter.

    -

    Parameters

    +

    Parameters

    @@ -5110,7 +5205,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -5159,13 +5254,13 @@

    Stop Datalake

    -

    Description

    +

    Description

    Deprecated, please use 'cdp environments stop-environment' instead.

    -

    Parameters

    +

    Parameters

    @@ -5196,7 +5291,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -5245,13 +5340,13 @@

    Syncs component versions from CM after a f
    -

    Description

    +

    Description

    Syncs component versions from CM after a failed upgrade.

    -

    Parameters

    +

    Parameters

    @@ -5282,7 +5377,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -5331,13 +5426,13 @@

    Run orchestrator engine state update on the Da
    -

    Description

    +

    Description

    Run orchestrator engine state update on the Data Lake cluster.

    -

    Parameters

    +

    Parameters

    @@ -5368,7 +5463,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -5417,13 +5512,13 @@

    Updates Data Lake AWS cluster to use IMDSv1.

    -

    Description

    +

    Description

    Updates Data Lake AWS cluster to use IMDSv1.

    -

    Parameters

    +

    Parameters

    @@ -5454,7 +5549,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -5503,13 +5598,13 @@

    Updates Data Lake AWS cluster to use IMDSv2.

    -

    Description

    +

    Description

    Updates Data Lake AWS cluster to use IMDSv2.

    -

    Parameters

    +

    Parameters

    @@ -5540,7 +5635,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -5589,13 +5684,13 @@

    OS or data platform upgrade for the SDX cluster.

    -

    Description

    +

    Description

    OS or data platform upgrade for the SDX cluster. You have the option to either specify one of 'imageId', 'runtime' or 'lockComponents' or both 'imageId' and 'lockComponents' or none of the parameters.

    -

    Parameters

    +

    Parameters

    @@ -5626,7 +5721,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -5675,13 +5770,13 @@

    Validates AWS cloud storage.

    -

    Description

    +

    Description

    Validates AWS cloud storage for Data Lake.

    -

    Parameters

    +

    Parameters

    @@ -5712,7 +5807,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -5761,13 +5856,13 @@

    Validates Azure cloud storage.

    -

    Description

    +

    Description

    Validates Azure cloud storage for Data Lake.

    -

    Parameters

    +

    Parameters

    @@ -5798,7 +5893,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -13737,6 +13832,86 @@

    SetCatalogResponse

    +

    SetDefaultJavaVersionRequest

    +
    +

    Request object for setting the default Java version on the Data Lake cluster.

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

    crn
    +required

    +
    +

    The CRN of the Data Lake cluster.

    +
    +

    string

    +
    +

    javaVersion
    +required

    +
    +

    The default Java version to be set on the Data Lake cluster.

    +
    +

    string

    +
    +
    +
    +

    SetDefaultJavaVersionResponse

    +
    +

    Response object for setting the default Java version on the Data Lake cluster.

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

    operationId
    +optional

    +
    +

    The id of the related operation.

    +
    +

    string

    +
    +
    +

    SolrBackupRestoreState

    The state of each Solr backup/restore operation.

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

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

    Overview

    Version information

    -

    Version : 0.9.126 (BETA)

    +

    Version : 0.9.127 (BETA)

    @@ -5642,7 +5642,7 @@

    RestoreServiceRequest

    optional

    -

    Specify the restored service ID. If not specified, the service ID from the backup will be reused.

    +

    Specify the restored service ID. If not specified, a new service ID will be generated.

    string

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

    VcSummary


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

    Overview

    Version information

    -

    Version : 0.9.126 (BETA)

    +

    Version : 0.9.127 (BETA)

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

    UpgradeServiceResponse


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

    Overview

    Version information

    -

    Version : 0.9.126 (BETA)

    +

    Version : 0.9.127 (BETA)

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

    ValidateCustomPythonConfigur


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

    Overview

    Version information

    -

    Version : 0.9.126 (BETA)

    +

    Version : 0.9.127 (BETA)

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

    SimpleRestore


    diff --git a/api-docs-beta/dw/index.html b/api-docs-beta/dw/index.html index 1747f4d8f..079e58178 100644 --- a/api-docs-beta/dw/index.html +++ b/api-docs-beta/dw/index.html @@ -1362,6 +1362,7 @@

    Cloudera Data Warehouse [EXPERIMENTAL]

  • CloudUserReference
  • ClusterCreateDiagnosticDataDownloadOptions
  • ClusterDiagnosticDataJob
    • +
  • ClusterSummaryProductSupportResponse
  • ClusterSummaryResponse
  • ConfigBlock
  • ConfigBlockDiff
    • @@ -1627,7 +1628,7 @@

    Overview

    Version information

    -

    Version : 0.9.126 (BETA)

    +

    Version : 0.9.127 (BETA)

    @@ -9788,6 +9789,18 @@

    AllowedInstanceTypes

    AllowedInstanceTypesWithDefault

    + +
    +

    trino
    +optional

    +
    +
    +

    Allowed instance types for Trino Virtual Warehouses.

    +
    +
    +

    AllowedInstanceTypesWithDefault

    +
    +
    @@ -10768,18 +10781,6 @@

    AwsActivationOptions

    -

    additionalInstanceTypes
    -optional

    -
    -
    -

    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.

    -
    -
    -

    < string > array

    -
    - - -

    computeInstanceTypes
    optional

    @@ -11648,7 +11649,7 @@

    CloudUserReference

    ClusterCreateDiagnosticDataDownloadOptions

    -

    Flags that denote which diagnostics to include for the cluster.

    +

    DEPRECATED: Included by default, no need to specify

    @@ -11814,9 +11815,9 @@

    ClusterDiagnosticDataJob

    -

    ClusterSummaryResponse

    +

    ClusterSummaryProductSupportResponse

    -

    A Cloudera Data Warehouse cluster.

    +

    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.

    @@ -11834,18 +11835,64 @@

    ClusterSummaryResponse

    + + + + + + + + + +
    -

    additionalInstanceTypes
    +

    expiryDate
    optional
    -

    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.

    +

    Shows the expiration date of the support for this Cluster version.
    -

    < string > array

    +

    string (date-time)
    +

    message
    +optional

    +
    +

    Message.

    +
    +

    string

    +
    +

    status
    +optional

    +
    +

    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.

    +
    +

    string

    +
    +
    +
    +

    ClusterSummaryResponse

    +
    +

    A Cloudera Data Warehouse cluster.

    +
    + +++++ + + + + + + + + + + @@ -12024,6 +12071,18 @@

    ClusterSummaryResponse

    + + + + + @@ -12863,18 +12922,6 @@

    CreateAwsClusterRequest

    - - - - - @@ -13660,7 +13707,7 @@

    CreateClusterDiagnosticDataJobRe optional

    @@ -22461,7 +22508,7 @@

    RestoreClusterRequest

    required

    + + + + +
    NameDescriptionSchema

    awsOptions
    optional
    +

    productSupport
    +optional

    +
    +

    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.

    +
    +

    ClusterSummaryProductSupportResponse

    +

    reservedComputeNodes
    optional
    -

    additionalInstanceTypes
    -optional

    -
    -

    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.

    -
    -

    < string > array

    -

    computeInstanceTypes
    optional

    -

    Cluster diagnostic options. If not provided, everything will be included in the Diagnostic Data.

    +

    DEPRECATED: All logs are included by default. No need to specify options

    ClusterCreateDiagnosticDataDownloadOptions

    @@ -14107,11 +14154,11 @@

    CreateDataVisualizationRequest

    -

    templateName
    +

    resourceTemplate
    optional
    -

    DEPRECATED: Use resourceTemplate parameter instead that will be made available in the upcoming release. The template size for the Cloudera Data Visualization.

    +

    The name of the available resource template to use for the Cloudera Data Visualization.

    string

    @@ -15279,26 +15326,26 @@

    CreateVwRequest

    -

    tags
    +

    tShirtSize
    optional
    -

    Tags associated with the resources.

    +

    Name of T-shirt size to use, which will determine the number of nodes.
    -

    < TagRequest > array

    +

    enum (xsmall, small, medium, large)
    -

    template
    +

    tags
    optional
    -

    DEPRECATED: It will be replaced by the tShirtSize parameter in an upcoming release. Name of configuration template to use.

    +

    Tags associated with the resources.
    -

    enum (xsmall, small, medium, large)

    +

    < TagRequest > array
    -

    Dump of configuration received by calling "dump-cluster" command.

    +

    Backup data of configuration received by calling "backup-cluster" command.

    string

    @@ -24984,11 +25031,11 @@

    UpdateVwRequest

    -

    template
    +

    tShirtSize
    optional
    -

    DEPRECATED: It will be replaced by the tShirtSize parameter in an upcoming release. Name of configuration template to use.

    +

    Name of T-shirt size to use, which will determine the number of nodes.

    enum (xsmall, small, medium, large)

    @@ -26272,6 +26319,18 @@

    VwSummary

    integer (int32)
    +

    trinoCli
    +optional

    +
    +

    Command-line client that connects to Trino Virtual Warehouse to execute SQL queries.

    +
    +

    string

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

    VwType


    diff --git a/api-docs-beta/environments/index.html b/api-docs-beta/environments/index.html index eb9e188e6..e7ff204dc 100644 --- a/api-docs-beta/environments/index.html +++ b/api-docs-beta/environments/index.html @@ -1692,7 +1692,7 @@

    Overview

    Version information

    -

    Version : 0.9.126 (BETA)

    +

    Version : 0.9.127 (BETA)

    @@ -15441,6 +15441,32 @@

    Credential

    GCPCredentialProperties

    + +
    +

    skipOrgPolicyDecisions
    +optional

    +
    +
    +

    Skips organization policy decisions during cloud storage validation.
    +Default : false

    +
    +
    +

    boolean

    +
    + + +
    +

    verifyPermissions
    +optional

    +
    +
    +

    When true, verifies credential permissions.
    +Default : false

    +
    +
    +

    boolean

    +
    +
    @@ -26284,7 +26310,7 @@

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

    Overview

    Version information

    -

    Version : 0.9.126 (BETA)

    +

    Version : 0.9.127 (BETA)

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

    WorkloadPasswordPolicy


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

    Overview

    Version information

    -

    Version : 0.9.126 (BETA)

    +

    Version : 0.9.127 (BETA)

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

    VmImageType


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

    Overview

    Version information

    -

    Version : 0.9.126 (BETA)

    +

    Version : 0.9.127 (BETA)

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

    UpdateRemoteWriteConfigResponse


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

    Overview

    Version information

    -

    Version : 0.9.126 (BETA)

    +

    Version : 0.9.127 (BETA)

    @@ -6674,18 +6674,6 @@

    CreateWorkspaceRequest

    -

    mlVersion
    -optional

    -
    -
    -

    The version of ML workload app to install.

    -
    -
    -

    string

    -
    - - -

    nfsVersion
    optional

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

    WorkspaceSummary


    diff --git a/api-docs-beta/opdb/index.html b/api-docs-beta/opdb/index.html index d97e36def..f6afe39b3 100644 --- a/api-docs-beta/opdb/index.html +++ b/api-docs-beta/opdb/index.html @@ -711,14 +711,14 @@

    Operational Database service

  • Responses
    • -
  • Creates a snapshot for a specific table +
  • Creates a snapshot for a specific table.
    • -
  • Deletes a snapshot +
  • Deletes a snapshot.
    • -
  • Lists coprocessors in a database +
  • List certificates
    • -
  • List all opDbs in an environment +
  • Lists coprocessors in a database
    • -
  • List all diagnostics associated to the database +
  • List all opDbs in an environment
    • -
  • Lists edge nodes in a database +
  • List all diagnostics associated to the database
    • -
  • Lists events +
  • Lists edge nodes in a database
    • -
  • Lists instances when a snapshot was restored to a database +
  • Lists events
    • -
  • Lists scaling events +
  • Lists instances when a snapshot was restored to a database.
    • -
  • Shows snapshot for a table name in a specific location +
  • Lists scaling events
    • -
  • List of environments available for the database creation +
  • Shows snapshot for a table name in a specific location.
    • -
  • Lists instance types supported by COD +
  • List of environments available for the database creation
    • -
  • Prepare database upgrade. +
  • Lists instance types supported by COD
    • -
  • Removes a coprocessor for a specific table +
  • Prepare database upgrade.
    • -
  • Restores a snapshot +
  • Removes a coprocessor for a specific table
    • -
  • Starts the database +
  • Restores a snapshot.
    • -
  • Stops the database +
  • Starts the database
    • -
  • Updates the database +
  • Stops the database
    • -
  • Update edge nodes in a database +
  • Updates the database
    • -
  • Updates the configuration of HBase. +
  • Update edge nodes in a database
    • -
  • Upgrades the database. +
  • Updates the configuration of HBase.
    • +
  • Upgrades the database. + +
    • +
  • Upload custom certificate + +
  • Definitions @@ -948,6 +962,8 @@

    Operational Database service

  • KerberosConfiguration
  • KeyValuePair
  • Kind
    • +
  • ListCertificatesRequest
    • +
  • ListCertificatesResponse
  • ListCoprocessorsRequest
  • ListCoprocessorsResponse
  • ListDatabasesRequest
    • @@ -995,6 +1011,8 @@

    Operational Database service

  • UpdateHbaseConfigurationResponse
  • UpgradeDatabaseRequest
  • UpgradeDatabaseResponse
    • +
  • UploadCertificateRequest
    • +
  • UploadCertificateResponse
  • VolumeEncryption
  • VolumeType
    • @@ -1012,7 +1030,7 @@

    Overview

    Version information

    -

    Version : 0.9.126 (BETA)

    +

    Version : 0.9.127 (BETA)

    @@ -1312,7 +1330,7 @@

    Responses

    -

    Creates a snapshot for a specific table

    +

    Creates a snapshot for a specific table.

    POST /api/v1/opdb/createSnapshot
    @@ -1321,7 +1339,7 @@

    Creates a snapshot for a specific table

    Description

    -

    Returns id state and creation time

    +

    Returns id state and creation time.

    @@ -1398,7 +1416,7 @@

    Responses

    -

    Deletes a snapshot

    +

    Deletes a snapshot.

    POST /api/v1/opdb/deleteSnapshot
    @@ -1407,7 +1425,7 @@

    Deletes a snapshot

    Description

    -

    Returns state of operation

    +

    Returns the snapshot that is deleted.

    @@ -1914,6 +1932,92 @@

    Responses

    +

    List certificates

    +
    +
    +
    POST /api/v1/opdb/listCertificates
    +
    +
    +
    +

    Description

    +
    +

    List SHA-1 fingerprints of certificates in Global Trust Store

    +
    +
    +
    +

    Parameters

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

    Body

    +
    +

    input
    +required

    +
    +

    ListCertificatesRequest

    +
    +
    +
    +

    Responses

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

    200

    +
    +

    Expected response to a valid request.

    +
    +

    ListCertificatesResponse

    +
    +

    default

    +
    +

    The default response on an error.

    +
    +

    Error

    +
    +
    +
    +

    Lists coprocessors in a database

    @@ -1921,13 +2025,13 @@

    Lists coprocessors in a database

    -

    Description

    +

    Description

    Lists coprocessors in a database.

    -

    Parameters

    +

    Parameters

    @@ -1958,7 +2062,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2007,13 +2111,13 @@

    List all opDbs in an environment

    -

    Description

    +

    Description

    Fetch a list of all operational databases in an environment

    -

    Parameters

    +

    Parameters

    @@ -2044,7 +2148,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2093,13 +2197,13 @@

    List all diagnostics associated to the database

    -

    Description

    +

    Description

    returns list of diagnostics collections

    -

    Parameters

    +

    Parameters

    @@ -2130,7 +2234,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2179,13 +2283,13 @@

    Lists edge nodes in a database

    -

    Description

    +

    Description

    Lists edge nodes in a database.

    -

    Parameters

    +

    Parameters

    @@ -2216,7 +2320,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2265,13 +2369,13 @@

    Lists events

    -

    Description

    +

    Description

    Lists events in reverse chronological order for an operational database.

    -

    Parameters

    +

    Parameters

    @@ -2302,7 +2406,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2344,20 +2448,20 @@

    Responses

    -

    Lists instances when a snapshot was restored to a database

    +

    Lists instances when a snapshot was restored to a database.

    POST /api/v1/opdb/listRestoreSnapshots
    -

    Description

    +

    Description

    Returns a list of snapshots restored into a database.

    -

    Parameters

    +

    Parameters

    @@ -2388,7 +2492,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2437,13 +2541,13 @@

    Lists scaling events

    -

    Description

    +

    Description

    Lists scaling events in reverse chronological order for an operational database.

    -

    Parameters

    +

    Parameters

    @@ -2474,7 +2578,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2516,20 +2620,20 @@

    Responses

    -

    Shows snapshot for a table name in a specific location

    +

    Shows snapshot for a table name in a specific location.

    POST /api/v1/opdb/listSnapshots
    -

    Description

    +

    Description

    -

    Returns list of snapshot names

    +

    Returns list of snapshot names.

    -

    Parameters

    +

    Parameters

    @@ -2560,7 +2664,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2609,13 +2713,13 @@

    List of environments available for the datab
    -

    Description

    +

    Description

    Fetches a list of environments available for the database creation

    -

    Parameters

    +

    Parameters

    @@ -2646,7 +2750,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2695,13 +2799,13 @@

    Lists instance types supported by COD

    -

    Description

    +

    Description

    Lists instance types supported by COD.

    -

    Parameters

    +

    Parameters

    @@ -2732,7 +2836,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2781,13 +2885,13 @@

    Prepare database upgrade.

    -

    Description

    +

    Description

    Running upgrade related validations and prepares the required parcels for the upgrade.

    -

    Parameters

    +

    Parameters

    @@ -2818,7 +2922,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2867,13 +2971,13 @@

    Removes a coprocessor for a specific table

    -

    Description

    +

    Description

    Removes a coprocessor for a specific table.

    -

    Parameters

    +

    Parameters

    @@ -2904,7 +3008,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2946,20 +3050,20 @@

    Responses

    -

    Restores a snapshot

    +

    Restores a snapshot.

    POST /api/v1/opdb/restoreSnapshot
    -

    Description

    +

    Description

    -

    Returns state of operation

    +

    Returns the snapshot that was restored.

    -

    Parameters

    +

    Parameters

    @@ -2990,7 +3094,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -3039,13 +3143,13 @@

    Starts the database

    -

    Description

    +

    Description

    Starts a previously stopped database

    -

    Parameters

    +

    Parameters

    @@ -3076,7 +3180,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -3125,13 +3229,13 @@

    Stops the database

    -

    Description

    +

    Description

    Stops a running database

    -

    Parameters

    +

    Parameters

    @@ -3162,7 +3266,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -3211,13 +3315,99 @@

    Updates the database

    -

    Description

    +

    Description

    Update an operational database in an environment

    -

    Parameters

    +

    Parameters

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

    Body

    +
    +

    input
    +required

    +
    +

    UpdateDatabaseRequest

    +
    +
    +
    +

    Responses

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

    200

    +
    +

    Expected response to a valid request.

    +
    +

    UpdateDatabaseResponse

    +
    +

    default

    +
    +

    The default response on an error.

    +
    +

    Error

    +
    +
    +
    +
    +

    Update edge nodes in a database

    +
    +
    +
    POST /api/v1/opdb/updateEdgeNodes
    +
    +
    +
    +

    Description

    +
    +

    Update edge nodes in a database.

    +
    +
    +
    +

    Parameters

    @@ -3241,14 +3431,14 @@

    Parameters

    required

    -

    UpdateDatabaseRequest

    +

    UpdateEdgeNodesRequest
    -

    Responses

    +

    Responses

    @@ -3271,7 +3461,7 @@

    Responses

    Expected response to a valid request.

    @@ -3290,20 +3480,20 @@

    Responses

    -

    Update edge nodes in a database

    +

    Updates the configuration of HBase.

    -
    POST /api/v1/opdb/updateEdgeNodes
    +
    POST /api/v1/opdb/updateHbaseConfiguration
    -

    Description

    +

    Description

    -

    Update edge nodes in a database.

    +

    Updates the selected configuration of the HBase cluster of an operational database in the environment.

    -

    Parameters

    +

    Parameters

    -

    UpdateDatabaseResponse

    +

    UpdateEdgeNodesResponse
    @@ -3327,14 +3517,14 @@

    Parameters

    required

    -

    UpdateEdgeNodesRequest

    +

    UpdateHbaseConfigurationRequest
    -

    Responses

    +

    Responses

    @@ -3357,7 +3547,7 @@

    Responses

    Expected response to a valid request.

    @@ -3376,20 +3566,20 @@

    Responses

    -

    Updates the configuration of HBase.

    +

    Upgrades the database.

    -
    POST /api/v1/opdb/updateHbaseConfiguration
    +
    POST /api/v1/opdb/upgradeDatabase
    -

    Description

    +

    Description

    -

    Updates the selected configuration of the HBase cluster of an operational database in the environment.

    +

    Upgrades an operational database in an environment to a given runtime.

    -

    Parameters

    +

    Parameters

    -

    UpdateEdgeNodesResponse

    +

    UpdateHbaseConfigurationResponse
    @@ -3413,14 +3603,14 @@

    Parameters

    required

    -

    UpdateHbaseConfigurationRequest

    +

    UpgradeDatabaseRequest
    -

    Responses

    +

    Responses

    @@ -3443,7 +3633,7 @@

    Responses

    Expected response to a valid request.

    @@ -3462,20 +3652,20 @@

    Responses

    -

    Upgrades the database.

    +

    Upload custom certificate

    -
    POST /api/v1/opdb/upgradeDatabase
    +
    POST /api/v1/opdb/uploadCertificate
    -

    Description

    +

    Description

    -

    Upgrades an operational database in an environment to a given runtime.

    +

    Upload a custom certificate to Global Trust Store

    -

    Parameters

    +

    Parameters

    -

    UpdateHbaseConfigurationResponse

    +

    UpgradeDatabaseResponse
    @@ -3499,14 +3689,14 @@

    Parameters

    required

    -

    UpgradeDatabaseRequest

    +

    UploadCertificateRequest
    -

    Responses

    +

    Responses

    @@ -3529,7 +3719,7 @@

    Responses

    Expected response to a valid request.

    @@ -4651,6 +4841,18 @@

    CreateDatabaseRequest

    + + + + + @@ -5035,7 +5237,7 @@

    CreateSnapshotRequest

    required

    + + + + + @@ -5637,7 +5851,7 @@

    DatabaseDetails

    DeleteSnapshotRequest

    -

    Delete Snapshot Request.

    +

    Request object for the DeleteSnapshot method.

    -

    UpgradeDatabaseResponse

    +

    UploadCertificateResponse
    +

    architecture
    +optional

    +
    +

    Specifies the Architecture of the cluster nodes.

    +
    +

    ArchitectureType

    +

    attachedStorageForWorkers
    optional
    -

    The name of the environment

    +

    The name of the environment.

    string

    @@ -5047,7 +5249,7 @@

    CreateSnapshotRequest

    required
    -

    Snapshot location URL on object store

    +

    The snapshot location URL on object store.

    string

    @@ -5071,7 +5273,7 @@

    CreateSnapshotRequest

    required
    -

    fully qualified table name

    +

    The fully qualified table name.

    string

    @@ -5105,7 +5307,7 @@

    CreateSnapshotResponse

    optional
    -

    command id

    +

    The submitted Command ID of the create snapshot.

    integer (int64)

    @@ -5117,7 +5319,7 @@

    CreateSnapshotResponse

    optional
    -

    When the snapshot was created

    +

    When the snapshot was created.

    integer (int64)

    @@ -5129,7 +5331,7 @@

    CreateSnapshotResponse

    optional
    -

    The name of the database

    +

    The name of the database.

    string

    @@ -5141,7 +5343,7 @@

    CreateSnapshotResponse

    optional
    -

    The name of the environment

    +

    The name of the environment.

    string

    @@ -5153,7 +5355,7 @@

    CreateSnapshotResponse

    optional
    -

    Status

    +

    The status of the create snapshot.

    SnapshotStatusType

    @@ -5165,7 +5367,7 @@

    CreateSnapshotResponse

    optional
    -

    Reason for the status

    +

    Reason for the status.

    string

    @@ -5381,6 +5583,18 @@

    DatabaseDetails
    +

    architecture
    +optional

    +
    +

    Specifies the architecture of the cluster nodes.

    +
    +

    ArchitectureType

    +

    autoScalingConfig
    optional
    @@ -5659,7 +5873,7 @@

    DeleteSnapshotRequest

    required

    -

    The name of the database

    +

    The name of the database.

    string

    @@ -5671,7 +5885,7 @@

    DeleteSnapshotRequest

    required
    -

    The name of the environment

    +

    The name of the environment.

    string

    @@ -5683,7 +5897,7 @@

    DeleteSnapshotRequest

    required
    -

    Snapshot name

    +

    The name of the snapshot.

    string

    @@ -5695,7 +5909,7 @@

    DeleteSnapshotRequest

    DeleteSnapshotResponse

    -

    Delete Snapshot Response.

    +

    Response object of the DeleteSnapshot method.

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

    SnapshotStatusType

    @@ -5777,7 +5991,7 @@

    DeleteSnapshotResponse

    optional
    -

    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

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

    database
    +required

    +
    +

    The name or CRN of the database.

    +
    +

    string

    +
    +

    environment
    +required

    +
    +

    The name or CRN of the environment.

    +
    +

    string

    +
    +
    +
    +

    ListCertificatesResponse

    +
    +

    The response of listing fingerprints of certificates in Global Trust Store

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

    fingerprints
    +optional

    +
    +

    List of certificate SHA-1 fingerprints in Global Trust Store

    +
    +

    < string > array

    +
    +
    +

    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.

    SnapshotStatusType

    @@ -7966,7 +8260,7 @@

    ListSnapshotsResponse

    optional
    -

    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.

    SnapshotStatusType

    @@ -8451,7 +8745,7 @@

    RestoreSnapshot

    optional
    -

    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

    @@ -9808,6 +10102,98 @@

    UpgradeDatabaseResponse

    -

    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.

    SnapshotStatusType

    @@ -8651,7 +8945,7 @@

    RestoreSnapshotResponse

    optional
    -

    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.

    SnapshotStatusType

    @@ -8885,7 +9179,7 @@

    Snapshot

    required
    -

    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
    +

    UploadCertificateRequest

    +
    +

    The request of uploading a custom certificate to Global Trust Store

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

    certificate
    +required

    +
    +

    Custom certificate in PEM format

    +
    +

    string

    +
    +

    database
    +required

    +
    +

    The name or CRN of the database.

    +
    +

    string

    +
    +

    environment
    +required

    +
    +

    The name or CRN of the environment.

    +
    +

    string

    +
    +
    +
    +

    UploadCertificateResponse

    +
    +

    The response of uploading a custom certificate to Global Trust Store

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

    fingerprint
    +optional

    +
    +

    SHA-1 fingerprint of the newly added certificate

    +
    +

    string

    +
    +
    +

    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 information

    -

    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