From 7ba270a6ce49db677758cd958b6854e00da17eda Mon Sep 17 00:00:00 2001 From: SRE Service Date: Thu, 12 Sep 2024 18:49:37 -0700 Subject: [PATCH] CDP API Documentation 0.9.122 --- api-docs/CHANGELOG.md | 6 + api-docs/README.md | 38 +- api-docs/audit/index.html | 4 +- api-docs/cloudprivatelinks/index.html | 4 +- api-docs/compute/index.html | 4 +- api-docs/consumption/index.html | 4 +- api-docs/datacatalog/index.html | 4 +- api-docs/datahub/index.html | 4 +- api-docs/datalake/index.html | 4 +- api-docs/de/index.html | 4 +- api-docs/df/index.html | 4 +- api-docs/dfworkload/index.html | 4 +- api-docs/drscp/index.html | 4 +- api-docs/dw/index.html | 642 ++++++++++++++++++++++- api-docs/environments/index.html | 4 +- api-docs/iam/index.html | 4 +- api-docs/imagecatalog/index.html | 4 +- api-docs/ml/index.html | 4 +- api-docs/opdb/index.html | 78 ++- api-docs/replicationmanager/index.html | 4 +- api-docs/swagger/README.md | 38 +- api-docs/swagger/audit.yaml | 2 +- api-docs/swagger/cloudprivatelinks.yaml | 2 +- api-docs/swagger/compute.yaml | 2 +- api-docs/swagger/consumption.yaml | 2 +- api-docs/swagger/datacatalog.yaml | 2 +- api-docs/swagger/datahub.yaml | 2 +- api-docs/swagger/datalake.yaml | 2 +- api-docs/swagger/de.yaml | 2 +- api-docs/swagger/df.yaml | 2 +- api-docs/swagger/dfworkload.yaml | 2 +- api-docs/swagger/drscp.yaml | 2 +- api-docs/swagger/dw.yaml | 188 ++++++- api-docs/swagger/environments.yaml | 2 +- api-docs/swagger/iam.yaml | 2 +- api-docs/swagger/imagecatalog.yaml | 2 +- api-docs/swagger/ml.yaml | 2 +- api-docs/swagger/opdb.yaml | 27 +- api-docs/swagger/replicationmanager.yaml | 2 +- 39 files changed, 1011 insertions(+), 102 deletions(-) diff --git a/api-docs/CHANGELOG.md b/api-docs/CHANGELOG.md index 2a18fa42f..0db9de048 100644 --- a/api-docs/CHANGELOG.md +++ b/api-docs/CHANGELOG.md @@ -1,5 +1,11 @@ # CDP Control Plane Public API Changelog +## 0.9.122 (2024-09-11) +* dw: Add new parameter `impalaExecutorGroupSets` to the autoscale options for the `createVw`, `updateVw`, `listVws`, and `describeVw` commands. +* opdb: Add new parameters `gatewayNodesCount` and `restworkerNodesCount` to `createDatabase` command. +* opdb: Add new parameters `numDesiredRestworkerNodes` and `removeRestworkerNodes` to `updateDatabase` command. +* opdb: Add new properties `gatewayNodesCount` and `restworkerNodesCount` to `DatabaseDetails` object. + ## 0.9.121 (2024-09-03) * de: Add new property `sparkConfigs` to `VcDescription` object. * de: Add `sparkConfigs` parameter to `createVc` and `updateVc` commands. diff --git a/api-docs/README.md b/api-docs/README.md index 4d6754c87..7ed9dd236 100644 --- a/api-docs/README.md +++ b/api-docs/README.md @@ -1,6 +1,6 @@ # CDP Control Plane Public API Documentation -*Version: 0.9.121* +*Version: 0.9.122* [CHANGELOG](CHANGELOG.md) @@ -8,24 +8,24 @@ Available documentation is listed by service below. | Service | Version | | --- | --- | -| [audit](./audit/index.html) | 0.9.121 | -| [cloudprivatelinks](./cloudprivatelinks/index.html) | 0.9.121 | -| [compute](./compute/index.html) | 0.9.121 | -| [consumption](./consumption/index.html) | 0.9.121 | -| [datacatalog](./datacatalog/index.html) | 0.9.121 | -| [datahub](./datahub/index.html) | 0.9.121 | -| [datalake](./datalake/index.html) | 0.9.121 | -| [de](./de/index.html) | 0.9.121 | -| [df](./df/index.html) | 0.9.121 | -| [dfworkload](./dfworkload/index.html) | 0.9.121 | -| [drscp](./drscp/index.html) | 0.9.121 | -| [dw](./dw/index.html) | 0.9.121 | -| [environments](./environments/index.html) | 0.9.121 | -| [iam](./iam/index.html) | 0.9.121 | -| [imagecatalog](./imagecatalog/index.html) | 0.9.121 | -| [ml](./ml/index.html) | 0.9.121 | -| [opdb](./opdb/index.html) | 0.9.121 | -| [replicationmanager](./replicationmanager/index.html) | 0.9.121 | +| [audit](./audit/index.html) | 0.9.122 | +| [cloudprivatelinks](./cloudprivatelinks/index.html) | 0.9.122 | +| [compute](./compute/index.html) | 0.9.122 | +| [consumption](./consumption/index.html) | 0.9.122 | +| [datacatalog](./datacatalog/index.html) | 0.9.122 | +| [datahub](./datahub/index.html) | 0.9.122 | +| [datalake](./datalake/index.html) | 0.9.122 | +| [de](./de/index.html) | 0.9.122 | +| [df](./df/index.html) | 0.9.122 | +| [dfworkload](./dfworkload/index.html) | 0.9.122 | +| [drscp](./drscp/index.html) | 0.9.122 | +| [dw](./dw/index.html) | 0.9.122 | +| [environments](./environments/index.html) | 0.9.122 | +| [iam](./iam/index.html) | 0.9.122 | +| [imagecatalog](./imagecatalog/index.html) | 0.9.122 | +| [ml](./ml/index.html) | 0.9.122 | +| [opdb](./opdb/index.html) | 0.9.122 | +| [replicationmanager](./replicationmanager/index.html) | 0.9.122 | API documentation uses the Adoc Riak stylesheet from [https://github.com/darshandsoni/asciidoctor-skins](https://github.com/darshandsoni/asciidoctor-skins). diff --git a/api-docs/audit/index.html b/api-docs/audit/index.html index dfe83e48a..89d7df5e8 100644 --- a/api-docs/audit/index.html +++ b/api-docs/audit/index.html @@ -822,7 +822,7 @@

