diff --git a/api-docs-beta/CHANGELOG.md b/api-docs-beta/CHANGELOG.md index 2a18fa42f..0db9de048 100644 --- a/api-docs-beta/CHANGELOG.md +++ b/api-docs-beta/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-beta/README.md b/api-docs-beta/README.md index 30d3dc14a..66ceae721 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.121 (BETA)* +*Version: 0.9.122 (BETA)* 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 | -| [metrics](./metrics/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 | +| [metrics](./metrics/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-beta/audit/index.html b/api-docs-beta/audit/index.html index db5b775a8..f259cb44e 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.121 (BETA)

+

Version : 0.9.122 (BETA)

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

MarkArchiveBatchesAsSuccessfulR


diff --git a/api-docs-beta/cloudprivatelinks/index.html b/api-docs-beta/cloudprivatelinks/index.html index 87e089eeb..603401368 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.121 (BETA)

+

Version : 0.9.122 (BETA)

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

RevokePrivateLinkServiceAccessRes


diff --git a/api-docs-beta/compute/index.html b/api-docs-beta/compute/index.html index c38fc155b..ad26bf410 100644 --- a/api-docs-beta/compute/index.html +++ b/api-docs-beta/compute/index.html @@ -968,7 +968,7 @@

Overview

Version information

-

Version : 0.9.121 (BETA)

+

Version : 0.9.122 (BETA)

@@ -11296,7 +11296,7 @@

ValidationSummary


diff --git a/api-docs-beta/consumption/index.html b/api-docs-beta/consumption/index.html index 0a7116413..f4cffd312 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.121 (BETA)

+

Version : 0.9.122 (BETA)

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

ListComputeUsageRecordsResponse


diff --git a/api-docs-beta/datacatalog/index.html b/api-docs-beta/datacatalog/index.html index 84d60008b..8bf8233c5 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.121 (BETA)

+

Version : 0.9.122 (BETA)

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

LaunchProfilersResponse


diff --git a/api-docs-beta/datahub/index.html b/api-docs-beta/datahub/index.html index 542b63366..4f68ea958 100644 --- a/api-docs-beta/datahub/index.html +++ b/api-docs-beta/datahub/index.html @@ -1406,7 +1406,7 @@

Overview

Version information

-

Version : 0.9.121 (BETA)

+

Version : 0.9.122 (BETA)

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

VolumeEncryptionRequest


diff --git a/api-docs-beta/datalake/index.html b/api-docs-beta/datalake/index.html index 7cd88de88..76d04039a 100644 --- a/api-docs-beta/datalake/index.html +++ b/api-docs-beta/datalake/index.html @@ -1240,7 +1240,7 @@

Overview

Version information

-

Version : 0.9.121 (BETA)

+

Version : 0.9.122 (BETA)

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

ValidateAzureCloudStorageResponse
diff --git a/api-docs-beta/de/index.html b/api-docs-beta/de/index.html index 4b360b1e8..9aa993a42 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.121 (BETA)

+

Version : 0.9.122 (BETA)

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

VcSummary


diff --git a/api-docs-beta/df/index.html b/api-docs-beta/df/index.html index a297d6c80..c2438c3fa 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.121 (BETA)

+

Version : 0.9.122 (BETA)

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

UpgradeServiceResponse


diff --git a/api-docs-beta/dfworkload/index.html b/api-docs-beta/dfworkload/index.html index 2d57b1fea..25bdf715c 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.121 (BETA)

+

Version : 0.9.122 (BETA)

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

ValidateCustomPythonConfigur


diff --git a/api-docs-beta/drscp/index.html b/api-docs-beta/drscp/index.html index 3c661c48d..c0159d1d6 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.121 (BETA)

+

Version : 0.9.122 (BETA)

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

SimpleRestore


diff --git a/api-docs-beta/dw/index.html b/api-docs-beta/dw/index.html index bcd2a449c..6febd245e 100644 --- a/api-docs-beta/dw/index.html +++ b/api-docs-beta/dw/index.html @@ -1627,7 +1627,7 @@

Overview

Version information

-

Version : 0.9.121 (BETA)

+

Version : 0.9.122 (BETA)

@@ -12912,7 +12912,7 @@

CreateAwsClusterRequest

optional

-

Options for custom ACR/ECR/Docker registries.

+

Options for custom ACR/ECR registries.

CustomRegistryOptions

@@ -13220,7 +13220,7 @@

CreateAzureClusterRequest

optional

-

Options for custom ACR/ECR/Docker registries.

+

Options for custom ACR/ECR registries.

CustomRegistryOptions

@@ -13825,7 +13825,7 @@

CreateClusterRequest

optional

-

Options for custom ACR/ECR/Docker registries.

+

Options for custom ACR/ECR registries.

CustomRegistryOptions

@@ -15353,7 +15353,7 @@

CreateVwResponse

CustomRegistryOptions

-

Options for custom ACR, ECR, or Docker registry.

+

Options for custom ACR, ECR registry.

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

VwType


diff --git a/api-docs-beta/environments/index.html b/api-docs-beta/environments/index.html index 9d3c40bae..68e3512c9 100644 --- a/api-docs-beta/environments/index.html +++ b/api-docs-beta/environments/index.html @@ -1047,321 +1047,328 @@

Cloudera Environments Service

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

    Cloudera Environments Service

  • NetworkAwsParams
  • NetworkAzureParams
  • NetworkGcpParams
    • +
  • OperationDetails
    • +
  • OperationResponse
    • +
  • OperationStatus
  • OperationType
  • ProxyConfig
    • +
  • RebuildFreeipaRequest
    • +
  • RebuildFreeipaResponse
  • RepairFreeipaRequest
  • RepairFreeipaResponse
  • RepairOperationDetails
    • @@ -1649,7 +1661,7 @@

    Overview

    Version information

    -

    Version : 0.9.121 (BETA)

    +

    Version : 0.9.122 (BETA)

    @@ -6077,16 +6089,16 @@

    Responses

    -

    Repairs the FreeIPA nodes.

    +

    Recreate FreeIPA in case of disaster.

    -
    POST /api/v1/environments2/repairFreeipa
    +
    POST /api/v1/environments2/rebuildFreeipa

    Description

    -

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

    +

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

    @@ -6114,7 +6126,7 @@

    Parameters

    required

    @@ -6144,7 +6156,7 @@

    Responses

    Expected response to a valid request.

    @@ -6163,16 +6175,16 @@

    Responses

    -

    Retries the last failed operation on a FreeIPA.

    +

    Repairs the FreeIPA nodes.

    -
    POST /api/v1/environments2/retryFreeipa
    +
    POST /api/v1/environments2/repairFreeipa

    Description

    -

    Retries the last failed operation on a FreeIPA.

    +

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

    @@ -6200,7 +6212,7 @@

    Parameters

    required

    @@ -6230,7 +6242,7 @@

    Responses

    Expected response to a valid request.

    @@ -6249,16 +6261,16 @@

    Responses

    -

    Rotate FreeIPA related secret for FreeIPA instances.

    +

    Retries the last failed operation on a FreeIPA.

    -
    POST /api/v1/environments2/rotateFreeipaSecrets
    +
    POST /api/v1/environments2/retryFreeipa

    Description

    -

    Rotate FreeIPA related secrets for FreeIPA instances.

    +

    Retries the last failed operation on a FreeIPA.

    @@ -6286,7 +6298,7 @@

    Parameters

    required

    @@ -6316,7 +6328,7 @@

    Responses

    Expected response to a valid request.

    @@ -6335,16 +6347,16 @@

    Responses

    -

    Rotate SaltStack user password on FreeIPA instances.

    +

    Rotate FreeIPA related secret for FreeIPA instances.

    -
    POST /api/v1/environments2/rotateSaltPassword
    +
    POST /api/v1/environments2/rotateFreeipaSecrets

    Description

    -

    Rotate SaltStack user password on FreeIPA instances.

    +

    Rotate FreeIPA related secrets for FreeIPA instances.

    @@ -6372,7 +6384,7 @@

    Parameters

    required

    @@ -6402,7 +6414,7 @@

    Responses

    Expected response to a valid request.

    @@ -6421,16 +6433,16 @@

    Responses

    -

    Creates or updates the AWS audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage.

    +

    Rotate SaltStack user password on FreeIPA instances.

    -
    POST /api/v1/environments2/setAWSAuditCredential
    +
    POST /api/v1/environments2/rotateSaltPassword

    Description

    -

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

    +

    Rotate SaltStack user password on FreeIPA instances.

    @@ -6458,7 +6470,7 @@

    Parameters

    required

    @@ -6488,7 +6500,7 @@

    Responses

    Expected response to a valid request.

    @@ -6507,16 +6519,16 @@

    Responses

    -

    Creates or updates the AWS GovCloud audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage.

    +

    Creates or updates the AWS audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage.

    -
    POST /api/v1/environments2/setAWSGovCloudAuditCredential
    +
    POST /api/v1/environments2/setAWSAuditCredential

    Description

    -

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

    +

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

    @@ -6544,7 +6556,7 @@

    Parameters

    required

    @@ -6574,7 +6586,7 @@

    Responses

    Expected response to a valid request.

    @@ -6593,16 +6605,16 @@

    Responses

    -

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

    +

    Creates or updates the AWS GovCloud audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage.

    -
    POST /api/v1/environments2/setAccountTelemetry
    +
    POST /api/v1/environments2/setAWSGovCloudAuditCredential

    Description

    -

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

    +

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

    @@ -6630,7 +6642,7 @@

    Parameters

    required

    @@ -6660,7 +6672,7 @@

    Responses

    Expected response to a valid request.

    @@ -6679,16 +6691,16 @@

    Responses

    -

    Creates or updates the Azure audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage.

    +

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

    -
    POST /api/v1/environments2/setAzureAuditCredential
    +
    POST /api/v1/environments2/setAccountTelemetry

    Description

    -

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

    +

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

    @@ -6716,7 +6728,7 @@

    Parameters

    required

    @@ -6746,7 +6758,7 @@

    Responses

    Expected response to a valid request.

    @@ -6765,16 +6777,16 @@

    Responses

    -

    Sets a catalog for a FreeIPA installation.

    +

    Creates or updates the Azure audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage.

    -
    POST /api/v1/environments2/setCatalog
    +
    POST /api/v1/environments2/setAzureAuditCredential

    Description

    -

    Sets a catalog for a FreeIPA installation.

    +

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

    @@ -6802,7 +6814,7 @@

    Parameters

    required

    @@ -6832,7 +6844,7 @@

    Responses

    Expected response to a valid request.

    @@ -6851,16 +6863,16 @@

    Responses

    -

    Sets endpoint access gateway settings for the environment.

    +

    Sets a catalog for a FreeIPA installation.

    -
    POST /api/v1/environments2/setEndpointAccessGateway
    +
    POST /api/v1/environments2/setCatalog

    Description

    -

    Sets endpoint access gateway settings for the environment.

    +

    Sets a catalog for a FreeIPA installation.

    @@ -6888,7 +6900,7 @@

    Parameters

    required

    @@ -6918,7 +6930,7 @@

    Responses

    Expected response to a valid request.

    @@ -6937,16 +6949,16 @@

    Responses

    -

    Read a configuration setting from the environment service.

    +

    Sets endpoint access gateway settings for the environment.

    -
    POST /api/v1/environments2/setEnvironmentSetting
    +
    POST /api/v1/environments2/setEndpointAccessGateway

    Description

    -

    Read a configuration setting from the environment service.

    +

    Sets endpoint access gateway settings for the environment.

    @@ -6974,7 +6986,7 @@

    Parameters

    required

    @@ -7004,7 +7016,7 @@

    Responses

    Expected response to a valid request.

    @@ -7023,16 +7035,16 @@

    Responses

    -

    Creates or updates the GCP audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage.

    +

    Read a configuration setting from the environment service.

    -
    POST /api/v1/environments2/setGCPAuditCredential
    +
    POST /api/v1/environments2/setEnvironmentSetting

    Description

    -

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

    +

    Read a configuration setting from the environment service.

    @@ -7060,7 +7072,7 @@

    Parameters

    required

    @@ -7090,7 +7102,7 @@

    Responses

    Expected response to a valid request.

    @@ -7109,16 +7121,16 @@

    Responses

    -

    Sets all ID Broker mappings for an environment.

    +

    Creates or updates the GCP audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage.

    -
    POST /api/v1/environments2/setIdBrokerMappings
    +
    POST /api/v1/environments2/setGCPAuditCredential

    Description

    -

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

    +

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

    @@ -7146,7 +7158,7 @@

    Parameters

    required

    @@ -7176,7 +7188,7 @@

    Responses

    Expected response to a valid request.

    @@ -7195,16 +7207,16 @@

    Responses

    -

    Sets workload user’s password and updates into all environments.

    +

    Sets all ID Broker mappings for an environment.

    -
    POST /api/v1/environments2/setPassword
    +
    POST /api/v1/environments2/setIdBrokerMappings

    Description

    -

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

    +

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

    @@ -7232,7 +7244,7 @@

    Parameters

    required

    @@ -7262,7 +7274,7 @@

    Responses

    Expected response to a valid request.

    @@ -7281,16 +7293,16 @@

    Responses

    -

    Configure environment level telemetry feature setting.

    +

    Sets workload user’s password and updates into all environments.

    -
    POST /api/v1/environments2/setTelemetryFeatures
    +
    POST /api/v1/environments2/setPassword

    Description

    -

    Configure environment level telemetry feature setting.

    +

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

    @@ -7318,7 +7330,7 @@

    Parameters

    required

    @@ -7348,7 +7360,7 @@

    Responses

    Expected response to a valid request.

    @@ -7367,16 +7379,16 @@

    Responses

    -

    Start an environment.

    +

    Configure environment level telemetry feature setting.

    -
    POST /api/v1/environments2/startEnvironment
    +
    POST /api/v1/environments2/setTelemetryFeatures

    Description

    -

    Start an environment.

    +

    Configure environment level telemetry feature setting.

    @@ -7404,7 +7416,7 @@

    Parameters

    required

    @@ -7434,7 +7446,7 @@

    Responses

    Expected response to a valid request.

    @@ -7453,16 +7465,16 @@

    Responses

    -

    Initiates the vertical scaling on FreeIPA.

    +

    Start an environment.

    -
    POST /api/v1/environments2/startFreeIpaVerticalScaling
    +
    POST /api/v1/environments2/startEnvironment

    Description

    -

    Initiates the vertical scaling on FreeIPA.

    +

    Start an environment.

    @@ -7490,7 +7502,7 @@

    Parameters

    required

    @@ -7520,6 +7532,92 @@

    Responses

    Expected response to a valid request.

    + + + + + + + +
    -

    RepairFreeipaRequest

    +

    RebuildFreeipaRequest
    -

    RepairFreeipaResponse

    +

    RebuildFreeipaResponse
    -

    RetryFreeipaRequest

    +

    RepairFreeipaRequest
    -

    RetryFreeipaResponse

    +

    RepairFreeipaResponse
    -

    RotateFreeipaSecretsRequest

    +

    RetryFreeipaRequest
    -

    RotateFreeipaSecretsResponse

    +

    RetryFreeipaResponse
    -

    RotateSaltPasswordRequest

    +

    RotateFreeipaSecretsRequest
    -

    RotateSaltPasswordResponse

    +

    RotateFreeipaSecretsResponse
    -

    SetAWSAuditCredentialRequest

    +

    RotateSaltPasswordRequest
    -

    SetAWSAuditCredentialResponse

    +

    RotateSaltPasswordResponse
    -

    SetAWSGovCloudAuditCredentialRequest

    +

    SetAWSAuditCredentialRequest
    -

    SetAWSGovCloudAuditCredentialResponse

    +

    SetAWSAuditCredentialResponse
    -

    SetAccountTelemetryRequest

    +

    SetAWSGovCloudAuditCredentialRequest
    -

    SetAccountTelemetryResponse

    +

    SetAWSGovCloudAuditCredentialResponse
    -

    SetAzureAuditCredentialRequest

    +

    SetAccountTelemetryRequest
    -

    SetAzureAuditCredentialResponse

    +

    SetAccountTelemetryResponse
    -

    SetCatalogRequest

    +

    SetAzureAuditCredentialRequest
    -

    SetCatalogResponse

    +

    SetAzureAuditCredentialResponse
    -

    SetEndpointAccessGatewayRequest

    +

    SetCatalogRequest
    -

    SetEndpointAccessGatewayResponse

    +

    SetCatalogResponse
    -

    SetEnvironmentSettingRequest

    +

    SetEndpointAccessGatewayRequest
    -

    SetEnvironmentSettingResponse

    +

    SetEndpointAccessGatewayResponse
    -

    SetGCPAuditCredentialRequest

    +

    SetEnvironmentSettingRequest
    -

    SetGCPAuditCredentialResponse

    +

    SetEnvironmentSettingResponse
    -

    SetIdBrokerMappingsRequest

    +

    SetGCPAuditCredentialRequest
    -

    SetIdBrokerMappingsResponse

    +

    SetGCPAuditCredentialResponse
    -

    SetPasswordRequest

    +

    SetIdBrokerMappingsRequest
    -

    SetPasswordResponse

    +

    SetIdBrokerMappingsResponse
    -

    SetTelemetryFeaturesRequest

    +

    SetPasswordRequest
    -

    SetTelemetryFeaturesResponse

    +

    SetPasswordResponse
    -

    StartEnvironmentRequest

    +

    SetTelemetryFeaturesRequest
    -

    StartEnvironmentResponse

    +

    SetTelemetryFeaturesResponse
    -

    StartFreeIpaVerticalScalingRequest

    +

    StartEnvironmentRequest
    +

    StartEnvironmentResponse

    +
    +

    default

    +
    +

    The default response on an error.

    +
    +

    Error

    +
    +
    +
    +
    +

    Initiates the vertical scaling on FreeIPA.

    +
    +
    +
    POST /api/v1/environments2/startFreeIpaVerticalScaling
    +
    +
    +
    +

    Description

    +
    +

    Initiates the vertical scaling on FreeIPA.

    +
    +
    +
    +

    Parameters

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

    Body

    +
    +

    input
    +required

    +
    +

    StartFreeIpaVerticalScalingRequest

    +
    +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + @@ -7546,13 +7644,13 @@

    Stop an environment.

    -

    Description

    +

    Description

    Stop an environment.

    -

    Parameters

    +

    Parameters

    HTTP CodeDescriptionSchema
    +

    200

    +
    +

    Expected response to a valid request.

    +

    StartFreeIpaVerticalScalingResponse
    @@ -7583,7 +7681,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7632,13 +7730,13 @@

    Synchronizes environments with all users and groups state
    -

    Description

    +

    Description

    Synchronizes environments with all users and groups state with CDP.

    -

    Parameters

    +

    Parameters

    @@ -7669,7 +7767,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7718,13 +7816,13 @@

    Syncs all ID Broker mappings for an environment.<
    -

    Description

    +

    Description

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

    -

    Parameters

    +

    Parameters

    @@ -7755,7 +7853,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7804,13 +7902,13 @@

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

    Description

    +

    Description

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

    -

    Parameters

    +

    Parameters

    @@ -7841,7 +7939,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7890,13 +7988,13 @@

    Synchronizes environments with single user to the FreeIPA ser
    -

    Description

    +

    Description

    Synchronizes environments with single user to the FreeIPA servers.

    -

    Parameters

    +

    Parameters

    @@ -7927,7 +8025,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7976,13 +8074,13 @@

    Synchronizes all environments in the callin
    -

    Description

    +

    Description

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

    -

    Parameters

    +

    Parameters

    @@ -8013,7 +8111,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8062,13 +8160,13 @@

    Test anonymization rules (for account teleme
    -

    Description

    +

    Description

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

    -

    Parameters

    +

    Parameters

    @@ -8099,7 +8197,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8148,13 +8246,13 @@

    Updates an AWS credential that can be attached to
    -

    Description

    +

    Description

    Updates an AWS credential.

    -

    Parameters

    +

    Parameters

    @@ -8185,7 +8283,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8234,13 +8332,13 @@

    Update the AWS encryption key ARN fo
    -

    Description

    +

    Description

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

    -

    Parameters

    +

    Parameters

    @@ -8271,7 +8369,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8320,13 +8418,13 @@

    Update the Availability Zones for the Azu
    -

    Description

    +

    Description

    Updates the Availability Zones for the Azure environment.

    -

    Parameters

    +

    Parameters

    @@ -8357,7 +8455,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8406,13 +8504,13 @@

    Updates a new certificate based Azure credential
    -

    Description

    +

    Description

    Updates a certificate based Azure credential.

    -

    Parameters

    +

    Parameters

    @@ -8443,7 +8541,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8492,13 +8590,13 @@

    Update the Azure database resources for t
    -

    Description

    +

    Description

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

    -

    Parameters

    +

    Parameters

    @@ -8529,7 +8627,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8578,13 +8676,13 @@

    Update the Azure encryption resources f
    -

    Description

    +

    Description

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

    -

    Parameters

    +

    Parameters

    @@ -8615,7 +8713,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8664,13 +8762,13 @@

    Updates account level Azure Marketplace im
    -

    Description

    +

    Description

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

    -

    Parameters

    +

    Parameters

    @@ -8701,7 +8799,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8750,13 +8848,13 @@

    Updates custom docker registry CRN of an en
    -

    Description

    +

    Description

    Updates custom docker registry CRN of an environment.

    -

    Parameters

    +

    Parameters

    @@ -8787,7 +8885,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8836,13 +8934,13 @@

    Updates Data Service resources of an enviro
    -

    Description

    +

    Description

    Updates Data Service resources of an environment.

    -

    Parameters

    +

    Parameters

    @@ -8873,7 +8971,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8922,13 +9020,13 @@

    Updates FreeIPA AWS cluster to use IMDSv1.
    -

    Description

    +

    Description

    Updates FreeIPA AWS cluster to use IMDSv1.

    -

    Parameters

    +

    Parameters

    @@ -8959,7 +9057,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9008,13 +9106,13 @@

    Updates FreeIPA AWS cluster to use IMDSv2.
    -

    Description

    +

    Description

    Updates FreeIPA AWS cluster to use IMDSv2.

    -

    Parameters

    +

    Parameters

    @@ -9045,7 +9143,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9094,13 +9192,13 @@

    Run orchestrator engine state update on the Fr
    -

    Description

    +

    Description

    Run orchestrator engine state update on the FreeIPA cluster.

    -

    Parameters

    +

    Parameters

    @@ -9131,7 +9229,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9180,13 +9278,13 @@

    Updates the proxy config of the given environment.
    -

    Description

    +

    Description

    Updates the proxy config of the given environment.

    -

    Parameters

    +

    Parameters

    @@ -9217,7 +9315,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9266,13 +9364,13 @@

    Updates the security access settings of the given
    -

    Description

    +

    Description

    Updates the security access settings of the given environment.

    -

    Parameters

    +

    Parameters

    @@ -9303,7 +9401,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9352,13 +9450,13 @@

    Updates the designated SSH key for the given environment.
    -

    Description

    +

    Description

    Updates the designated SSH key for the given environment.

    -

    Parameters

    +

    Parameters

    @@ -9389,7 +9487,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9438,13 +9536,13 @@

    Updates the subnet(s) of the given environment.

    -

    Description

    +

    Description

    Updates the subnet(s) of the given environment.

    -

    Parameters

    +

    Parameters

    @@ -9475,7 +9573,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9524,13 +9622,13 @@

    Upgrades Cluster Connectivity Manager on the environment to
    -

    Description

    +

    Description

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

    -

    Parameters

    +

    Parameters

    @@ -9561,7 +9659,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9610,13 +9708,13 @@

    Upgrades FreeIPA to the latest or defined image.

    -

    Description

    +

    Description

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

    -

    Parameters

    +

    Parameters

    @@ -9647,7 +9745,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9696,13 +9794,13 @@

    Upscales FreeIPA instances.

    -

    Description

    +

    Description

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

    -

    Parameters

    +

    Parameters

    @@ -9733,7 +9831,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9782,13 +9880,13 @@

    Validates AWS cloud storage settings of the gi
    -

    Description

    +

    Description

    Validates AWS cloud storage settings of the given environment.

    -

    Parameters

    +

    Parameters

    @@ -9819,7 +9917,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9868,13 +9966,13 @@

    Validates Azure cloud storage settings of th
    -

    Description

    +

    Description

    Validates Azure cloud storage settings of the given environment.

    -

    Parameters

    +

    Parameters

    @@ -9905,7 +10003,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -20340,12 +20438,173 @@

    NetworkGcpParams

    -

    OperationType

    +

    OperationDetails

    -

    Operation Type.

    -
    -
    -

    Type : enum (SET_PASSWORD, USER_SYNC)

    +

    Details object of the operation for success or falure.

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

    environmentCrn
    +required

    +
    +

    environment crn.

    +
    +

    string

    +
    +

    message
    +optional

    +
    +

    The detail of the success or failure.

    +
    +

    string

    +
    +
    +
    +

    OperationResponse

    +
    +

    Response object for a FreeIPA operation.

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

    endDate
    +optional

    +
    +

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

    +
    +

    string (date-time)

    +
    +

    error
    +optional

    +
    +

    The error will be populated on any error and it may be populated when the operation failure details are empty. Typically contains high level information such as the associated failure phase.

    +
    +

    string

    +
    +

    failureOperationDetails
    +optional

    +
    +

    List of details for failed operations. If the operation is only partially successful both successful and failure operation details will be populated.

    +
    +

    < OperationDetails > array

    +
    +

    operationId
    +optional

    +
    +

    Operation ID of the request for this operation. This ID can be used for getting status of the operation.

    +
    +

    string

    +
    +

    startDate
    +optional

    +
    +

    Date when the operation started.

    +
    +

    string (date-time)

    +
    +

    status
    +optional

    +
    +

    Status of this operation.

    +
    +

    OperationStatus

    +
    +

    successfulOperationDetails
    +optional

    +
    +

    List of details for all successful operations. If the operation is only partially successful both successful and failure operation details will be populated.

    +
    +

    < OperationDetails > array

    +
    +
    +
    +

    OperationStatus

    +
    +

    Status of an operation.

    +
    +
    +

    Type : enum (NEVER_RUN, REQUESTED, REJECTED, RUNNING, COMPLETED, FAILED, TIMEDOUT)

    +
    +
    +
    +

    OperationType

    +
    +

    Operation Type.

    +
    +
    +

    Type : enum (SET_PASSWORD, USER_SYNC)

    @@ -20491,6 +20750,182 @@

    ProxyConfig

    +

    RebuildFreeipaRequest

    +
    +

    Request object for rebuilding the FreeIPA servers.

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

    dataBackupStorageLocation
    +required

    +
    +

    Data/hourly backup location on the cloud storage. These are created in every hour. Usually the lastest one is required, so there won’t be any data loss.

    +
    +

    string

    +
    +

    environment
    +required

    +
    +

    The environment name or CRN.

    +
    +

    string

    +
    +

    freeipaCrn
    +required

    +
    +

    CRN of the FreeIPA to rebuild. Must be in the environment specified in 'environmentName'.

    +
    +

    string

    +
    +

    fullBackupStorageLocation
    +required

    +
    +

    Full backup location on the cloud storage. This backup was created during the provisioning of the instance. By default, no additional full backups are created for a single instance.

    +
    +

    string

    +
    +

    instanceToRestoreFqdn
    +required

    +
    +

    The instance’s Fully Qualified Domain Name (FQDN) that will be restored from the backups. This must match the FQDN of the instance from which the backup was taken.

    +
    +

    string

    +
    +
    +
    +

    RebuildFreeipaResponse

    +
    +

    Response object for a FreeIPA rebuild request.

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

    dataBackupStorageLocation
    +optional

    +
    +

    Data/hourly backup location on the cloud storage. These are created in every hour. Usually the lastest one is required, so there won’t be any data loss.

    +
    +

    string

    +
    +

    environmentCrn
    +optional

    +
    +

    The environment CRN of the FreeIPA to rebuild

    +
    +

    string

    +
    +

    freeipaCrn
    +optional

    +
    +

    CRN of the FreeIPA to rebuild. Must be in the environment specified in 'environmentName'.

    +
    +

    string

    +
    +

    fullBackupStorageLocation
    +optional

    +
    +

    Full backup location on the cloud storage. This backup was created during the provisioning of the instance. By default, no additional full backups are created for a single instance.

    +
    +

    string

    +
    +

    instanceToRestoreFqdn
    +optional

    +
    +

    The instance’s Fully Qualified Domain Name (FQDN) that will be restored from the backups. This must match the FQDN of the instance from which the backup was taken.

    +
    +

    string

    +
    +

    operation
    +optional

    +
    +

    Operation response of the request for this operation.

    +
    +

    OperationResponse

    +
    +
    +

    RepairFreeipaRequest

    Request object for repairing the FreeIPA servers.

    @@ -24841,7 +25276,7 @@

    ValidateAzureCloudStorageResponse
    diff --git a/api-docs-beta/iam/index.html b/api-docs-beta/iam/index.html index ab60e5993..333379382 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.121 (BETA)

    +

    Version : 0.9.122 (BETA)

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

    WorkloadPasswordPolicy


    diff --git a/api-docs-beta/imagecatalog/index.html b/api-docs-beta/imagecatalog/index.html index 1910e9fc7..24fec31e6 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.121 (BETA)

    +

    Version : 0.9.122 (BETA)

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

    VmImageType


    diff --git a/api-docs-beta/metrics/index.html b/api-docs-beta/metrics/index.html index 18ed53318..5b8cd2143 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.121 (BETA)

    +

    Version : 0.9.122 (BETA)

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

    UpdateRemoteWriteConfigResponse


    diff --git a/api-docs-beta/ml/index.html b/api-docs-beta/ml/index.html index 5221b26c0..2ebc2be0a 100644 --- a/api-docs-beta/ml/index.html +++ b/api-docs-beta/ml/index.html @@ -1173,7 +1173,7 @@

    Overview

    Version information

    -

    Version : 0.9.121 (BETA)

    +

    Version : 0.9.122 (BETA)

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

    WorkspaceSummary


    diff --git a/api-docs-beta/opdb/index.html b/api-docs-beta/opdb/index.html index 7010d0c5e..2467e5ef1 100644 --- a/api-docs-beta/opdb/index.html +++ b/api-docs-beta/opdb/index.html @@ -908,6 +908,7 @@

    Operational Database service

  • CreateDatabaseResponse
  • CreateSnapshotRequest
  • CreateSnapshotResponse
    • +
  • CustomInstanceTypes
  • CustomRecipe
  • DatabaseDetails
  • DeleteSnapshotRequest
    • @@ -998,7 +999,7 @@

    Overview

    Version information

    -

    Version : 0.9.121 (BETA)

    +

    Version : 0.9.122 (BETA)

    @@ -4579,6 +4580,18 @@

    CreateDatabaseRequest

    +

    customInstanceTypes
    +optional

    +
    +
    +

    Provide custom VM instance types for master, worker, gateway, leader, edge and compute groups.

    +
    +
    +

    CustomInstanceTypes

    +
    + + +

    customUserTags
    optional

    @@ -5043,6 +5056,100 @@

    CreateSnapshotResponse

    +

    CustomInstanceTypes

    +
    +

    Custom VM Instance Types.

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

    computeType
    +optional

    +
    +

    Compute VM Instance Type.

    +
    +

    string

    +
    +

    edgeType
    +optional

    +
    +

    Edge VM Instance Type.

    +
    +

    string

    +
    +

    gatewayType
    +optional

    +
    +

    Gateway VM Instance Type.

    +
    +

    string

    +
    +

    leaderType
    +optional

    +
    +

    Leader VM Instance Type.

    +
    +

    string

    +
    +

    masterType
    +optional

    +
    +

    Master VM Instance Type.

    +
    +

    string

    +
    +

    workerType
    +optional

    +
    +

    Worker VM Instance Type.

    +
    +

    string

    +
    +
    +

    CustomRecipe

    Describe a custom recipe.

    @@ -6531,7 +6638,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)

    @@ -9398,7 +9505,7 @@

    VolumeType


    diff --git a/api-docs-beta/replicationmanager/index.html b/api-docs-beta/replicationmanager/index.html index 1a47530eb..0efcb5d75 100644 --- a/api-docs-beta/replicationmanager/index.html +++ b/api-docs-beta/replicationmanager/index.html @@ -1182,7 +1182,7 @@

    Overview

    Version information

    -

    Version : 0.9.121 (BETA)

    +

    Version : 0.9.122 (BETA)

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

    VerifyHbaseClusterPairResponse


    diff --git a/api-docs-beta/swagger/README.md b/api-docs-beta/swagger/README.md index 2bfe464af..69697ec51 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.121 (BETA)* +*Version: 0.9.122 (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.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 | -| [metrics.yaml](./metrics.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 | +| [metrics.yaml](./metrics.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-beta/swagger/audit.yaml b/api-docs-beta/swagger/audit.yaml index 5a818919b..bba72632a 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.121 (BETA) + version: 0.9.122 (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 f46db5b48..1f3b6480d 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.121 (BETA) + version: 0.9.122 (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 5097cbe60..f28662477 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.121 (BETA) + version: 0.9.122 (BETA) title: Cloudera Compute Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/consumption.yaml b/api-docs-beta/swagger/consumption.yaml index 744df6eca..c7e31ff3e 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.121 (BETA) + version: 0.9.122 (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 c6350cfa8..7dc0df46a 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.121 (BETA) + version: 0.9.122 (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 5db3ef209..0630f7ab1 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.121 (BETA) + version: 0.9.122 (BETA) title: Cloudera Data hub Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/datalake.yaml b/api-docs-beta/swagger/datalake.yaml index 1b72a3c2a..62f343012 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.121 (BETA) + version: 0.9.122 (BETA) title: Cloudera Datalake Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/de.yaml b/api-docs-beta/swagger/de.yaml index 0bc190670..eace3610b 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.121 (BETA) + version: 0.9.122 (BETA) title: Cloudera Data Engineering license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/df.yaml b/api-docs-beta/swagger/df.yaml index 040b90d6b..dde059006 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.121 (BETA) + version: 0.9.122 (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 b9b9795a5..da75ac571 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.121 (BETA) + version: 0.9.122 (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 e9573d995..ab3ad8025 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.121 (BETA) + version: 0.9.122 (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 19f7333be..b9bf85570 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.121 (BETA) + version: 0.9.122 (BETA) title: Cloudera Data Warehouse [EXPERIMENTAL] license: name: Apache 2.0 @@ -2374,7 +2374,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. @@ -2443,7 +2443,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 @@ -2531,7 +2531,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 @@ -2735,7 +2735,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: diff --git a/api-docs-beta/swagger/environments.yaml b/api-docs-beta/swagger/environments.yaml index 5421868d2..d2a690c56 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.121 (BETA) + version: 0.9.122 (BETA) title: Cloudera Environments Service license: name: Apache 2.0 @@ -1038,6 +1038,27 @@ paths: description: The default response on an error. schema: $ref: '#/definitions/Error' + /api/v1/environments2/rebuildFreeipa: + post: + summary: Recreate FreeIPA in case of disaster. + description: If FreeIPA backups are available and all of the FreeIPA nodes are lost, this command recreates FreeIPA from scratch and restores backup. + operationId: rebuildFreeipa + x-mutating: true + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/RebuildFreeipaRequest' + responses: + 200: + description: Expected response to a valid request. + schema: + $ref: '#/definitions/RebuildFreeipaResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' /api/v1/environments2/getRepairFreeipaStatus: post: summary: Returns status of the repair operation for the operation id. @@ -4847,6 +4868,53 @@ definitions: type: string format: date-time description: Date when the operation ended. Omitted if operation has not ended. + RebuildFreeipaRequest: + type: object + description: Request object for rebuilding the FreeIPA servers. + required: + - environment + - freeipaCrn + - instanceToRestoreFqdn + - fullBackupStorageLocation + - dataBackupStorageLocation + properties: + environment: + type: string + description: The environment name or CRN. + freeipaCrn: + type: string + description: CRN of the FreeIPA to rebuild. Must be in the environment specified in 'environmentName'. + instanceToRestoreFqdn: + type: string + description: The instance's Fully Qualified Domain Name (FQDN) that will be restored from the backups. This must match the FQDN of the instance from which the backup was taken. + fullBackupStorageLocation: + type: string + description: Full backup location on the cloud storage. This backup was created during the provisioning of the instance. By default, no additional full backups are created for a single instance. + dataBackupStorageLocation: + type: string + description: Data/hourly backup location on the cloud storage. These are created in every hour. Usually the lastest one is required, so there won't be any data loss. + RebuildFreeipaResponse: + type: object + description: Response object for a FreeIPA rebuild request. + properties: + operation: + $ref: '#/definitions/OperationResponse' + description: Operation response of the request for this operation. + environmentCrn: + type: string + description: The environment CRN of the FreeIPA to rebuild + freeipaCrn: + type: string + description: CRN of the FreeIPA to rebuild. Must be in the environment specified in 'environmentName'. + instanceToRestoreFqdn: + type: string + description: The instance's Fully Qualified Domain Name (FQDN) that will be restored from the backups. This must match the FQDN of the instance from which the backup was taken. + fullBackupStorageLocation: + type: string + description: Full backup location on the cloud storage. This backup was created during the provisioning of the instance. By default, no additional full backups are created for a single instance. + dataBackupStorageLocation: + type: string + description: Data/hourly backup location on the cloud storage. These are created in every hour. Usually the lastest one is required, so there won't be any data loss. AWSFreeIpaCreationRequest: description: Request object for creating FreeIPA in the environment. type: object @@ -6333,3 +6401,57 @@ definitions: UpdateFreeipaToAwsImdsV1Response: type: object description: Response object for updating corresponding FreeIPA of the given environment to AWS IMDSv1. + OperationResponse: + type: object + description: Response object for a FreeIPA operation. + properties: + operationId: + type: string + description: Operation ID of the request for this operation. This ID can be used for getting status of the operation. + status: + description: Status of this operation. + $ref: '#/definitions/OperationStatus' + successfulOperationDetails: + type: array + description: List of details for all successful operations. If the operation is only partially successful both successful and failure operation details will be populated. + items: + $ref: '#/definitions/OperationDetails' + failureOperationDetails: + type: array + description: List of details for failed operations. If the operation is only partially successful both successful and failure operation details will be populated. + items: + $ref: '#/definitions/OperationDetails' + error: + type: string + description: The error will be populated on any error and it may be populated when the operation failure details are empty. Typically contains high level information such as the associated failure phase. + startDate: + type: string + format: date-time + description: Date when the operation started. + endDate: + type: string + format: date-time + description: Date when the operation ended. Omitted if operation has not ended. + OperationStatus: + type: string + description: Status of an operation. + enum: + - NEVER_RUN + - REQUESTED + - REJECTED + - RUNNING + - COMPLETED + - FAILED + - TIMEDOUT + OperationDetails: + type: object + description: Details object of the operation for success or falure. + required: + - environmentCrn + properties: + environmentCrn: + description: environment crn. + type: string + message: + type: string + description: The detail of the success or failure. diff --git a/api-docs-beta/swagger/iam.yaml b/api-docs-beta/swagger/iam.yaml index a7f274447..a99babe53 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.121 (BETA) + version: 0.9.122 (BETA) title: Cloudera IAM Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/imagecatalog.yaml b/api-docs-beta/swagger/imagecatalog.yaml index 7647de6a6..359bfe40d 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.121 (BETA) + version: 0.9.122 (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 0aa2c30f9..1e1a9cd76 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.121 (BETA) + version: 0.9.122 (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 5e5d1f48d..329232bf8 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.121 (BETA) + version: 0.9.122 (BETA) title: Cloudera Machine Learning license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/opdb.yaml b/api-docs-beta/swagger/opdb.yaml index 39faa074d..0fae9a382 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.121 (BETA) + version: 0.9.122 (BETA) title: Operational Database service license: name: Apache 2.0 @@ -708,7 +708,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 @@ -838,6 +838,31 @@ definitions: computeClusterCrn: type: string description: Utilizes the existing compute cluster with the provided CRN instead of creating a new one. + customInstanceTypes: + description: Provide custom VM instance types for master, worker, gateway, leader, edge and compute groups. + $ref: '#/definitions/CustomInstanceTypes' + CustomInstanceTypes: + type: object + description: Custom VM Instance Types. + properties: + masterType: + type: string + description: Master VM Instance Type. + workerType: + type: string + description: Worker VM Instance Type. + gatewayType: + type: string + description: Gateway VM Instance Type. + leaderType: + type: string + description: Leader VM Instance Type. + edgeType: + type: string + description: Edge VM Instance Type. + computeType: + type: string + description: Compute VM Instance Type. 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." diff --git a/api-docs-beta/swagger/replicationmanager.yaml b/api-docs-beta/swagger/replicationmanager.yaml index e73e39788..31f8aeeb4 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.121 (BETA) + version: 0.9.122 (BETA) title: Cloudera Replication Manager Service license: name: Apache 2.0