Overview

Version information

-

Version : 0.9.121

+

Version : 0.9.122

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

MarkArchiveBatchesAsSuccessfulR


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

Overview

Version information

-

Version : 0.9.121

+

Version : 0.9.122

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

RevokePrivateLinkServiceAccessRes


diff --git a/api-docs/compute/index.html b/api-docs/compute/index.html index 10ab24dad..6f2f86d96 100644 --- a/api-docs/compute/index.html +++ b/api-docs/compute/index.html @@ -748,7 +748,7 @@

Overview

Version information

-

Version : 0.9.121

+

Version : 0.9.122

@@ -2416,7 +2416,7 @@

UpgradeDeploymentResponse


diff --git a/api-docs/consumption/index.html b/api-docs/consumption/index.html index d52c70571..37b8822b5 100644 --- a/api-docs/consumption/index.html +++ b/api-docs/consumption/index.html @@ -720,7 +720,7 @@

Overview

Version information

-

Version : 0.9.121

+

Version : 0.9.122

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

ListComputeUsageRecordsResponse


diff --git a/api-docs/datacatalog/index.html b/api-docs/datacatalog/index.html index c558615bf..bf2cd91da 100644 --- a/api-docs/datacatalog/index.html +++ b/api-docs/datacatalog/index.html @@ -721,7 +721,7 @@

Overview

Version information

-

Version : 0.9.121

+

Version : 0.9.122

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

LaunchProfilersResponse


diff --git a/api-docs/datahub/index.html b/api-docs/datahub/index.html index c42fe1ccb..d25682f4d 100644 --- a/api-docs/datahub/index.html +++ b/api-docs/datahub/index.html @@ -1356,7 +1356,7 @@

Overview

Version information

-

Version : 0.9.121

+

Version : 0.9.122

@@ -17827,7 +17827,7 @@

VolumeEncryptionRequest


diff --git a/api-docs/datalake/index.html b/api-docs/datalake/index.html index 7c2a0cd9c..5c70d28df 100644 --- a/api-docs/datalake/index.html +++ b/api-docs/datalake/index.html @@ -1199,7 +1199,7 @@

Overview

Version information

-

Version : 0.9.121

+

Version : 0.9.122

@@ -13981,7 +13981,7 @@

ValidateAzureCloudStorageResponse
diff --git a/api-docs/de/index.html b/api-docs/de/index.html index 1d7cd78f7..70af14e32 100644 --- a/api-docs/de/index.html +++ b/api-docs/de/index.html @@ -915,7 +915,7 @@

Overview

Version information

-

Version : 0.9.121

+

Version : 0.9.122

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

VcSummary


diff --git a/api-docs/df/index.html b/api-docs/df/index.html index d4d461e20..f10fa6d2c 100644 --- a/api-docs/df/index.html +++ b/api-docs/df/index.html @@ -1212,7 +1212,7 @@

Overview

Version information

-

Version : 0.9.121

+

Version : 0.9.122

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

UpgradeServiceResponse


diff --git a/api-docs/dfworkload/index.html b/api-docs/dfworkload/index.html index 23d7a0380..c1c2f8265 100644 --- a/api-docs/dfworkload/index.html +++ b/api-docs/dfworkload/index.html @@ -1214,7 +1214,7 @@

Overview

Version information

-

Version : 0.9.121

+

Version : 0.9.122

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

ValidateCustomPythonConfigur


diff --git a/api-docs/drscp/index.html b/api-docs/drscp/index.html index 56ed8b5c3..8a422be89 100644 --- a/api-docs/drscp/index.html +++ b/api-docs/drscp/index.html @@ -797,7 +797,7 @@

Overview

Version information

-

Version : 0.9.121

+

Version : 0.9.122

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

SimpleRestore


diff --git a/api-docs/dw/index.html b/api-docs/dw/index.html index 8652f2dab..497295415 100644 --- a/api-docs/dw/index.html +++ b/api-docs/dw/index.html @@ -1426,6 +1426,12 @@

Cloudera Data Warehouse [EXPERIMENTAL]

  • HealthCheckResponse
  • HiveCreateDiagnosticDataDownloadOptions
  • ImpalaCreateDiagnosticDataDownloadOptions
  • +
  • ImpalaExecutorGroupSetCreateRequest
  • +
  • ImpalaExecutorGroupSetResponse
  • +
  • ImpalaExecutorGroupSetUpdateRequest
  • +
  • ImpalaExecutorGroupSetsCreateRequest
  • +
  • ImpalaExecutorGroupSetsResponse
  • +
  • ImpalaExecutorGroupSetsUpdateRequest
  • ImpalaHASettingsCreateRequest
  • ImpalaHASettingsOptionsResponse
  • ImpalaHASettingsUpdateRequest
  • @@ -1557,7 +1563,7 @@

    Overview

    Version information

    -

    Version : 0.9.121

    +

    Version : 0.9.122

    @@ -9548,6 +9554,18 @@

    AutoscalingOptionsCreateRequest

    +

    impalaExecutorGroupSets
    +optional

    +
    +
    +

    Configures executor group sets for workload aware autoscaling.

    +
    + + + +

    impalaHighAvailabilityMode
    optional

    @@ -9740,6 +9758,18 @@

    AutoscalingOptionsResponse

    +

    impalaExecutorGroupSets
    +optional

    +
    +
    +

    Configurations of executor groups sets for workload aware autoscaling.

    +
    + + + +

    impalaHighAvailabilityMode
    optional

    @@ -9894,6 +9924,18 @@

    AutoscalingOptionsUpdateRequest

    +

    impalaExecutorGroupSets
    +optional

    +
    +
    +

    Re-configures executor group sets for workload aware autoscaling.

    +
    + + + +

    impalaNumOfActiveCoordinators
    optional

    @@ -12110,7 +12152,7 @@

    CreateAwsClusterRequest

    optional

    -

    Options for custom ACR/ECR/Docker registries.

    +

    Options for custom ACR/ECR registries.

    CustomRegistryOptions

    @@ -12406,7 +12448,7 @@

    CreateAzureClusterRequest

    optional

    -

    Options for custom ACR/ECR/Docker registries.

    +

    Options for custom ACR/ECR registries.

    CustomRegistryOptions

    @@ -13011,7 +13053,7 @@

    CreateClusterRequest

    optional

    -

    Options for custom ACR/ECR/Docker registries.

    +

    Options for custom ACR/ECR registries.

    CustomRegistryOptions

    @@ -14527,7 +14569,7 @@

    CreateVwResponse

    CustomRegistryOptions

    -

    Options for custom ACR, ECR, or Docker registry.

    +

    Options for custom ACR, ECR registry.

    @@ -17830,6 +17872,594 @@

    ImpalaCreateDiagnosticDataDo

    +

    ImpalaExecutorGroupSetCreateRequest

    +
    +

    Configure independently scaling set of uniformly sized executor groups.

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

    autoSuspendTimeoutSeconds
    +optional

    +
    +

    Set auto suspend threshold. If not provided defaults will apply.

    +
    +

    integer (int32)

    +
    +

    disableAutoSuspend
    +optional

    +
    +

    Turn off auto suspend. If not provided defaults will apply.

    +
    +

    boolean

    +
    +

    execGroupSize
    +optional

    +
    +

    Set number of executors per executor group.

    +
    +

    integer (int32)

    +
    +

    maxExecutorGroups
    +optional

    +
    +

    Set maximum number of executor groups allowed.

    +
    +

    integer (int32)

    +
    +

    minExecutorGroups
    +optional

    +
    +

    Set minimum number of executor groups allowed.

    +
    +

    integer (int32)

    +
    +

    triggerScaleDownDelay
    +optional

    +
    +

    Set scale down threshold in seconds. If not provided defaults will apply.

    +
    +

    integer (int32)

    +
    +

    triggerScaleUpDelay
    +optional

    +
    +

    Set scale up threshold in seconds. If not provided defaults will apply.

    +
    +

    integer (int32)

    +
    +
    +
    +

    ImpalaExecutorGroupSetResponse

    +
    +

    Describes configurations for an executor group set.

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

    autoSuspendTimeoutSeconds
    +optional

    +
    +

    Auto suspend threshold.

    +
    +

    integer (int32)

    +
    +

    disableAutoSuspend
    +optional

    +
    +

    Denotes whether auto suspend is turned off.

    +
    +

    boolean

    +
    +

    execGroupSize
    +optional

    +
    +

    Number of executors per executor group.

    +
    +

    integer (int32)

    +
    +

    groupSetPrefix
    +optional

    +
    +

    Name of resource pool for this executor group set.

    +
    +

    string

    +
    +

    maxExecutorGroups
    +optional

    +
    +

    Maximum number of executor groups allowed.

    +
    +

    integer (int32)

    +
    +

    minExecutorGroups
    +optional

    +
    +

    Minimum number of executor groups allowed.

    +
    +

    integer (int32)

    +
    +

    triggerScaleDownDelay
    +optional

    +
    +

    Scale down threshold in seconds.

    +
    +

    integer (int32)

    +
    +

    triggerScaleUpDelay
    +optional

    +
    +

    Scale up threshold in seconds.

    +
    +

    integer (int32)

    +
    +
    +
    +

    ImpalaExecutorGroupSetUpdateRequest

    +
    +

    Re-configure independently scaling set of uniformly sized executor groups.

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

    autoSuspendTimeoutSeconds
    +optional

    +
    +

    Set auto suspend threshold. If not provided defaults will apply.

    +
    +

    integer (int32)

    +
    +

    deleteGroupSet
    +optional

    +
    +

    Delete the executor group set.

    +
    +

    boolean

    +
    +

    disableAutoSuspend
    +optional

    +
    +

    Turn off auto suspend. If not provided defaults will apply.

    +
    +

    boolean

    +
    +

    execGroupSize
    +optional

    +
    +

    Set number of executors per executor group.

    +
    +

    integer (int32)

    +
    +

    maxExecutorGroups
    +optional

    +
    +

    Set maximum number of executor groups allowed.

    +
    +

    integer (int32)

    +
    +

    minExecutorGroups
    +optional

    +
    +

    Set minimum number of executor groups allowed.

    +
    +

    integer (int32)

    +
    +

    triggerScaleDownDelay
    +optional

    +
    +

    Set scale down threshold in seconds. If not provided defaults will apply.

    +
    +

    integer (int32)

    +
    +

    triggerScaleUpDelay
    +optional

    +
    +

    Set scale up threshold in seconds. If not provided defaults will apply.

    +
    +

    integer (int32)

    +
    +
    +
    +

    ImpalaExecutorGroupSetsCreateRequest

    +
    +

    Configure executor group sets for workload aware autoscaling.

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

    custom1
    +optional

    +
    +

    Configure first optional custom executor group set for workload aware autoscaling.

    +
    +

    custom2
    +optional

    +
    +

    Configure second optional custom executor group set for workload aware autoscaling.

    +
    +

    custom3
    +optional

    +
    +

    Configure third optional custom executor group set for workload aware autoscaling.

    +
    +

    large
    +optional

    +
    +

    Configure large executor group set for workload aware autoscaling.

    +
    +

    small
    +optional

    +
    +

    Configure small executor group set for workload aware autoscaling.

    +
    +
    +
    +

    ImpalaExecutorGroupSetsResponse

    +
    +

    Describes executor group sets for workload aware autoscaling.

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

    custom1
    +optional

    +
    +

    Describes first custom executor group set for workload aware autoscaling.

    +
    +

    custom2
    +optional

    +
    +

    Describes second custom executor group set for workload aware autoscaling.

    +
    +

    custom3
    +optional

    +
    +

    Describes third custom executor group set for workload aware autoscaling.

    +
    +

    large
    +optional

    +
    +

    Describes large executor group set for workload aware autoscaling.

    +
    +

    small
    +optional

    +
    +

    Describes small executor group set for workload aware autoscaling.

    +
    +
    +
    +

    ImpalaExecutorGroupSetsUpdateRequest

    +
    +

    Re-configure executor group sets for workload aware autoscaling.

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

    custom1
    +optional

    +
    +

    Re-configure first optional custom executor group set for workload aware autoscaling.

    +
    +

    custom2
    +optional

    +
    +

    Re-configure second optional custom executor group set for workload aware autoscaling.

    +
    +

    custom3
    +optional

    +
    +

    Re-configure third optional custom executor group set for workload aware autoscaling.

    +
    +

    large
    +optional

    +
    +

    Re-configure large executor group set for workload aware autoscaling.

    +
    +

    small
    +optional

    +
    +

    Re-configure small executor group set for workload aware autoscaling.

    +
    +
    +

    ImpalaHASettingsCreateRequest

    High Availability settings for the Impala Virtual Warehouse. The values are disregarded for Hive.

    @@ -24354,7 +24984,7 @@

    VwType


    diff --git a/api-docs/environments/index.html b/api-docs/environments/index.html index 99187a3a3..3290bc50f 100644 --- a/api-docs/environments/index.html +++ b/api-docs/environments/index.html @@ -1601,7 +1601,7 @@

    Overview

    Version information

    -

    Version : 0.9.121

    +

    Version : 0.9.122

    @@ -23925,7 +23925,7 @@

    ValidateAzureCloudStorageResponse
    diff --git a/api-docs/iam/index.html b/api-docs/iam/index.html index c802eddb0..8cffbaacd 100644 --- a/api-docs/iam/index.html +++ b/api-docs/iam/index.html @@ -1378,7 +1378,7 @@

    Overview

    Version information

    -

    Version : 0.9.121

    +

    Version : 0.9.122

    @@ -14560,7 +14560,7 @@

    WorkloadPasswordPolicy


    diff --git a/api-docs/imagecatalog/index.html b/api-docs/imagecatalog/index.html index c285d6b30..7f655ca65 100644 --- a/api-docs/imagecatalog/index.html +++ b/api-docs/imagecatalog/index.html @@ -815,7 +815,7 @@

    Overview

    Version information

    -

    Version : 0.9.121

    +

    Version : 0.9.122

    @@ -3107,7 +3107,7 @@

    VmImageType


    diff --git a/api-docs/ml/index.html b/api-docs/ml/index.html index b7ba157ae..9fe1dbd18 100644 --- a/api-docs/ml/index.html +++ b/api-docs/ml/index.html @@ -1173,7 +1173,7 @@

    Overview

    Version information

    -

    Version : 0.9.121

    +

    Version : 0.9.122

    @@ -12416,7 +12416,7 @@

    WorkspaceSummary


    diff --git a/api-docs/opdb/index.html b/api-docs/opdb/index.html index 6c2596264..9686452c3 100644 --- a/api-docs/opdb/index.html +++ b/api-docs/opdb/index.html @@ -848,7 +848,7 @@

    Overview

    Version information

    -

    Version : 0.9.121

    +

    Version : 0.9.122

    @@ -2679,6 +2679,18 @@

    CreateDatabaseRequest

    +

    gatewayNodesCount
    +optional

    +
    +
    +

    Number of gateway nodes to be created for the database. When multiple gateway nodes are present Knox works in HA mode. A positive, non-zero number is required. The default value is 1. Requires the COD_RESTWORKERS entitlement.

    +
    +
    +

    integer (int32)

    +
    + + +

    image
    optional

    @@ -2715,6 +2727,18 @@

    CreateDatabaseRequest

    +

    restworkerNodesCount
    +optional

    +
    +
    +

    Number of REST Worker nodes to be created for the database. A positive, non-zero number is required. The default value is 0. Requires the COD_RESTWORKERS entitlement.

    +
    +
    +

    integer (int32)

    +
    + + +

    rootVolumeSize
    optional

    @@ -2961,6 +2985,18 @@

    DatabaseDetails

    +

    gatewayNodesCount
    +optional

    +
    +
    +

    Number of gateway nodes for the database.

    +
    +
    +

    integer (int32)

    +
    + + +

    hueEndpoint
    optional

    @@ -2985,6 +3021,18 @@

    DatabaseDetails

    +

    restworkerNodesCount
    +optional

    +
    +
    +

    Number of REST Worker nodes for the database.

    +
    +
    +

    integer (int32)

    +
    + + +

    status
    optional

    @@ -3660,7 +3708,7 @@

    Image

    InstanceGroupType

    InstanceGroup Type. - WORKER - WORKER value of the InstanceGroup name. LEADER - LEADER value of the InstanceGroup name. MASTER - MASTER value of the InstanceGroup name. GATEWAY - GATEWAY value of the InstanceGroup name. STRONGMETA - STRONGMETA value of the InstanceGroup name. EDGE - EDGE value of the InstanceGroup name.

    + WORKER - WORKER value of the InstanceGroup name. LEADER - LEADER value of the InstanceGroup name. MASTER - MASTER value of the InstanceGroup name. GATEWAY - GATEWAY value of the InstanceGroup name. STRONGMETA - STRONGMETA value of the InstanceGroup name. EDGE - EDGE value of the InstanceGroup name. COMPUTE - COMPUTE value of the InstanceGroup name. RESTWORKER - RESTWORKER value of the InstanceGroup name.

    Type : enum (WORKER, LEADER, MASTER, GATEWAY, STRONGMETA, EDGE)

    @@ -4241,6 +4289,18 @@

    UpdateDatabaseRequest

    +

    numDesiredRestworkerNodes
    +optional

    +
    +
    +

    Sets the desired number of REST Worker nodes for the database. A positive, non-zero number is required. Requires the COD_RESTWORKERS entitlement.

    +
    +
    +

    integer (int32)

    +
    + + +

    numDesiredStrongMetaServers
    optional

    @@ -4253,6 +4313,18 @@

    UpdateDatabaseRequest

    +

    removeRestworkerNodes
    +optional

    +
    +
    +

    Removes any REST Worker nodes provisioned for this database. Requires the COD_RESTWORKERS entitlement.

    +
    +
    +

    boolean

    +
    + + +

    removeStrongMetaServers
    optional

    @@ -4465,7 +4537,7 @@

    VolumeType


    diff --git a/api-docs/replicationmanager/index.html b/api-docs/replicationmanager/index.html index 3e70cfef1..fa48f5275 100644 --- a/api-docs/replicationmanager/index.html +++ b/api-docs/replicationmanager/index.html @@ -871,7 +871,7 @@

    Overview

    Version information

    -

    Version : 0.9.121

    +

    Version : 0.9.122

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

    TargetDetails


    diff --git a/api-docs/swagger/README.md b/api-docs/swagger/README.md index df766e30b..a76aee265 100644 --- a/api-docs/swagger/README.md +++ b/api-docs/swagger/README.md @@ -1,6 +1,6 @@ # CDP Control Plane Public API Swagger Service Definitions -*Version: 0.9.121* +*Version: 0.9.122* These service definitions files are the basis for official CDP API artifacts, and you can use them to create your own client-side code. They adhere to the @@ -15,24 +15,24 @@ API requests must be signed according to the | Service Definition | Version | | --- | --- | -| [audit.yaml](./audit.yaml) | 0.9.121 | -| [cloudprivatelinks.yaml](./cloudprivatelinks.yaml) | 0.9.121 | -| [compute.yaml](./compute.yaml) | 0.9.121 | -| [consumption.yaml](./consumption.yaml) | 0.9.121 | -| [datacatalog.yaml](./datacatalog.yaml) | 0.9.121 | -| [datahub.yaml](./datahub.yaml) | 0.9.121 | -| [datalake.yaml](./datalake.yaml) | 0.9.121 | -| [de.yaml](./de.yaml) | 0.9.121 | -| [df.yaml](./df.yaml) | 0.9.121 | -| [dfworkload.yaml](./dfworkload.yaml) | 0.9.121 | -| [drscp.yaml](./drscp.yaml) | 0.9.121 | -| [dw.yaml](./dw.yaml) | 0.9.121 | -| [environments.yaml](./environments.yaml) | 0.9.121 | -| [iam.yaml](./iam.yaml) | 0.9.121 | -| [imagecatalog.yaml](./imagecatalog.yaml) | 0.9.121 | -| [ml.yaml](./ml.yaml) | 0.9.121 | -| [opdb.yaml](./opdb.yaml) | 0.9.121 | -| [replicationmanager.yaml](./replicationmanager.yaml) | 0.9.121 | +| [audit.yaml](./audit.yaml) | 0.9.122 | +| [cloudprivatelinks.yaml](./cloudprivatelinks.yaml) | 0.9.122 | +| [compute.yaml](./compute.yaml) | 0.9.122 | +| [consumption.yaml](./consumption.yaml) | 0.9.122 | +| [datacatalog.yaml](./datacatalog.yaml) | 0.9.122 | +| [datahub.yaml](./datahub.yaml) | 0.9.122 | +| [datalake.yaml](./datalake.yaml) | 0.9.122 | +| [de.yaml](./de.yaml) | 0.9.122 | +| [df.yaml](./df.yaml) | 0.9.122 | +| [dfworkload.yaml](./dfworkload.yaml) | 0.9.122 | +| [drscp.yaml](./drscp.yaml) | 0.9.122 | +| [dw.yaml](./dw.yaml) | 0.9.122 | +| [environments.yaml](./environments.yaml) | 0.9.122 | +| [iam.yaml](./iam.yaml) | 0.9.122 | +| [imagecatalog.yaml](./imagecatalog.yaml) | 0.9.122 | +| [ml.yaml](./ml.yaml) | 0.9.122 | +| [opdb.yaml](./opdb.yaml) | 0.9.122 | +| [replicationmanager.yaml](./replicationmanager.yaml) | 0.9.122 | See all the files at once in this site's [Github repository](https://github.com/cloudera/cdp-dev-docs/tree/master/api-docs/swagger). diff --git a/api-docs/swagger/audit.yaml b/api-docs/swagger/audit.yaml index f19256fc2..383fca319 100644 --- a/api-docs/swagger/audit.yaml +++ b/api-docs/swagger/audit.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.121 + version: 0.9.122 title: Cloudera Audit Service license: name: Apache 2.0 diff --git a/api-docs/swagger/cloudprivatelinks.yaml b/api-docs/swagger/cloudprivatelinks.yaml index 7be547b6d..d20579254 100644 --- a/api-docs/swagger/cloudprivatelinks.yaml +++ b/api-docs/swagger/cloudprivatelinks.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.121 + version: 0.9.122 title: Cloudera CloudPrivateLinks API Service license: name: Apache 2.0 diff --git a/api-docs/swagger/compute.yaml b/api-docs/swagger/compute.yaml index a432cbcfb..053ee9e09 100644 --- a/api-docs/swagger/compute.yaml +++ b/api-docs/swagger/compute.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public,private x-cdp-releases: PUBLIC info: - version: 0.9.121 + version: 0.9.122 title: Cloudera Compute Service license: name: Apache 2.0 diff --git a/api-docs/swagger/consumption.yaml b/api-docs/swagger/consumption.yaml index b5e6eb576..a059ef5cc 100644 --- a/api-docs/swagger/consumption.yaml +++ b/api-docs/swagger/consumption.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.121 + version: 0.9.122 title: Cloudera Consumption API Service license: name: Apache 2.0 diff --git a/api-docs/swagger/datacatalog.yaml b/api-docs/swagger/datacatalog.yaml index 5c6a4504e..fdd4ee544 100644 --- a/api-docs/swagger/datacatalog.yaml +++ b/api-docs/swagger/datacatalog.yaml @@ -5,7 +5,7 @@ x-form-factors: public x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.121 + version: 0.9.122 title: Cloudera DataCatalog Service license: name: Apache 2.0 diff --git a/api-docs/swagger/datahub.yaml b/api-docs/swagger/datahub.yaml index bd0bc66f2..01cb29ab6 100644 --- a/api-docs/swagger/datahub.yaml +++ b/api-docs/swagger/datahub.yaml @@ -6,7 +6,7 @@ x-form-factors: public x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.121 + version: 0.9.122 title: Cloudera Data hub Service license: name: Apache 2.0 diff --git a/api-docs/swagger/datalake.yaml b/api-docs/swagger/datalake.yaml index c181faddb..08fb99135 100644 --- a/api-docs/swagger/datalake.yaml +++ b/api-docs/swagger/datalake.yaml @@ -6,7 +6,7 @@ x-form-factors: public x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.121 + version: 0.9.122 title: Cloudera Datalake Service license: name: Apache 2.0 diff --git a/api-docs/swagger/de.yaml b/api-docs/swagger/de.yaml index 2a15f0fe2..4d7e17665 100644 --- a/api-docs/swagger/de.yaml +++ b/api-docs/swagger/de.yaml @@ -5,7 +5,7 @@ x-form-factors: public,private x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.121 + version: 0.9.122 title: Cloudera Data Engineering license: name: Apache 2.0 diff --git a/api-docs/swagger/df.yaml b/api-docs/swagger/df.yaml index d6de5c4b9..d7e1bfde1 100644 --- a/api-docs/swagger/df.yaml +++ b/api-docs/swagger/df.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.121 + version: 0.9.122 title: Cloudera DataFlow Service license: name: Apache 2.0 diff --git a/api-docs/swagger/dfworkload.yaml b/api-docs/swagger/dfworkload.yaml index 248cc3647..672f3267b 100644 --- a/api-docs/swagger/dfworkload.yaml +++ b/api-docs/swagger/dfworkload.yaml @@ -6,7 +6,7 @@ x-form-factors: public x-cdp-releases: PUBLIC info: description: "This REST API provides remote access to the DataFlow Service.\n Endpoints that are marked as [BETA] are subject to change in future releases of the application without backwards compatibility and without a major version change." - version: 0.9.121 + version: 0.9.122 title: Cloudera DataFlow Workload Service license: name: Apache 2.0 diff --git a/api-docs/swagger/drscp.yaml b/api-docs/swagger/drscp.yaml index cd3048429..6be153a50 100644 --- a/api-docs/swagger/drscp.yaml +++ b/api-docs/swagger/drscp.yaml @@ -5,7 +5,7 @@ x-form-factors: private x-audit: true x-cdp-releases: PUBLIC info: - version: 0.9.121 + version: 0.9.122 title: CDP Control Plane Data Recovery Service license: name: Apache 2.0 diff --git a/api-docs/swagger/dw.yaml b/api-docs/swagger/dw.yaml index fc6f5f78b..14967c68e 100644 --- a/api-docs/swagger/dw.yaml +++ b/api-docs/swagger/dw.yaml @@ -4,7 +4,7 @@ x-products: CDP x-form-factors: public,private x-cdp-releases: PUBLIC info: - version: 0.9.121 + version: 0.9.122 title: Cloudera Data Warehouse [EXPERIMENTAL] license: name: Apache 2.0 @@ -2159,7 +2159,7 @@ definitions: format: int32 description: Set additional number of nodes to reserve for other services in the cluster. Adding more reserved nodes increases your cloud costs. customRegistryOptions: - description: Options for custom ACR/ECR/Docker registries. + description: Options for custom ACR/ECR registries. $ref: '#/definitions/CustomRegistryOptions' awsOptions: description: Options for activating an AWS environment. @@ -2228,7 +2228,7 @@ definitions: format: int32 description: Set additional number of nodes to reserve for other services in the cluster. Adding more reserved nodes increases your cloud costs. customRegistryOptions: - description: Options for custom ACR/ECR/Docker registries. + description: Options for custom ACR/ECR registries. $ref: '#/definitions/CustomRegistryOptions' customSubdomain: type: string @@ -2316,7 +2316,7 @@ definitions: format: int32 description: Set additional number of nodes to reserve for other services in the cluster. Adding more reserved nodes increases your cloud costs. customRegistryOptions: - description: Options for custom ACR/ECR/Docker registries. + description: Options for custom ACR/ECR registries. $ref: '#/definitions/CustomRegistryOptions' customSubdomain: type: string @@ -2517,7 +2517,7 @@ definitions: description: The description of the plan. CustomRegistryOptions: type: object - description: Options for custom ACR, ECR, or Docker registry. + description: Options for custom ACR, ECR registry. properties: registryType: enum: @@ -3636,6 +3636,9 @@ definitions: x-deprecated: true type: boolean description: DEPRECATED in favor of the top level impalaHASettings object. Enables a backup instance for Impala catalog to ensure high availability. + impalaExecutorGroupSets: + $ref: '#/definitions/ImpalaExecutorGroupSetsCreateRequest' + description: Configures executor group sets for workload aware autoscaling. ImpalaOptionsCreateRequest: type: object description: Impala specific options. It cannot be provided for Virtual Warehouse types other than Impala. @@ -3731,6 +3734,9 @@ definitions: type: integer format: int32 description: DEPRECATED in favor of the top level impalaHASettings object. Number of the active coordinators. + impalaExecutorGroupSets: + $ref: '#/definitions/ImpalaExecutorGroupSetsUpdateRequest' + description: Re-configures executor group sets for workload aware autoscaling. ImpalaHASettingsUpdateRequest: type: object description: High Availability settings update options for the Impala Virtual Warehouse. @@ -3808,6 +3814,9 @@ definitions: x-deprecated: true type: boolean description: DEPRECATED in favor of the top level impalaHASettings object. Denotes whether a backup instance for Impala catalog is enabled. + impalaExecutorGroupSets: + $ref: '#/definitions/ImpalaExecutorGroupSetsResponse' + description: Configurations of executor groups sets for workload aware autoscaling. ImpalaHASettingsOptionsResponse: type: object description: Impala High Availability settings for a Virtual Warehouse. @@ -5540,6 +5549,175 @@ definitions: items: $ref: '#/definitions/CloudUserReference' description: The list of users allowed to access the given cluster. + ImpalaExecutorGroupSetsCreateRequest: + type: object + description: Configure executor group sets for workload aware autoscaling. + properties: + small: + $ref: '#/definitions/ImpalaExecutorGroupSetCreateRequest' + description: Configure small executor group set for workload aware autoscaling. + x-omitempty: false + custom1: + $ref: '#/definitions/ImpalaExecutorGroupSetCreateRequest' + description: Configure first optional custom executor group set for workload aware autoscaling. + custom2: + $ref: '#/definitions/ImpalaExecutorGroupSetCreateRequest' + description: Configure second optional custom executor group set for workload aware autoscaling. + custom3: + $ref: '#/definitions/ImpalaExecutorGroupSetCreateRequest' + description: Configure third optional custom executor group set for workload aware autoscaling. + large: + $ref: '#/definitions/ImpalaExecutorGroupSetCreateRequest' + description: Configure large executor group set for workload aware autoscaling. + x-omitempty: false + ImpalaExecutorGroupSetsUpdateRequest: + type: object + description: Re-configure executor group sets for workload aware autoscaling. + properties: + small: + $ref: '#/definitions/ImpalaExecutorGroupSetUpdateRequest' + description: Re-configure small executor group set for workload aware autoscaling. + custom1: + $ref: '#/definitions/ImpalaExecutorGroupSetUpdateRequest' + description: Re-configure first optional custom executor group set for workload aware autoscaling. + custom2: + $ref: '#/definitions/ImpalaExecutorGroupSetUpdateRequest' + description: Re-configure second optional custom executor group set for workload aware autoscaling. + custom3: + $ref: '#/definitions/ImpalaExecutorGroupSetUpdateRequest' + description: Re-configure third optional custom executor group set for workload aware autoscaling. + large: + $ref: '#/definitions/ImpalaExecutorGroupSetUpdateRequest' + description: Re-configure large executor group set for workload aware autoscaling. + ImpalaExecutorGroupSetsResponse: + type: object + description: Describes executor group sets for workload aware autoscaling. + properties: + small: + $ref: '#/definitions/ImpalaExecutorGroupSetResponse' + description: Describes small executor group set for workload aware autoscaling. + custom1: + $ref: '#/definitions/ImpalaExecutorGroupSetResponse' + description: Describes first custom executor group set for workload aware autoscaling. + custom2: + $ref: '#/definitions/ImpalaExecutorGroupSetResponse' + description: Describes second custom executor group set for workload aware autoscaling. + custom3: + $ref: '#/definitions/ImpalaExecutorGroupSetResponse' + description: Describes third custom executor group set for workload aware autoscaling. + large: + $ref: '#/definitions/ImpalaExecutorGroupSetResponse' + description: Describes large executor group set for workload aware autoscaling. + ImpalaExecutorGroupSetCreateRequest: + type: object + description: Configure independently scaling set of uniformly sized executor groups. + properties: + execGroupSize: + type: integer + format: int32 + description: Set number of executors per executor group. + x-omitempty: false + minExecutorGroups: + type: integer + format: int32 + description: Set minimum number of executor groups allowed. + x-omitempty: false + maxExecutorGroups: + type: integer + format: int32 + description: Set maximum number of executor groups allowed. + x-omitempty: false + autoSuspendTimeoutSeconds: + type: integer + format: int32 + description: Set auto suspend threshold. If not provided defaults will apply. + disableAutoSuspend: + type: boolean + description: Turn off auto suspend. If not provided defaults will apply. + triggerScaleUpDelay: + type: integer + format: int32 + description: Set scale up threshold in seconds. If not provided defaults will apply. + triggerScaleDownDelay: + type: integer + format: int32 + description: Set scale down threshold in seconds. If not provided defaults will apply. + ImpalaExecutorGroupSetUpdateRequest: + type: object + description: Re-configure independently scaling set of uniformly sized executor groups. + properties: + execGroupSize: + type: integer + format: int32 + description: Set number of executors per executor group. + minExecutorGroups: + type: integer + format: int32 + description: Set minimum number of executor groups allowed. + maxExecutorGroups: + type: integer + format: int32 + description: Set maximum number of executor groups allowed. + autoSuspendTimeoutSeconds: + type: integer + format: int32 + description: Set auto suspend threshold. If not provided defaults will apply. + disableAutoSuspend: + type: boolean + description: Turn off auto suspend. If not provided defaults will apply. + triggerScaleUpDelay: + type: integer + format: int32 + description: Set scale up threshold in seconds. If not provided defaults will apply. + triggerScaleDownDelay: + type: integer + format: int32 + description: Set scale down threshold in seconds. If not provided defaults will apply. + deleteGroupSet: + type: boolean + description: Delete the executor group set. + ImpalaExecutorGroupSetResponse: + type: object + description: Describes configurations for an executor group set. + properties: + groupSetPrefix: + type: string + description: Name of resource pool for this executor group set. + x-omitempty: false + execGroupSize: + type: integer + format: int32 + description: Number of executors per executor group. + x-omitempty: false + minExecutorGroups: + type: integer + format: int32 + description: Minimum number of executor groups allowed. + x-omitempty: false + maxExecutorGroups: + type: integer + format: int32 + description: Maximum number of executor groups allowed. + x-omitempty: false + autoSuspendTimeoutSeconds: + type: integer + format: int32 + description: Auto suspend threshold. + x-omitempty: false + disableAutoSuspend: + type: boolean + description: Denotes whether auto suspend is turned off. + x-omitempty: false + triggerScaleUpDelay: + type: integer + format: int32 + description: Scale up threshold in seconds. + x-omitempty: false + triggerScaleDownDelay: + type: integer + format: int32 + description: Scale down threshold in seconds. + x-omitempty: false CloudUserReference: type: object description: Cloud user definition object. diff --git a/api-docs/swagger/environments.yaml b/api-docs/swagger/environments.yaml index 095e671a0..f28db8703 100644 --- a/api-docs/swagger/environments.yaml +++ b/api-docs/swagger/environments.yaml @@ -6,7 +6,7 @@ x-form-factors: public,private x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.121 + version: 0.9.122 title: Cloudera Environments Service license: name: Apache 2.0 diff --git a/api-docs/swagger/iam.yaml b/api-docs/swagger/iam.yaml index 6fdf56a56..b8d04ed74 100644 --- a/api-docs/swagger/iam.yaml +++ b/api-docs/swagger/iam.yaml @@ -7,7 +7,7 @@ x-cdp-releases: PUBLIC x-audit: true x-extensions: pvcapipath info: - version: 0.9.121 + version: 0.9.122 title: Cloudera IAM Service license: name: Apache 2.0 diff --git a/api-docs/swagger/imagecatalog.yaml b/api-docs/swagger/imagecatalog.yaml index 2a5e6b765..49658e1f9 100644 --- a/api-docs/swagger/imagecatalog.yaml +++ b/api-docs/swagger/imagecatalog.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.121 + version: 0.9.122 title: Image catalog service license: name: Apache 2.0 diff --git a/api-docs/swagger/ml.yaml b/api-docs/swagger/ml.yaml index 0d493cada..813cc57a7 100644 --- a/api-docs/swagger/ml.yaml +++ b/api-docs/swagger/ml.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public,private x-cdp-releases: PUBLIC info: - version: 0.9.121 + version: 0.9.122 title: Cloudera Machine Learning license: name: Apache 2.0 diff --git a/api-docs/swagger/opdb.yaml b/api-docs/swagger/opdb.yaml index 153e763aa..755b2df07 100644 --- a/api-docs/swagger/opdb.yaml +++ b/api-docs/swagger/opdb.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.121 + version: 0.9.122 title: Operational Database service license: name: Apache 2.0 @@ -387,7 +387,7 @@ definitions: description: Value InstanceGroupType: type: string - description: "InstanceGroup Type.\n `WORKER` - WORKER value of the InstanceGroup name. `LEADER` - LEADER value of the InstanceGroup name. `MASTER` - MASTER value of the InstanceGroup name. `GATEWAY` - GATEWAY value of the InstanceGroup name. `STRONGMETA` - STRONGMETA value of the InstanceGroup name. `EDGE` - EDGE value of the InstanceGroup name." + description: "InstanceGroup Type.\n `WORKER` - WORKER value of the InstanceGroup name. `LEADER` - LEADER value of the InstanceGroup name. `MASTER` - MASTER value of the InstanceGroup name. `GATEWAY` - GATEWAY value of the InstanceGroup name. `STRONGMETA` - STRONGMETA value of the InstanceGroup name. `EDGE` - EDGE value of the InstanceGroup name. `COMPUTE` - COMPUTE value of the InstanceGroup name. `RESTWORKER` - RESTWORKER value of the InstanceGroup name." enum: - WORKER - LEADER @@ -492,6 +492,14 @@ definitions: items: $ref: '#/definitions/VolumeEncryption' description: Specifies encryption key to encrypt volume for instance group. It is currently supported for AWS cloud provider only. + gatewayNodesCount: + type: integer + format: int32 + description: Number of gateway nodes to be created for the database. When multiple gateway nodes are present Knox works in HA mode. A positive, non-zero number is required. The default value is 1. Requires the COD_RESTWORKERS entitlement. + restworkerNodesCount: + type: integer + format: int32 + description: Number of REST Worker nodes to be created for the database. A positive, non-zero number is required. The default value is 0. Requires the COD_RESTWORKERS entitlement. VolumeType: type: string description: "Volume Type.\n `HDD` - Hard disk drives (HDD) volume type. Default is HDD. `SSD` - Solid disk drives (SSD) volume type. `LOCAL_SSD` - Local SSD volume type." @@ -553,6 +561,13 @@ definitions: removeStrongMetaServers: type: boolean description: Removes any strong meta servers provisioned for this database. Requires the COD_STRONG_META_SERVERS entitlement. + numDesiredRestworkerNodes: + type: integer + format: int32 + description: Sets the desired number of REST Worker nodes for the database. A positive, non-zero number is required. Requires the COD_RESTWORKERS entitlement. + removeRestworkerNodes: + type: boolean + description: Removes any REST Worker nodes provisioned for this database. Requires the COD_RESTWORKERS entitlement. AutoScalingParameters: type: object description: A Parameters to configure AutoScaling @@ -758,6 +773,14 @@ definitions: internalName: type: string description: Internal cluster name for this database + gatewayNodesCount: + type: integer + format: int32 + description: Number of gateway nodes for the database. + restworkerNodesCount: + type: integer + format: int32 + description: Number of REST Worker nodes for the database. DescribeDatabaseRequest: type: object description: request to get details of the database in a particular environment diff --git a/api-docs/swagger/replicationmanager.yaml b/api-docs/swagger/replicationmanager.yaml index 0f77f0270..54ab8dd59 100644 --- a/api-docs/swagger/replicationmanager.yaml +++ b/api-docs/swagger/replicationmanager.yaml @@ -5,7 +5,7 @@ x-form-factors: public x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.121 + version: 0.9.122 title: Cloudera Replication Manager Service license: name: Apache 2.0