Overview
Cloudera Environments Service is a web service that manages cloud provider access.
Version information
Version : 0.9.128 (BETA)
License information
License : Apache 2.0
Terms of service : https://www.cloudera.com/legal/commercial-terms-and-conditions.html
URI scheme
Schemes : HTTPS
Consumes
-
application/json
Produces
-
application/json
Paths
Attach recipes to FreeIPA.
POST /api/v1/environments2/attachFreeIpaRecipes
Description
Attach recipes to FreeIPA.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Cancel running FreeIPA diagnostics collections
POST /api/v1/environments2/cancelFreeipaDiagnostics
Description
Cancel running FreeIPA diagnostics collection
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Changes the credential for an environment.
POST /api/v1/environments2/changeEnvironmentCredential
Description
Changes the credential for an environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Checks Database connectivity based on the input parameters.
POST /api/v1/environments2/checkDatabaseConnectivity
Description
Checks Database connectivity based on the input parameters.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Checks connectivity to a new Private Cloud environment by trying to access the Cloudera Manager address with provided credentials.
POST /api/v1/environments2/checkEnvironmentConnectivity
Description
Checks connectivity to a Private Cloud environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Checks connectivity to a Kubernetes address with provided kubeconfig files.
POST /api/v1/environments2/checkKubernetesConnectivity
Description
Checks connectivity to a Kubernetes address with provided kubeconfig files.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Start FreeIPA diagnostics collection
POST /api/v1/environments2/collectFreeipaDiagnostics
Description
Start FreeIPA diagnostics collection
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Creates a new AWS credential that can be attatched to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud provider account.
POST /api/v1/environments2/createAWSCredential
Description
Creates a new AWS credential.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Creates a new AWS environment by providing the cloud provider access and network information. A FreeIPA server will be automatically provisioned when an environment is created.
POST /api/v1/environments2/createAWSEnvironment
Description
Creates a new AWS environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Creates a new AWS credential for GovCloud that can be attatched to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud provider account.
POST /api/v1/environments2/createAWSGovCloudCredential
Description
Creates a new AWS credential for GovCloud.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Creates a new AWS GovCloud environment by providing the cloud provider access and network information. A FreeIPA server will be automatically provisioned when an environment is created.
POST /api/v1/environments2/createAWSGovCloudEnvironment
Description
Creates a new AWS GovCloud environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Creates a new 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.
POST /api/v1/environments2/createAzureCredential
Description
Creates a new Azure credential.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Creates a new Azure environment by providing the cloud provider access and network information. A FreeIPA server will be automatically provisioned when an environment is created.
POST /api/v1/environments2/createAzureEnvironment
Description
Creates a new Azure environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Creates a new GCP credential that can be attatched to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud provider account.
POST /api/v1/environments2/createGCPCredential
Description
Creates a new GCP credential.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Creates a new GCP environment by providing the cloud provider access and network information. A FreeIPA server will be automatically provisioned when an environment is created.
POST /api/v1/environments2/createGCPEnvironment
Description
Creates a new GCP environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Creates a new Private Cloud environment by providing the Cloudera Manager address and credentials.
POST /api/v1/environments2/createPrivateEnvironment
Description
Creates a new Private Cloud environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Creates a new proxy config that can be attatched to an environment.
POST /api/v1/environments2/createProxyConfig
Description
Creates a new proxy config.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Deletes an audit credential.
POST /api/v1/environments2/deleteAuditCredential
Description
Deletes an audit credential.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Deletes a credential.
POST /api/v1/environments2/deleteCredential
Description
Deletes a credential.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Deletes an environment.
POST /api/v1/environments2/deleteEnvironment
Description
Deletes an environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Deletes a proxy config.
POST /api/v1/environments2/deleteProxyConfig
Description
Deletes a proxy config.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Describes an environment.
POST /api/v1/environments2/describeEnvironment
Description
Describes an environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Detach recipes from FreeIPA.
POST /api/v1/environments2/detachFreeIpaRecipes
Description
Detach recipes from FreeIPA.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Disable the S3Guard for an environment.
POST /api/v1/environments2/disableS3Guard
Description
Disables the S3Guard for an environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Downscales FreeIPA instances.
POST /api/v1/environments2/downscaleFreeipa
Description
FreeIPA is an integrated Identity and Authentication solution that can be used for any of CM, CDP services.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Get account level telemetry settings. (telemetry features and anonymization rules)
POST /api/v1/environments2/getAccountTelemetry
Description
Get account level telemetry settings. (telemetry features and anonymization rules)
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Get default account level telemetry settings. Helps to set back the default values.
POST /api/v1/environments2/getAccountTelemetryDefault
Description
Get default account level telemetry settings. Helps to set back the default values.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
This API provides the audit credential prerequisites for the given cloud provider.
POST /api/v1/environments2/getAuditCredentialPrerequisites
Description
Provides the the audit credential prerequisites for the given cloud provider.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Gets the the automated sync status for the environment.
POST /api/v1/environments2/getAutomatedSyncEnvironmentStatus
Description
Gets the the automated sync status for the environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Gets 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.
POST /api/v1/environments2/getAzureImageTermsPolicy
Description
Gets 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
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
This API provides the credential prerequisites for the given cloud provider.
POST /api/v1/environments2/getCredentialPrerequisites
Description
Provides the the credential prerequisites for the given cloud provider.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Read a configuration setting from the environment service.
POST /api/v1/environments2/getEnvironmentSetting
Description
Read a configuration setting from the environment service.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Returns the user synchronization state for an environment.
POST /api/v1/environments2/getEnvironmentUserSyncState
Description
Returns the user synchronization state for an environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Gather log descriptors that are used for diagnostics collection.
POST /api/v1/environments2/getFreeipaLogDescriptors
Description
Gather log descriptors that are used for diagnostics collection.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Get the status of the FreeIPA services
POST /api/v1/environments2/getFreeipaStatus
Description
Gets the status of the FreeIPA nodes services and connectivity.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Get available images for FreeIPA upgrade.
POST /api/v1/environments2/getFreeipaUpgradeOptions
Description
Get available images for FreeIPA upgrade. If catalog is defined use the catalog as image source.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
This API provides the audit credential prerequisites for GovCloud for the enabled providers.
POST /api/v1/environments2/getGovCloudAuditCredentialPrerequisites
Description
Provides the the audit credential prerequisites for GovCloud for the enabled providers.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
This API provides the credential prerequisites for GovCloud for the enabled providers.
POST /api/v1/environments2/getGovCloudCredentialPrerequisites
Description
Provides the the credential prerequisites for GovCloud for the enabled providers.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Gets all ID Broker mappings for an environment.
POST /api/v1/environments2/getIdBrokerMappings
Description
Gets all ID Broker mappings for an environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Gets ID Broker mappings sync status.
POST /api/v1/environments2/getIdBrokerMappingsSyncStatus
Description
Gets the status of the most recent ID Broker mappings sync operation, if any.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Retrieves a keytab for a user or machine user.
POST /api/v1/environments2/getKeytab
Description
Retrieves a keytab for a user or machine user.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Get the latest (in progress or finished) operation for the environment resource.
POST /api/v1/environments2/getOperation
Description
Get the latest (in progress or finished) operation for the environment resource.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Returns status of the repair operation for the operation id.
POST /api/v1/environments2/getRepairFreeipaStatus
Description
Returns status of the repair operation for the operation id. Operation Id should be one of the previously requested repair operation ids.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
This API provides contents of public certificate for an environment.
POST /api/v1/environments2/getRootCertificate
Description
This API provides the contents of the root public certificate for an environment. The contents are a base64 encoded blob between —–BEGIN CERTIFICATE—– and —–END CERTIFICATE—–. This certificate can be imported by end users to establish trust with environment resources.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Initialize compute cluster for AWS environment.
POST /api/v1/environments2/initializeAWSComputeCluster
Description
Initialize compute cluster for AWS environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Initialize compute cluster for Azure environment.
POST /api/v1/environments2/initializeAzureComputeCluster
Description
Initialize compute cluster for Azure environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Returns status of the sync operation for the environment crn.
POST /api/v1/environments2/lastSyncStatus
Description
Returns status of the sync operation for the environment based on crn.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Lists audit credentials.
POST /api/v1/environments2/listAuditCredentials
Description
Lists audit credentials.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Returns the list of Data Services and their cluster names that are attached the given environment.
POST /api/v1/environments2/listConnectedDataServices
Description
Returns the list of Data Services and their cluster names that are attached to the given environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Lists credentials.
POST /api/v1/environments2/listCredentials
Description
Lists credentials.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Lists environments.
POST /api/v1/environments2/listEnvironments
Description
Lists environments.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List recent FreeIPA diagnostics collections
POST /api/v1/environments2/listFreeipaDiagnostics
Description
List recent FreeIPA diagnostics collection
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Lists all FreeIPA related secret types.
POST /api/v1/environments2/listFreeipaSecretTypes
Description
Lists FreeIPA related secret types for FreeIPA instances.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Lists proxy configs.
POST /api/v1/environments2/listProxyConfigs
Description
Lists proxy configs.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Recreate FreeIPA in case of disaster.
POST /api/v1/environments2/rebuildFreeipa
Description
If FreeIPA backups are available and all of the FreeIPA nodes are lost, this command recreates FreeIPA from scratch and restores backup.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Repairs the FreeIPA nodes.
POST /api/v1/environments2/repairFreeipa
Description
Repairs the FreeIPA nodes if they are in a non working state.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Retries the last failed operation on a FreeIPA.
POST /api/v1/environments2/retryFreeipa
Description
Retries the last failed operation on a FreeIPA.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Rotate FreeIPA related secret for FreeIPA instances.
POST /api/v1/environments2/rotateFreeipaSecrets
Description
Rotate FreeIPA related secrets for FreeIPA instances.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Rotate SaltStack user password on FreeIPA instances.
POST /api/v1/environments2/rotateSaltPassword
Description
Deprecated, please use rotateFreeipaSecrets with SALT_PASSWORD secretType instead.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
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/setAWSAuditCredential
Description
Creates or updates the AWS audit credential for the account. The response will only contain details appropriate to AWS.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
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/setAWSGovCloudAuditCredential
Description
Creates or updates the AWS GovCloud audit credential for the account. The response will only contain details appropriate to AWS.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Set account level telemetry settings. (telemetry features and anonymization rules)
POST /api/v1/environments2/setAccountTelemetry
Description
Set account level telemetry settings. (telemetry features and anonymization rules)
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
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/setAzureAuditCredential
Description
Creates or updates the Azure audit credential for the account. The response will only contain details appropriate to Azure.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Sets a catalog for a FreeIPA installation.
POST /api/v1/environments2/setCatalog
Description
Sets a catalog for a FreeIPA installation.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Sets endpoint access gateway settings for the environment.
POST /api/v1/environments2/setEndpointAccessGateway
Description
Sets endpoint access gateway settings for the environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Read a configuration setting from the environment service.
POST /api/v1/environments2/setEnvironmentSetting
Description
Read a configuration setting from the environment service.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
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/setGCPAuditCredential
Description
Creates or updates the GCP audit credential for the account. The response will only contain details appropriate to GCP.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Sets all ID Broker mappings for an environment.
POST /api/v1/environments2/setIdBrokerMappings
Description
Sets all ID Broker mappings for an environment. Overwrites all existing mappings.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Sets workload user’s password and updates into all environments.
POST /api/v1/environments2/setPassword
Description
Deprecated. Use 'iam set-workload-password' command instead.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Configure environment level telemetry feature setting.
POST /api/v1/environments2/setTelemetryFeatures
Description
Configure environment level telemetry feature setting.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Start an environment.
POST /api/v1/environments2/startEnvironment
Description
Start an environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Initiates the vertical scaling on FreeIPA.
POST /api/v1/environments2/startFreeIpaVerticalScaling
Description
Initiates the vertical scaling on FreeIPA.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Stop an environment.
POST /api/v1/environments2/stopEnvironment
Description
Stop an environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Synchronizes environments with all users and groups state with CDP.
POST /api/v1/environments2/syncAllUsers
Description
Synchronizes environments with all users and groups state with CDP.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Syncs all ID Broker mappings for an environment.
POST /api/v1/environments2/syncIdBrokerMappings
Description
Syncs all ID Broker mappings to all datalake clusters in an environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Returns status of the sync operation for the operation id.
POST /api/v1/environments2/syncStatus
Description
Returns status of the sync operation for the operation id. Operation Id should be one of the previously request sync operation.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Synchronizes environments with single user to the FreeIPA servers.
POST /api/v1/environments2/syncUser
Description
Synchronizes environments with single user to the FreeIPA servers.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Synchronizes all environments in the calling account.
POST /api/v1/environments2/synchronizeAllEnvironments
Description
Invokes the automated user sync service to synchronize all environments in the calling account.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Test anonymization rules (for account telemetry) against text input.
POST /api/v1/environments2/testAccountTelemetryRules
Description
Test anonymization rules (for account telemetry) against text input.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
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.
POST /api/v1/environments2/updateAwsCredential
Description
Updates an AWS credential.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Update the AWS encryption key ARN for the environment.
POST /api/v1/environments2/updateAwsDiskEncryptionParameters
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
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Update the Availability Zones for the Azure environment.
POST /api/v1/environments2/updateAzureAvailabilityZones
Description
Updates the Availability Zones for the Azure environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
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.
POST /api/v1/environments2/updateAzureCredential
Description
Updates a certificate based Azure credential.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Update the Azure database resources for the environment.
POST /api/v1/environments2/updateAzureDatabaseResources
Description
Updates the Azure database resources for the environment. Enables deploying private Flexible Server for the existing environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Update the Azure encryption resources for the environment.
POST /api/v1/environments2/updateAzureEncryptionResources
Description
Updates the Azure encryption resources for the environment. Enables the SSE with CMK for newly created Azure resources for the existing environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
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.
POST /api/v1/environments2/updateAzureImageTermsPolicy
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
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Updates custom docker registry CRN of an environment.
POST /api/v1/environments2/updateCustomDockerRegistry
Description
Updates custom docker registry CRN of an environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Updates Data Service resources of an environment.
POST /api/v1/environments2/updateDataServiceResources
Description
Updates Data Service resources of an environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Updates FreeIPA AWS cluster to use IMDSv1.
POST /api/v1/environments2/updateFreeipaToAwsImdsV1
Description
Updates FreeIPA AWS cluster to use IMDSv1.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Updates FreeIPA AWS cluster to use IMDSv2.
POST /api/v1/environments2/updateFreeipaToAwsImdsV2
Description
Updates FreeIPA AWS cluster to use IMDSv2.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Run orchestrator engine state update on the FreeIPA cluster.
POST /api/v1/environments2/updateOrchestratorState
Description
Run orchestrator engine state update on the FreeIPA cluster.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Updates the proxy config of the given environment.
POST /api/v1/environments2/updateProxyConfig
Description
Updates the proxy config of the given environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Updates the security access settings of the given environment.
POST /api/v1/environments2/updateSecurityAccess
Description
Updates the security access settings of the given environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Updates the designated SSH key for the given environment.
POST /api/v1/environments2/updateSshKey
Description
Updates the designated SSH key for the given environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Updates the subnet(s) of the given environment.
POST /api/v1/environments2/updateSubnet
Description
Updates the subnet(s) of the given environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Upgrades Cluster Connectivity Manager on the environment to the latest available version.
POST /api/v1/environments2/upgradeCcm
Description
Upgrades Cluster Connectivity Manager on the environment to the latest available version.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Upgrades FreeIPA to the latest or defined image.
POST /api/v1/environments2/upgradeFreeipa
Description
FreeIPA is an integrated Identity and Authentication solution that can be used for any of CM, CDP services.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Upscales FreeIPA instances.
POST /api/v1/environments2/upscaleFreeipa
Description
FreeIPA is an integrated Identity and Authentication solution that can be used for any of CM, CDP services.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Validates AWS cloud storage settings of the given environment.
POST /api/v1/environments2/validateAwsCloudStorage
Description
Validates AWS cloud storage settings of the given environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Validates Azure cloud storage settings of the given environment.
POST /api/v1/environments2/validateAzureCloudStorage
Description
Validates Azure cloud storage settings of the given environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Definitions
AWSComputeClusterConfiguration
Externalized compute cluster configuration for the environment.
| Name | Description | Schema |
|---|---|---|
kubeApiAuthorizedIpRanges |
Kubernetes API authorized IP ranges in CIDR notation. |
< string > array |
privateCluster |
If true, creates private cluster. |
boolean |
workerNodeSubnets |
Subnets for Kubernetes Worker Nodes |
< string > array |
AWSComputeClusterConfigurationRequest
Request object for creating Externalized compute cluster for the environment.
| Name | Description | Schema |
|---|---|---|
kubeApiAuthorizedIpRanges |
Kubernetes API authorized IP ranges in CIDR notation. Mutually exclusive with privateCluster. |
< string > array |
privateCluster |
If true, creates private cluster. |
boolean |
workerNodeSubnets |
Specify subnets for Kubernetes Worker Nodes |
< string > array |
AWSFreeIpaCreationRequest
Request object for creating FreeIPA in the environment.
| Name | Description | Schema |
|---|---|---|
instanceCountByGroup |
The number of FreeIPA instances to create per group when creating FreeIPA in the environment |
integer (int32) |
instanceType |
Custom instance type of FreeIPA instances. |
string |
multiAz |
Flag which marks that the FreeIPA will be deployed in a multi-availability zone way or not. |
boolean |
recipes |
The recipes for the FreeIPA cluster. |
< string > array |
AnonymizationRuleRequest
Anonymization rule request object that is applied on logs that are sent to Cloudera.
| Name | Description | Schema |
|---|---|---|
replacement |
If rule pattern (value) matches, that will be replaced for this string (default [REDACTED]) |
string |
value |
Pattern of the rule that should be redacted. |
string |
AnonymizationRuleResponse
Anonymization rule response object rule that is applied on logs that are sent to Cloudera.
| Name | Description | Schema |
|---|---|---|
replacement |
If rule pattern (value) matches, that will be replaced for this string (default [REDACTED]) |
string |
value |
Pattern of the rule that should be redacted. |
string |
AttachFreeIpaRecipesRequest
Request object for attaching recipes to FreeIPA.
| Name | Description | Schema |
|---|---|---|
environment |
The environment name or CRN of the FreeIPA. |
string |
recipes |
The list of recipes to attach. |
< string > array |
AttachFreeIpaRecipesResponse
Response object for attaching recipes to FreeIPA.
Type : object
AttachedVolume
The attached volume configuration.
| Name | Description | Schema |
|---|---|---|
count |
The number of volumes. |
integer (int32) |
size |
The size of each volume in GB. |
integer (int64) |
volumeType |
The type of the volumes. |
string |
AttachedVolumeDetail
The attached volume configuration.
| Name | Description | Schema |
|---|---|---|
count |
The number of volumes. |
integer (int32) |
size |
The size of each volume in GB. |
integer (int32) |
volumeType |
The type of volumes. |
string |
Authentication
Additional SSH key authentication configuration for accessing cluster node instances.
| Name | Description | Schema |
|---|---|---|
loginUserName |
The SSH user name created on the nodes for SSH access. |
string |
publicKey |
SSH Public key string. |
string |
publicKeyId |
Public SSH key ID already registered in the cloud provider. |
string |
AuthenticationRequest
Additional SSH key authentication configuration for accessing cluster node.
| Name | Description | Schema |
|---|---|---|
publicKey |
Public SSH key string. Mutually exclusive with publicKeyId. |
string |
publicKeyId |
Public SSH key ID already registered in the cloud provider. Mutually exclusive with publicKey. |
string |
AwsCredentialPrerequisitesResponse
Response object for getting AWS credential prerequisites.
| Name | Description | Schema |
|---|---|---|
externalId |
The cross-account external ID. |
string |
policies |
The fine-grained policies related to each service. |
< CredentialGranularPolicyResponse > array |
policyJson |
The related policy json encoded in base64 |
string |
AwsCredentialProperties
The credential properties that closely related to those that have been created on AWS.
| Name | Description | Schema |
|---|---|---|
govCloud |
Flag that indicates that the given AWS credential is GovCloud specfic. |
boolean |
roleArn |
The AWS role arn for the given credential. |
string |
AwsDiskEncryptionParameters
Object containing details of encryption parameters for AWS cloud.
| Name | Description | Schema |
|---|---|---|
encryptionKeyArn |
ARN of the CMK which is used to encrypt the AWS EBS volumes. |
string |
AwsFreeIpaInstanceTemplateParams
AWS specific FreeIPA parameters.
| Name | Description | Schema |
|---|---|---|
spotMaxPrice |
Maximum hourly price of spot instances. |
number (double) |
spotPercentage |
Percentage of spot instances. |
integer (int32) |
AwsLogStorageRequest
AWS storage configuration for cluster and audit logs.
| Name | Description | Schema |
|---|---|---|
backupStorageLocationBase |
The base location to store backup in S3. This should be an s3a:// url. |
string |
instanceProfile |
The AWS instance profile that which contains the necessary permissions to access the S3 storage location. |
string |
storageLocationBase |
The base location to store logs in S3. This should be an s3a:// url. |
string |
AzureAuthenticationTypeProperties
Authentication type of the credential
Type : enum (CERTIFICATE, SECRET)
AzureComputeClusterConfiguration
Externalized compute cluster configuration for the environment.
| Name | Description | Schema |
|---|---|---|
kubeApiAuthorizedIpRanges |
Kubernetes API authorized IP ranges in CIDR notation. |
< string > array |
outboundType |
Cluster egress with defined outbound type in Azure Kubernetes Service. |
string |
privateCluster |
If true, creates private cluster. |
boolean |
workerNodeSubnets |
Subnets for Kubernetes Worker Nodes |
< string > array |
AzureComputeClusterConfigurationRequest
Request object for creating Externalized compute cluster for the environment.
| Name | Description | Schema |
|---|---|---|
kubeApiAuthorizedIpRanges |
Kubernetes API authorized IP ranges in CIDR notation. Mutually exclusive with privateCluster. |
< string > array |
outboundType |
Customize cluster egress with defined outbound type in Azure Kubernetes Service. |
enum (udr) |
privateCluster |
If true, creates private cluster |
boolean |
workerNodeSubnets |
Specify subnets for Kubernetes Worker Nodes |
< string > array |
AzureCredentialCertificateProperties
The certificate used for the credential
| Name | Description | Schema |
|---|---|---|
base64 |
The certificate (PEM) encoded in base64 format |
string |
expiration |
the expiration timestamp |
string |
expirationDate |
the expiration in date format |
string (date-time) |
sha512 |
The SHA512 digest of the certificate |
string |
status |
The status of an Azure credential. |
enum (KEY_GENERATED, ACTIVE) |
AzureCredentialPrerequisitesResponse
Response object for getting Azure credential prerequisites.
| Name | Description | Schema |
|---|---|---|
appCreationCommand |
Azure CLI command to create Azure AD Application encoded in base64. |
string |
policies |
The fine-grained policies related to each service. |
< CredentialGranularPolicyResponse > array |
roleDefinitionJson |
The related role definition json encoded in base64 |
string |
AzureCredentialProperties
The credential properties that closely related to those that have been created on Azure.
| Name | Description | Schema |
|---|---|---|
appId |
The ID of the created Azure app. |
string |
authenticationType |
Authentication type of the credential |
|
certificate |
The public certificate used by the Azure credential. |
|
subscriptionId |
The Azure subscription ID for the given credential. |
string |
tenantId |
The Azure tenant ID for the given credential. |
string |
AzureDataServicesParameters
Azure-specific Data Service parameters response.
| Name | Description | Schema |
|---|---|---|
sharedManagedIdentity |
User-assigned managed identity used by the AKS control plane. |
string |
AzureDataServicesParametersRequest
Azure-specific Data Service parameters request.
| Name | Description | Schema |
|---|---|---|
sharedManagedIdentity |
User-assigned managed identity used by the AKS control plane. |
string |
AzureDatabaseResources
Object containing details of database resources for Azure cloud.
| Name | Description | Schema |
|---|---|---|
databasePrivateDnsZoneId |
The full Azure resource ID of the existing Private DNS Zone used for Flexible Server and Single Server Databases. |
string |
flexibleServerSubnetIds |
The subnets delegated for Flexible Server database. Accepts either the name or the full resource id. |
< string > array |
AzureFreeIpaCreationRequest
Request object for creating FreeIPA in the environment.
| Name | Description | Schema |
|---|---|---|
instanceCountByGroup |
The number of FreeIPA instances to create per group when creating FreeIPA in the environment |
integer (int32) |
instanceType |
Custom instance type of FreeIPA instances. |
string |
multiAz |
Flag that enables deployment of the FreeIPA in a multi-availability zone. |
boolean |
recipes |
The recipes for the FreeIPA cluster. |
< string > array |
AzureLogStorageRequest
Azure storage configuration for cluster and audit logs.
| Name | Description | Schema |
|---|---|---|
backupStorageLocationBase |
The storage location to use. The location has to be in the following format abfs://filesystem@storage-account-name.dfs.core.windows.net. The filesystem must already exist and the storage account must be StorageV2. |
string |
managedIdentity |
The managed identity associated with the logger. This identity should have Storage Blob Data Contributor role on the given storage account. |
string |
storageLocationBase |
The storage location to use. The location has to be in the following format abfs://filesystem@storage-account-name.dfs.core.windows.net. The filesystem must already exist and the storage account must be StorageV2. |
string |
AzureResourceEncryptionParameters
Object containing details of encryption parameters for Azure cloud.
| Name | Description | Schema |
|---|---|---|
diskEncryptionSetId |
ID of the Disk Encryption Set created in Azure which is used to encrypt Managed Disks of FreeIPA, Data Lake, Data Hub and PostgreSQL. |
string |
encryptionKeyResourceGroupName |
Name of the existing Azure resource group hosting the Azure Key Vault containing customer managed key which is used to encrypt the Azure Managed Disks. |
string |
encryptionKeyUrl |
URL of the key which is used to encrypt the Azure Managed Disks. |
string |
encryptionUserManagedIdentity |
User managed identity for encryption. |
string |
userManagedIdentity |
User managed identity for encryption. (deprecated) |
string |
BackupStorage
Storage configuration for backup.
| Name | Description | Schema |
|---|---|---|
awsDetails |
AWS-specific backup storage configuration information. |
|
azureDetails |
Azure-specific backup storage configuration information. |
|
enabled |
Whether external backup storage is enabled. The default value is disabled. |
boolean |
gcpDetails |
GCP-specific backup storage configuration information. |
awsDetails
| Name | Description | Schema |
|---|---|---|
instanceProfile |
The AWS instance profile which contains the necessary permissions to access the S3 storage location. |
string |
storageLocationBase |
The base location to store backup in S3. This should be an s3a:// url. |
string |
azureDetails
| Name | Description | Schema |
|---|---|---|
managedIdentity |
The managed identity associated with the backup. This identity should have Storage Blob Data Contributor role on the given storage account. |
string |
storageLocationBase |
The storage location to use. The location has to be in the following format abfs://filesystem@storage-account-name.dfs.core.windows.net. |
string |
gcpDetails
| Name | Description | Schema |
|---|---|---|
serviceAccountEmail |
Email ID of the service account associated with the backup instances. |
string |
storageLocationBase |
The storage location to use. This should be a gs:// url. |
string |
CancelFreeipaDiagnosticsRequest
Request object for cancel running FreeIPA diagnostics collections.
| Name | Description | Schema |
|---|---|---|
environmentName |
The name or CRN of the environment. |
string |
CancelFreeipaDiagnosticsResponse
Response object for cancel running FreeIPA diagnostics collections.
Type : object
CdpCluster
Discovered CdpCluster object.
| Name | Description | Schema |
|---|---|---|
clusterValidationMessages |
List of cluster validation message. |
< EnvValidation > array |
cmUrl |
The Url to Cloudera Manager. |
string |
displayName |
Display name of cluster. |
string |
exposedServices |
List of exposed CDP DC services |
< ExposedService > array |
name |
Name of cluster. |
string |
version |
Version of Cloudera Manager. |
string |
ChangeEnvironmentCredentialRequest
Request object for a change environment credentials request.
| Name | Description | Schema |
|---|---|---|
credentialName |
The credential name to set for the environment. This must be a credential that already exists. |
string |
environmentName |
The name or CRN of the environment. |
string |
ChangeEnvironmentCredentialResponse
Response object for a change environment credentials request.
| Name | Description | Schema |
|---|---|---|
environment |
The environment summary. |
CheckDatabaseConnectivityRequest
Request object for checking Database connectivity.
| Name | Description | Schema |
|---|---|---|
host |
Host value. |
string |
name |
Database name value. |
string |
password |
Password value. |
string |
port |
Port value. |
integer (int32) |
username |
Username value. |
string |
CheckDatabaseConnectivityResponse
Response object for checking Database connectivity.
| Name | Description | Schema |
|---|---|---|
message |
Message explaining the result. |
string |
result |
Result of the connectivity check. |
enum (SUCCESS, FAILURE) |
CheckEnvironmentConnectivityRequest
Request object to check connectivity to private cloud environment.
| Name | Description | Schema |
|---|---|---|
address |
The address of the Cloudera Manager managing the Datalake cluster. |
string |
authenticationToken |
A string (text or json) used to authenticate to the Cloudera Manager. |
string |
authenticationTokenType |
How to interpret the authenticationToken field. Defaults to CLEARTEXT_PASSWORD. |
enum (CLEARTEXT_PASSWORD) |
clusterNames |
The name of the cluster(s) to use as a Datalake for the environment. |
< string > array |
user |
User name for accessing the Cloudera Manager. |
string |
CheckEnvironmentConnectivityResponse
Response object to check connectivity to private cloud environment.
| Name | Description | Schema |
|---|---|---|
clusters |
List of discovered clusters |
< CdpCluster > array |
CheckKubernetesConnectivityRequest
Request object for checking Kubernetes connectivity.
| Name | Description | Schema |
|---|---|---|
format |
Format of Kubernetes configuration file. Defaults to YAML. |
enum (YAML) |
kubeConfig |
Content of Kubernetes configuration file as a text blob in YAML format. |
string |
CheckKubernetesConnectivityResponse
Response object for checking Kubernetes connectivity.
| Name | Description | Schema |
|---|---|---|
message |
Message explaining the status. Used for Errors. |
string |
status |
Status of Kubernetes cluster. Also indicates connectivity. |
enum (SUCCESS, FAILURE) |
CloudSubnet
Information about a cloud provider subnet.
| Name | Description | Schema |
|---|---|---|
availabilityZone |
The availability zone of the subnet. |
string |
cidr |
The CIDR IP range of the subnet. |
string |
subnetId |
The id of the subnet. |
string |
subnetName |
The name of the subnet. |
string |
CollectFreeipaDiagnosticsRequest
Request object for collecting FreeIPA diagnostics.
| Name | Description | Schema |
|---|---|---|
additionalLogs |
Array of log descriptors that should be additionally collected during diagnostics collection. |
< FreeipaVmLogRequest > array |
caseNumber |
Optional support case number in case of SUPPORT destination, otherwise only act as additional data. |
string |
description |
Additional information / title for the diagnostics collection. |
string |
destination |
Destination of the diagnostics collection (Support, Own cloud storage, Engineering or collect only on the nodes) |
enum (SUPPORT, CLOUD_STORAGE, ENG, LOCAL) |
endDate |
Date timestamp - collect files only for diagnostics that has lower created timestamp value than this. |
string (date-time) |
environmentName |
The name or CRN of the environment. |
string |
excludeHosts |
Array of host names (fqdn or IP address), collection will not run on the excluded hosts. |
< string > array |
hostGroups |
Array of host groups, collection will run only on the dedicated hosts that belongs to these host groups. |
< string > array |
hosts |
Array of host names (fqdn), collection will run only on the dedicated hosts. |
< string > array |
includeNginxReport |
Include Nginx report generated by GoAccess (if available). |
boolean |
includeSaltLogs |
Include salt minion/master/api system logs in the diagnostics collection. |
boolean |
includeSarOutput |
Include SAR (System Activity Report) generated outputs in the diagnostics collection (if available). |
boolean |
labels |
Array of labels that can filter logs that are collected during diagnostics collection. |
< string > array |
skipUnresponsiveHosts |
Skip unhealthy hosts from the diagnostics collection. |
boolean |
startDate |
Date timestamp - collect files only for diagnostics that has higher last modified timestamp value than this. |
string (date-time) |
storageValidation |
Enable/disable node level storage validation (can be disabled for example, if you have too many hosts and do not want to do too much parallel writes to s3/abfs) |
boolean |
updatePackage |
If enabled, required package (cdp-telemetry) will be upgraded or installed on the nodes. (useful if package is not installed or needs to be upgraded) Network is required for this operation. |
boolean |
CollectFreeipaDiagnosticsResponse
Response object for collecting FreeIPA diagnostics.
Type : object
ConnectedDataService
A single entry that contains the name of the given Data Service and its related resource(s).
| Name | Description | Schema |
|---|---|---|
clusters |
List of resource names for the given Data Service. |
< string > array |
name |
The name of the given Data Service. |
string |
CreateAWSCredentialRequest
Request object for a create AWS credential request.
| Name | Description | Schema |
|---|---|---|
credentialName |
The name of the credential. |
string |
description |
A description for the credential. |
string |
roleArn |
The ARN of the delegated access role. |
string |
CreateAWSCredentialResponse
Response object for a create AWS credential request.
| Name | Description | Schema |
|---|---|---|
credential |
The credential object. |
CreateAWSEnvironmentRequest
Request object for a create AWS environment request.
| Name | Description | Schema |
|---|---|---|
authentication |
SSH authentication information for accessing cluster node instances. Users with access to this authentication information have root level access to the Data Lake and Data Hub cluster instances. |
|
computeClusterConfiguration |
The Externalized k8s configuration create request for the environment |
|
createPrivateSubnets |
Whether to create private subnets or not. |
boolean |
createServiceEndpoints |
Whether to create service endpoints or not. |
boolean |
credentialName |
Name of the credential to use for the environment. |
string |
customDockerRegistry |
Configures the desired custom docker registry for data services. |
|
description |
An description of the environment. |
string |
enableComputeCluster |
Enable compute clusters for environment |
boolean |
enableTunnel |
Whether to enable SSH tunneling for the environment. |
boolean |
encryptionKeyArn |
ARN of the AWS KMS CMK to use for the server-side encryption of AWS storage resources. |
string |
endpointAccessGatewayScheme |
The scheme for the endpoint gateway. PUBLIC creates an external endpoint that can be accessed over the Internet. Defaults to PRIVATE which restricts the traffic to be internal to the VPC. |
enum (PUBLIC, PRIVATE) |
endpointAccessGatewaySubnetIds |
The subnets to use for endpoint access gateway. |
< string > array |
environmentName |
The name of the environment. Must contain only lowercase letters, numbers and hyphens. |
string |
freeIpa |
The FreeIPA creation request for the environment |
|
image |
The FreeIPA image request for the environment |
|
logStorage |
AWS storage configuration for cluster and audit logs. |
|
networkCidr |
The network CIDR. This will create a VPC along with subnets in multiple Availability Zones. |
string |
proxyConfigName |
Name of the proxy config to use for the environment. |
string |
region |
The region of the environment. |
string |
reportDeploymentLogs |
When true, this will report additional diagnostic information back to Cloudera. |
boolean |
s3GuardTableName |
Deprecated. S3Guard was used to ensure consistent S3 updates when S3 was still eventually consistent. With the introduction of Consistent S3, the goal and usage of S3 Guard have become superfluous and defunct. |
string |
securityAccess |
Security control for FreeIPA and Data Lake deployment. |
|
subnetIds |
One or more subnet IDs within the VPC. Mutually exclusive with networkCidr. |
< string > array |
tags |
Tags associated with the resources. |
< TagRequest > array |
vpcId |
The Amazon VPC ID. Mutually exclusive with networkCidr. |
string |
workloadAnalytics |
When this is enabled, diagnostic information about job and query execution is sent to Workload Manager for Data Hub clusters created within this environment. |
boolean |
CreateAWSEnvironmentResponse
Response object for a create AWS environment request.
| Name | Description | Schema |
|---|---|---|
environment |
Created environment object. |
CreateAWSGovCloudCredentialRequest
Request object for a create AWS credential request for GovCloud.
| Name | Description | Schema |
|---|---|---|
credentialName |
The name of the credential. |
string |
description |
A description for the credential. |
string |
roleArn |
The ARN of the delegated access role. |
string |
CreateAWSGovCloudCredentialResponse
Response object for a create AWS credential request for GovCloud.
| Name | Description | Schema |
|---|---|---|
credential |
The credential object. |
CreateAWSGovCloudEnvironmentRequest
Request object for a create AWS GovCloud environment request.
| Name | Description | Schema |
|---|---|---|
authentication |
SSH authentication information for accessing cluster node instances. Users with access to this authentication information have root level access to the Data Lake and Data Hub cluster instances. |
|
createPrivateSubnets |
Whether to create private subnets or not. |
boolean |
createServiceEndpoints |
Whether to create service endpoints or not. |
boolean |
credentialName |
Name of the credential to use for the environment. |
string |
customDockerRegistry |
Configures the desired custom docker registry for data services. |
|
description |
An description of the environment. |
string |
enableTunnel |
Whether to enable SSH tunneling for the environment. |
boolean |
encryptionKeyArn |
ARN of the AWS KMS CMK to use for the server-side encryption of AWS storage resources. |
string |
endpointAccessGatewayScheme |
The scheme for the endpoint gateway. PUBLIC creates an external endpoint that can be accessed over the Internet. Defaults to PRIVATE which restricts the traffic to be internal to the VPC. |
enum (PUBLIC, PRIVATE) |
endpointAccessGatewaySubnetIds |
The subnets to use for endpoint access gateway. |
< string > array |
environmentName |
The name of the environment. Must contain only lowercase letters, numbers and hyphens. |
string |
freeIpa |
The FreeIPA creation request for the environment |
|
image |
The FreeIPA image request for the environment |
|
logStorage |
AWS storage configuration for cluster and audit logs. |
|
networkCidr |
The network CIDR. This will create a VPC along with subnets in multiple Availability Zones. |
string |
proxyConfigName |
Name of the proxy config to use for the environment. |
string |
region |
The region of the environment. |
string |
reportDeploymentLogs |
When true, this will report additional diagnostic information back to Cloudera. |
boolean |
s3GuardTableName |
Deprecated. S3Guard was used to ensure consistent S3 updates when S3 was still eventually consistent. With the introduction of Consistent S3, the goal and usage of S3 Guard have become superfluous and defunct. |
string |
securityAccess |
Security control for FreeIPA and Data Lake deployment. |
|
subnetIds |
One or more subnet IDs within the VPC. Mutually exclusive with networkCidr. |
< string > array |
tags |
Tags associated with the resources. |
< TagRequest > array |
vpcId |
The Amazon VPC ID. Mutually exclusive with networkCidr. |
string |
workloadAnalytics |
When this is enabled, diagnostic information about job and query execution is sent to Workload Manager for Data Hub clusters created within this environment. |
boolean |
CreateAWSGovCloudEnvironmentResponse
Response object for a create AWS GovCloud environment request.
| Name | Description | Schema |
|---|---|---|
environment |
Created environment object. |
CreateAzureCredentialRequest
Request object for a create Azure credential request.
| Name | Description | Schema |
|---|---|---|
appBased |
Additional configurations needed for app-based authentication. |
|
credentialName |
The name of the credential. |
string |
description |
A description for the credential. |
string |
subscriptionId |
The Azure subscription ID. Required for secret based credentials and optional for certificate based ones. |
string |
tenantId |
The Azure AD tenant ID for the Azure subscription. Required for secret based credentials and optional for certificate based ones. |
string |
appBased
| Name | Description | Schema |
|---|---|---|
applicationId |
The id of the application registered in Azure. |
string |
authenticationType |
Authentication type of the credential |
|
secretKey |
The client secret key (also referred to as application password) for the registered application. |
string |
CreateAzureCredentialResponse
Response object for a create Azure credential request.
| Name | Description | Schema |
|---|---|---|
credential |
The credential object. |
CreateAzureEnvironmentRequest
Request object for a create Azure environment request.
| Name | Description | Schema |
|---|---|---|
availabilityZones |
The zones of the environment in the given region. |
< string > array |
computeClusterConfiguration |
The Externalized k8s configuration create request for the environment. |
|
createPrivateEndpoints |
When this is enabled, then Azure Postgres will be configured with Private Endpoint and a Private DNS Zone. When this is disabled, then Azure Service Endpoints will be created. The default value is disabled. |
boolean |
credentialName |
Name of the credential to use for the environment. |
string |
customDockerRegistry |
Configures the desired custom docker registry for data services. |
|
dataServices |
Data Services parameters of the environment. |
|
description |
An description of the environment. |
string |
enableComputeCluster |
Enable compute clusters for environment |
boolean |
enableOutboundLoadBalancer |
Whether or not outbound load balancers should be created for Azure environments. The default behavior is to not create the outbound load balancer. |
boolean |
enableTunnel |
Whether to enable SSH tunneling for the environment. |
boolean |
encryptionAtHost |
When this is enabled, we will provision resources with host encrypted true flag. |
boolean |
encryptionKeyResourceGroupName |
Name of the existing Azure resource group hosting the Azure Key Vault containing customer managed key which will be used to encrypt the Azure Managed Disks. It is required only when the entitlement is granted and the resource group of the key vault is different from the resource group in which the environment is to be created. Omitting it implies that, the key vault containing the encryption key is present in the same resource group where the environment would be created. |
string |
encryptionKeyUrl |
URL of the key which will be used to encrypt the Azure Managed Disks, if entitlement has been granted. |
string |
encryptionUserManagedIdentity |
User managed identity for encryption. |
string |
endpointAccessGatewayScheme |
The scheme for the endpoint gateway. PUBLIC creates an external endpoint that can be accessed over the Internet. Defaults to PRIVATE which restricts the traffic to be internal to the VNet. |
enum (PUBLIC, PRIVATE) |
endpointAccessGatewaySubnetIds |
The subnets to use for endpoint access gateway. |
< string > array |
environmentName |
The name of the environment. Must contain only lowercase letters, numbers and hyphens. |
string |
existingNetworkParams |
Parameters needed to use an existing VNet and Subnets. |
|
flexibleServerSubnetIds |
The subnets delegated for Flexible Server database. Accepts either the name or the full resource id. |
< string > array |
freeIpa |
The FreeIPA creation request for the environment |
|
image |
The FreeIPA image request for the environment |
|
logStorage |
Azure storage configuration for cluster and audit logs. |
|
newNetworkParams |
Parameteres needed to automatically create VNet and Subnets. |
|
proxyConfigName |
Name of the proxy config to use for the environment. |
string |
publicKey |
Public SSH key string. The associated private key can be used to get root-level access to the Data Lake instance and Data Hub cluster instances. |
string |
region |
The region of the environment. |
string |
reportDeploymentLogs |
When true, this will report additional diagnostic information back to Cloudera. |
boolean |
resourceGroupName |
Name of an existing Azure resource group to be used for the environment. If it is not specified then new resource groups will be generated. |
string |
securityAccess |
Security control for FreeIPA and Data Lake deployment. |
|
tags |
Tags associated with the resources. |
< TagRequest > array |
usePublicIp |
Whether to associate public ip’s to the resources within the network. |
boolean |
userManagedIdentity |
User managed identity for encryption. (deprecated) |
string |
workloadAnalytics |
When this is enabled, diagnostic information about job and query execution is sent to Workload Manager for Data Hub clusters created within this environment. |
boolean |
newNetworkParams
| Name | Description | Schema |
|---|---|---|
networkCidr |
The range of private IPv4 addresses that resources will use under the created VNet. |
string |
CreateAzureEnvironmentResponse
Response object for a create Azure environment request.
| Name | Description | Schema |
|---|---|---|
environment |
Created environment object. |
CreateGCPCredentialRequest
Request object for a create GCP credential request.
| Name | Description | Schema |
|---|---|---|
credentialKey |
The JSON key for the service account. Please use local path when using the CLI (e.g. file:///absolute/path/to/cred.json) to avoid exposing the keys in the command line history. |
string |
credentialName |
The name of the credential. |
string |
description |
A description for the credential. |
string |
CreateGCPCredentialResponse
Response object for a create GCP credential request.
| Name | Description | Schema |
|---|---|---|
credential |
The credential object. |
CreateGCPEnvironmentRequest
Request object for a create GCP environment request.
| Name | Description | Schema |
|---|---|---|
availabilityZones |
The zones of the environment in the given region. Multi-zone selection is not supported in GCP yet. It accepts only one zone until support is added. |
< string > array |
credentialName |
Name of the credential to use for the environment. |
string |
customDockerRegistry |
Configures the desired custom docker registry for data services. |
|
description |
A description of the environment. |
string |
enableTunnel |
Whether to enable SSH tunneling for the environment. |
boolean |
encryptionKey |
Key Resource ID of the customer managed encryption key to encrypt GCP resources. |
string |
endpointAccessGatewayScheme |
The scheme for the endpoint gateway. PUBLIC creates an external endpoint that can be accessed over the Internet. Defaults to PRIVATE which restricts the traffic to be internal to the VPC. |
enum (PUBLIC, PRIVATE) |
endpointAccessGatewaySubnetIds |
The subnets to use for endpoint access gateway. |
< string > array |
environmentName |
The name of the environment. Must contain only lowercase letters, numbers and hyphens. |
string |
existingNetworkParams |
Parameters needed to use an existing VPC and Subnets. For now only existing network params is supported. |
|
freeIpa |
The FreeIPA creation request for the environment |
|
logStorage |
GCP storage configuration for cluster and audit logs. |
|
proxyConfigName |
Name of the proxy config to use for the environment. |
string |
publicKey |
Public SSH key string. The associated private key can be used to get root-level access to the Data Lake instance and Data Hub cluster instances. |
string |
region |
The region of the environment. |
string |
reportDeploymentLogs |
When true, this will report additional diagnostic information back to Cloudera. |
boolean |
securityAccess |
Firewall rules for FreeIPA, Data Lake and Data Hub deployment. |
|
tags |
Tags that can be attached to GCP resources. Please refer to Google documentation for the rules https://cloud.google.com/compute/docs/labeling-resources#label_format. |
< GcpTagRequest > array |
usePublicIp |
Whether to associate public ip’s to the resources within the network. |
boolean |
workloadAnalytics |
When this is enabled, diagnostic information about job and query execution is sent to Workload Manager for Data Hub clusters created within this environment. |
boolean |
CreateGCPEnvironmentResponse
Response object for a create GCP environment request.
| Name | Description | Schema |
|---|---|---|
environment |
Created environment object. |
CreatePrivateEnvironmentRequest
Request object for a create private cloud environment request.
| Name | Description | Schema |
|---|---|---|
address |
The address of the Cloudera Manager managing the Datalake cluster. |
string |
authenticationToken |
A string (text or json) used to authenticate to the Cloudera Manager. |
string |
authenticationTokenType |
How to interpret the authenticationToken field. Defaults to CLEARTEXT_PASSWORD. |
enum (CLEARTEXT_PASSWORD) |
clusterNames |
The name of the cluster(s) to use as a Datalake for the environment. |
< string > array |
description |
An description of the environment. |
string |
dockerConfigJson |
docker pull secrets for the K8s cluster. This is expected to be a docker config json. |
string |
dockerUserPass |
Alternative to dockerConfigJson. |
|
domain |
default domain suffix to work workload applications to use. |
string |
environmentName |
The name of the environment. Must contain only lowercase letters, numbers and hyphens. |
string |
kubeConfig |
Name of credentials holding kubeconfig for access to the kubernetes cluster paired with this Environment. |
string |
namespacePrefix |
Prefix for all namespaces created by Cloudera Data Platform within this cluster. |
string |
platform |
the K8s cluster type used for the environment. |
string |
storageClass |
An existing storage class on this kubernetes cluster. If not specified, the default storage class will be used. |
string |
user |
User name for accessing the Cloudera Manager. |
string |
dockerUserPass
| Name | Description | Schema |
|---|---|---|
email |
Docker email. |
string |
password |
Docker password. |
string |
server |
Docker Registry FQDN. |
string |
username |
Docker username. |
string |
CreatePrivateEnvironmentResponse
Response object for a create private cloud environment request.
| Name | Description | Schema |
|---|---|---|
environment |
Created environment object. |
CreateProxyConfigRequest
Request object for a create proxy config request.
| Name | Description | Schema |
|---|---|---|
description |
A description for the proxy config. |
string |
host |
The proxy host. |
string |
noProxyHosts |
Comma-separated list of 'CIDR', '[.]host[:port]' (can be a subdomain as well) and 'IP[:port]' entries that should not be proxied. Wildcards are not accepted. For example .cloudera.com,192.168.1.1 |
string |
password |
The proxy password. |
string |
port |
The proxy port. |
integer (int32) |
protocol |
The protocol. |
string |
proxyConfigName |
The name of the proxy config. |
string |
user |
The proxy user. |
string |
CreateProxyConfigResponse
Response object for a create proxy config request.
| Name | Description | Schema |
|---|---|---|
proxyConfig |
The proxy config object. |
Credential
A credential object.
| Name | Description | Schema |
|---|---|---|
awsCredentialProperties |
The credential properties that closely related to those that have been created on AWS. |
|
azureCredentialProperties |
The credential properties that closely related to those that have been created on Azure. |
|
cloudPlatform |
The cloud provider. |
string |
created |
Creation date |
string (date-time) |
credentialName |
The name of the credential. |
string |
crn |
The CRN of the credential. |
string |
description |
A description for the credential. |
string |
gcpCredentialProperties |
The credential properties that closely related to those that have been created on GCP. |
|
skipOrgPolicyDecisions |
Skips organization policy decisions during cloud storage validation. |
boolean |
verifyPermissions |
When true, verifies credential permissions. |
boolean |
CredentialGranularPolicyResponse
Response object for the granular policy for the given service or experience.
| Name | Description | Schema |
|---|---|---|
policyJson |
The policy JSON encoded in base64. |
string |
service |
The name of the service that requires the given policy for resource management. |
string |
CustomDockerRegistryRequest
The desired custom docker registry for data services to be used.
| Name | Description | Schema |
|---|---|---|
crn |
The CRN of the desired custom docker registry for data services to be used. |
string |
CustomDockerRegistryResponse
The configured custom docker registry for data services.
| Name | Description | Schema |
|---|---|---|
crn |
The CRN of the configured custom docker registry for data services on the environment. |
string |
DataServices
Data Services parameters response of the environment.
| Name | Description | Schema |
|---|---|---|
azure |
Azure-specific Data Service parameters response. |
DataServicesRequest
Data Services parameters request of the environment.
| Name | Description | Schema |
|---|---|---|
azure |
Azure-specific Data Service parameters request. |
DeleteAuditCredentialRequest
Request object for a delete audit credential request.
| Name | Description | Schema |
|---|---|---|
credentialName |
The name or CRN of the credential. |
string |
DeleteAuditCredentialResponse
Response object for a delete audit credential request.
Type : object
DeleteCredentialRequest
Request object for a delete credential request.
| Name | Description | Schema |
|---|---|---|
credentialName |
The name or CRN of the credential. |
string |
DeleteCredentialResponse
Response object for a delete credential request.
Type : object
DeleteEnvironmentRequest
Request object for a delete environment request.
| Name | Description | Schema |
|---|---|---|
cascading |
Delete all connected resources too. |
boolean |
environmentName |
The name or CRN of the environment. |
string |
forced |
Force delete action removes CDP resources and may leave cloud provider resources running even if the deletion did not succeed. |
boolean |
DeleteEnvironmentResponse
Response object for a delete environment request.
Type : object
DeleteProxyConfigRequest
Request object for a delete proxy config request.
| Name | Description | Schema |
|---|---|---|
proxyConfigName |
The name or CRN of the proxy config. |
string |
DeleteProxyConfigResponse
Response object for a delete proxy config request.
Type : object
DescribeEnvironmentRequest
Request object for a describe environment request.
| Name | Description | Schema |
|---|---|---|
environmentName |
The names or CRN of the environment. In case of hybrid environments this can be only CRN. |
string |
DescribeEnvironmentResponse
Response object for a describe environment request.
| Name | Description | Schema |
|---|---|---|
environment |
The environment. |
DetachFreeIpaRecipesRequest
Request object for detaching recipes from FreeIPA.
| Name | Description | Schema |
|---|---|---|
environment |
The environment name or CRN of the FreeIPA. |
string |
recipes |
The list of recipes to detach. |
< string > array |
DetachFreeIpaRecipesResponse
Response object for detaching recipes from FreeIPA.
Type : object
DisableS3GuardRequest
Request object for disabling S3Guard in an environment.
| Name | Description | Schema |
|---|---|---|
environmentName |
The name or CRN of the environment. |
string |
DisableS3GuardResponse
Response object for disabling S3Guard in an environment.
| Name | Description | Schema |
|---|---|---|
s3GuardResponse |
Response status for disabling S3Guard in an environment. |
string |
DownscaleFreeipaRequest
The request object for FreeIPA downscale. Either targetAvailabilityType or instances
| Name | Description | Schema |
|---|---|---|
environmentName |
The name or CRN of the environment. |
string |
instances |
The instance Ids to downscale. |
< string > array |
targetAvailabilityType |
The target FreeIPA availability type. |
enum (HA, TWO_NODE_BASED) |
DownscaleFreeipaResponse
The response object for FreeIPA downscale.
| Name | Description | Schema |
|---|---|---|
operationId |
UUID of the request for this operation. This ID can be used to get the status of the operation. |
string |
originalAvailabilityType |
The target FreeIPA availability type. |
enum (HA) |
targetAvailabilityType |
The target FreeIPA availability type. |
enum (HA, TWO_NODE_BASED) |
EnvValidation
Object for validating services.
| Name | Description | Schema |
|---|---|---|
message |
Validation message. |
string |
severity |
The level of validation severity. |
enum (INFO, WARNING, ERROR) |
Environment
The environment.
| Name | Description | Schema |
|---|---|---|
authentication |
SSH key for accessing cluster node instances. |
|
awsComputeClusterConfiguration |
The Externalized AWS k8s configuration for the environment. |
|
awsDetails |
AWS-specific environment configuration information. |
|
azureComputeClusterConfiguration |
The Externalized Azure k8s configuration for the environment. |
|
azureDetails |
Azure specific environment configuration information. |
|
backupStorage |
Storage configuration for backup. |
|
cloudPlatform |
Cloud platform of the environment. |
string |
computeClusterEnabled |
Compute clusters enabled |
boolean |
created |
Creation date |
string (date-time) |
creator |
The CRN of the user who has created the given environment. |
string |
credentialName |
Name of the credential of the environment. |
string |
crn |
CRN of the environment. |
string |
customDockerRegistry |
The configured custom docker registry for data services on the environment. |
|
dataServices |
Data Services parameters of the environment. |
|
description |
Description of the environment |
string |
environmentName |
Name of the environment. |
string |
freeipa |
Details of FreeIPA instance associated with this environment. |
|
gcpDetails |
GCP specific environment configuration information. |
|
logStorage |
Storage configuration for cluster and audit logs. |
|
network |
Network related specifics of the environment. |
|
proxyConfig |
The proxy config. |
|
region |
Region of the environment. |
string |
reportDeploymentLogs |
When true, this will report additional diagnostic information back to Cloudera. |
boolean |
securityAccess |
Security control for FreeIPA and Data Lake deployment. |
|
status |
Status of the environment. |
string |
statusReason |
The status reason. |
string |
tags |
Environment tags object containing the tag values defined for the environment. |
|
tunnelEnabled |
Whether tunneling is enabled for the environment. |
boolean |
tunnelType |
CCM version |
|
workloadAnalytics |
When this is enabled, diagnostic information about job and query execution is sent to Workload Manager for Data Hub clusters created within this environment. |
boolean |
awsDetails
| Name | Description | Schema |
|---|---|---|
s3GuardTableName |
Deprecated. S3Guard was used to ensure consistent S3 updates when S3 was still eventually consistent. With the introduction of Consistent S3, the goal and usage of S3 Guard have become superfluous and defunct. |
string |
azureDetails
| Name | Description | Schema |
|---|---|---|
resourceEncryptionParameters |
Object containing details of encryption parameters for Azure cloud. |
|
resourceGroupName |
Name of an existing Azure resource group to be used for the environment. If it is not specified then new resource groups will be generated. |
string |
gcpDetails
| Name | Description | Schema |
|---|---|---|
sharedProjectId |
ID of the Google project where the resources are created. |
string |
EnvironmentSummary
The environment summary.
| Name | Description | Schema |
|---|---|---|
cloudPlatform |
Cloud platform of the environment. |
string |
computeClusterEnabled |
Compute clusters enabled |
boolean |
created |
Creation date |
string (date-time) |
credentialName |
Name of the credential of the environment. Must contain only lowercase letters, numbers and hyphens. |
string |
crn |
CRN of the environment. |
string |
description |
Description of the environment. |
string |
environmentName |
Name of the environment. |
string |
proxyConfigName |
Name of the proxy config of the environment. |
string |
region |
Region of the environment. |
string |
status |
Status of the environment, |
string |
EnvironmentTags
Environment tags object containing the tag values defined for the environment.
| Name | Description | Schema |
|---|---|---|
defaults |
Map of tag names to values, for default tags. |
< string, string > map |
userDefined |
Map of tag names to values, for user-defined tags. |
< string, string > map |
Error
An object returned on an error.
| Name | Description | Schema |
|---|---|---|
code |
The error code. |
string |
message |
The error message. |
string |
ExistingAzureNetworkRequest
Request object for creating an Azure environment using existing VNet and subnets.
| Name | Description | Schema |
|---|---|---|
aksPrivateDnsZoneId |
The full Azure resource ID of an existing Private DNS zone used for the AKS. |
string |
databasePrivateDnsZoneId |
The full Azure resource ID of the existing Private DNS Zone used for Flexible Server and Single Server Databases. |
string |
networkId |
The id of the Azure VNet. |
string |
resourceGroupName |
The name of the resource group associated with the VNet. |
string |
subnetIds |
One or more subnet ids within the VNet. |
< string > array |
ExistingGCPNetworkRequest
Request object for creating an GCP environment using existing VPC and subnets.
| Name | Description | Schema |
|---|---|---|
networkName |
The name of the GCP VPC. |
string |
sharedProjectId |
The ID of the Google project associated with the VPC. |
string |
subnetNames |
One or more subnet names within the VPC. Google VPC’s are global, please give subnets from single geographic region only to reduce latency. |
< string > array |
ExposedService
Exposed CDP DC service object.
| Name | Description | Schema |
|---|---|---|
displayName |
Display name of service. |
string |
name |
Name of service. |
string |
serviceUrl |
URL of service. |
string |
serviceValidationMessages |
List of service validation message. |
< EnvValidation > array |
serviceVersion |
Version of service. |
string |
status |
Status of service. |
string |
type |
Type of service. |
string |
FreeIPANodeStatus
The status and issues of an individual FreeIPA node.
| Name | Description | Schema |
|---|---|---|
hostname |
The hostname of the ipa instance. |
string |
instanceId |
The instance ID for the instance. |
string |
issues |
A list of issues the node is having |
< string > array |
status |
The status of the individual node |
enum (REQUESTED, CREATED, UNREGISTERED, REGISTERED, DECOMMISSIONED, TERMINATED, DELETED_ON_PROVIDER_SIDE, DELETED_BY_PROVIDER, FAILED, STOPPED, REBOOTING, UNREACHABLE, UNHEALTHY, DELETE_REQUESTED) |
FreeIpaImageRequest
Request object for FreeIPA image.
| Name | Description | Schema |
|---|---|---|
catalog |
Image catalog to use for FreeIPA image selection. |
string |
id |
Image ID to use for creating FreeIPA instances. |
string |
os |
The OS to use for creating FreeIPA instances. |
string |
FreeIpaInstance
Object for a FreeIPA instance providing specific information about the instance.
| Name | Description | Schema |
|---|---|---|
attachedVolumes |
List of volumes attached to this instance. |
< AttachedVolumeDetail > array |
availabilityZone |
The availability zone of the instance. |
string |
discoveryFQDN |
The fully qualified domain name of the instance in the service discovery cluster. |
string |
instanceGroup |
The instance group that contains the instance. |
string |
instanceId |
The instance ID for the instance. |
string |
instanceStatus |
The status of the instance. |
string |
instanceStatusReason |
The status reason for the instance. |
string |
instanceType |
The type of the instance (either GATEWAY or GATEWAY_PRIMARY). |
string |
instanceVmType |
The VM type of the instance. Supported values depend on the cloud platform. |
string |
lifeCycle |
The life cycle type for the instance (either NORMAL or SPOT). |
string |
privateIP |
The private IP of the instance. |
string |
publicIP |
The public IP of the instance. |
string |
sshPort |
The SSH port of the instance. |
integer (int32) |
subnetId |
The subnet ID of the instance. |
string |
FreeipaDetails
Details of a FreeIPA cluster.
| Name | Description | Schema |
|---|---|---|
crn |
CRN of the FreeIPA cluster. |
string |
domain |
The domain name of the FreeIPA cluster. |
string |
hostname |
The hostname of the FreeIPA cluster. |
string |
instanceCountByGroup |
The number of FreeIPA instances to create per group when creating FreeIPA in environment. |
integer (int32) |
instances |
The instances of the FreeIPA cluster. |
< FreeIpaInstance > array |
multiAz |
Whether the given FreeIPA is deployed in a multi-availability zone way or not. |
boolean |
recipes |
The recipes for the FreeIPA cluster. |
< string > array |
serverIP |
The IP addresses of the FreeIPA cluster. |
< string > array |
FreeipaDiagnosticsCollectionDetailsResponse
Response object for diagnostic collection details.
| Name | Description | Schema |
|---|---|---|
accountId |
Account Id that was used for the diagnostics collection. |
string |
case |
Case number for the diagnostics collection. |
string |
clusterVersion |
Version of the cluster that was used for the diagnostics collection. |
string |
description |
Description of the diagnostics collection. |
string |
destination |
Destination type of the diagnostics collection. |
string |
output |
Output destination of the diagnostics collection. |
string |
resourceCrn |
Crn of the Freeipa cluster. |
string |
FreeipaDiagnosticsCollectionResponse
Response object for diagnostic collection flow details.
| Name | Description | Schema |
|---|---|---|
collectionDetails |
Additional details about the diagnostics collection. |
|
created |
Creation date of the diagnostics collection flow. |
string (date-time) |
flowId |
Flow ID of the diagnostics collection flow. |
string |
flowState |
Current state of the diagnostics collection flow. |
string |
progressPercentage |
Progress percentage of the diagnostics collection flow (maximum value if finished). |
integer (int32) |
status |
Status of the diagnostics collection flow. |
enum (RUNNING, FAILED, FINISHED, CANCELLED) |
FreeipaVmLogRequest
Log descriptor, contains a path and label pair. Used for diagnostics collections.
| Name | Description | Schema |
|---|---|---|
label |
Label that will be used to identify a log descriptor. (will be used as a folder inside logs folder) |
string |
path |
Path of the log file(s) that needs to be collected. (Can be glob wildcard) |
string |
FreeipaVmLogResponse
Log descriptor, contains a path and label pair. Used for diagnostics collections.
| Name | Description | Schema |
|---|---|---|
label |
Label that will be used to identify a log descriptor. (will be used as a folder inside logs folder) |
string |
path |
Path of the log file(s) that needs to be collected. (Can be glob wildcard) |
string |
GCPCredentialProperties
The credential properties that closely related to those that have created on GCP.
| Name | Description | Schema |
|---|---|---|
keyType |
The GCP credential key type. Json is the only supported key type. |
string |
GCPFreeIpaCreationRequest
Request object for creating FreeIPA in the environment.
| Name | Description | Schema |
|---|---|---|
instanceCountByGroup |
The number of FreeIPA instances to create per group when creating FreeIPA in the environment |
integer (int32) |
instanceType |
Custom instance type of FreeIPA instances. |
string |
recipes |
The recipes for the FreeIPA cluster. |
< string > array |
GcpCredentialPrerequisitesResponse
Response object for getting GCP credential prerequisites.
| Name | Description | Schema |
|---|---|---|
serviceAccountCreationCommand |
GCP CLI command to create service account encoded in base64. |
string |
GcpLogStorageRequest
GCP storage configuration for cluster and audit logs.
| Name | Description | Schema |
|---|---|---|
backupStorageLocationBase |
The Google storage bucket to use. This should be a gs:// url. |
string |
serviceAccountEmail |
Email id of the service account to be associated with the instances. This service account should have "storage.ObjectCreator" role on the given storage bucket. |
string |
storageLocationBase |
The Google storage bucket to use. This should be a gs:// url. |
string |
GcpSecurityAccessRequest
Firewall rules for FreeIPA, Data Lake and Data Hub deployment.
| Name | Description | Schema |
|---|---|---|
defaultSecurityGroupId |
Firewall rule for other hosts. |
string |
securityGroupIdForKnox |
Firewall rule for Knox hosts. |
string |
GcpTagRequest
A label that can be attached to GCP resources. Please refer to Google documentation for the rules https://cloud.google.com/compute/docs/labeling-resources#label_format.
| Name | Description | Schema |
|---|---|---|
key |
The tag’s name. |
string |
value |
The associated value of the tag. |
string |
GetAccountTelemetryDefaultRequest
Request object for get default account level telemetry settings.
Type : object
GetAccountTelemetryDefaultResponse
Response object for get default account level telemetry settings.
| Name | Description | Schema |
|---|---|---|
reportDeploymentLogs |
Flag to enable account level deployment log collection. (that will be used as a default for environment) |
boolean |
rules |
List of anonymization rules that are applied on logs that are shipped to Cloudera |
< AnonymizationRuleResponse > array |
workloadAnalytics |
Flag to enable account level workload analytics. (that will be used as a default for environment) |
boolean |
GetAccountTelemetryRequest
Request object for get account level telemetry settings.
Type : object
GetAccountTelemetryResponse
Response object for get account level telemetry settings.
| Name | Description | Schema |
|---|---|---|
reportDeploymentLogs |
Flag to enable account level deployment log collection. (that will be used as a default for environment) |
boolean |
rules |
List of anonymization rules that are applied on logs that are shipped to Cloudera |
< AnonymizationRuleResponse > array |
workloadAnalytics |
Flag to enable account level workload analytics. (that will be used as a default for environment) |
boolean |
GetAuditCredentialPrerequisitesRequest
Request object for getting the audit credential prerequisites for the given cloud platform.
| Name | Description | Schema |
|---|---|---|
cloudPlatform |
The kind of cloud platform. |
enum (AWS, AZURE, GCP) |
GetAuditCredentialPrerequisitesResponse
The audit credential prerequisites.
| Name | Description | Schema |
|---|---|---|
accountId |
The provider specific identifier of the account/subscription/project that is used by Cloudbreak. |
string |
aws |
Provides the external id and policy JSON (this one encoded in base64) for AWS credential creation. |
|
azure |
Provides the app creation command and role definition Json for Azure credential creation. |
|
cloudPlatform |
The name of the given cloud platform |
string |
gcp |
Provides the service account creation command for GCP credential creation. |
GetAutomatedSyncEnvironmentStatusRequest
Request object for getting automated sync environment status.
| Name | Description | Schema |
|---|---|---|
environmentName |
The name or CRN of the environment. |
string |
GetAutomatedSyncEnvironmentStatusResponse
Response object for getting automated sync environment status.
| Name | Description | Schema |
|---|---|---|
environmentCrn |
The CRN of the environment. |
string |
lastSyncStatus |
Status of the last automated sync operation for the environment. |
|
syncPendingState |
The state to indicate whether the environment is synced or has a sync pending. |
enum (UNKNOWN, SYNC_PENDING, SYNCED, SYNC_HALTED) |
GetAzureImageTermsPolicyRequest
Request object to retrieve current value of setting that controls automatic acceptance of Azure Marketplace image terms.
Type : object
GetAzureImageTermsPolicyResponse
Response object to retrieve current value of setting that controls automatic acceptance of Azure Marketplace image terms.
| Name | Description | Schema |
|---|---|---|
accepted |
Flag denoting whether automatic Azure Marketplace image terms acceptance is enabled or disabled. |
boolean |
GetCredentialPrerequisitesRequest
Request object for getting the credential prerequisites for the given cloud platform.
| Name | Description | Schema |
|---|---|---|
cloudPlatform |
The kind of cloud platform. |
enum (AWS, AZURE) |
GetCredentialPrerequisitesResponse
The credential prerequisites for AWS.
| Name | Description | Schema |
|---|---|---|
accountId |
The provider specific identifier of the account/subscription/project that is used by Cloudbreak. |
string |
aws |
Provides the external id and policy JSON (this one encoded in base64) for AWS credential creation. |
|
azure |
Provides the app creation command and role definition Json for Azure credential creation. |
|
cloudPlatform |
The name of the given cloud platform |
string |
GetEnvironmentSettingRequest
Request object to query environment configuration settings.
| Name | Description | Schema |
|---|---|---|
attrs |
List of attributes to query settings for. Non-existant settings will be ignored. |
< string > array |
environmentName |
The name or CRN of the environment. Empty to get system wide settings. |
string |
GetEnvironmentSettingResponse
Response object containing configuration settings.
| Name | Description | Schema |
|---|---|---|
settings |
Dictionary of settings found. |
< string, string > map |
GetEnvironmentUserSyncStateRequest
Request object for retrieving the user sync state of an environment.
| Name | Description | Schema |
|---|---|---|
environmentName |
The name or CRN of the environment. |
string |
GetEnvironmentUserSyncStateResponse
Response object for retrieving the user sync state of an environment.
| Name | Description | Schema |
|---|---|---|
state |
The user sync state of the environment. |
enum (UP_TO_DATE, STALE, SYNC_IN_PROGRESS, SYNC_FAILED) |
userSyncOperationId |
Operation Id for the latest user sync operation, if any, run for this environment. |
string |
GetFreeipaLogDescriptorsRequest
Request object for obtaining log descriptors. (that are used for diagnostics collection)
Type : object
GetFreeipaLogDescriptorsResponse
Response object for obtaining log descriptors. (useful for diagnostics collection filtering)
| Name | Description | Schema |
|---|---|---|
logs |
Array of log descriptors. (useful for diagnostics collection filtering) |
< FreeipaVmLogResponse > array |
GetFreeipaStatusRequest
Request object for getting the status of the FreeIPA servers.
| Name | Description | Schema |
|---|---|---|
environmentName |
The environment name or CRN of the FreeIPA to repair |
string |
GetFreeipaStatusResponse
The overall status of the FreeIPA cluster.
| Name | Description | Schema |
|---|---|---|
environmentCrn |
The CRN of the environment |
string |
environmentName |
The name of the Environment |
string |
instances |
Status of individual nodes in the FreeIPA cluster |
< string, FreeIPANodeStatus > map |
status |
The overall status of the FreeIPA cluster |
enum (REQUESTED, CREATE_IN_PROGRESS, AVAILABLE, STACK_AVAILABLE, UPDATE_IN_PROGRESS, UPDATE_REQUESTED, UPDATE_FAILED, CREATE_FAILED, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETED, STOPPED, STOP_REQUESTED, START_REQUESTED, STOP_IN_PROGRESS, START_IN_PROGRESS, START_FAILED, STOP_FAILED, WAIT_FOR_SYNC, MAINTENANCE_MODE_ENABLED, UNREACHABLE, UNHEALTHY, DELETED_ON_PROVIDER_SIDE, UNKNOWN) |
GetFreeipaUpgradeOptionsRequest
The request object for retrieving FreeIPA upgrade candidates.
| Name | Description | Schema |
|---|---|---|
allowMajorOsUpgrade |
Allows the upgrade to a subsequent major OS version in the series. |
boolean |
catalog |
The URL of the source image catalog. If not specify this option we’ll use image catalog of the current image. |
string |
environment |
The name or the CRN of the environment. |
string |
GetFreeipaUpgradeOptionsResponse
The response object with available FreeIPA upgrade candidates.
| Name | Description | Schema |
|---|---|---|
currentImage |
The current image. |
|
images |
The list of the upgrade candidates. |
< ImageInfoResponse > array |
GetGovCloudAuditCredentialPrerequisitesRequest
Request object for getting the audit credential prerequisites for GovCloud for the enabled providers.
| Name | Description | Schema |
|---|---|---|
cloudPlatform |
The kind of cloud platform. As of now, the following cloud provider is accepted as the value of this field - AWS |
string |
GetGovCloudAuditCredentialPrerequisitesResponse
The audit credential prerequisites for GovCloud for the enabled providers.
| Name | Description | Schema |
|---|---|---|
accountId |
The provider specific identifier of the account/subscription/project. |
string |
aws |
Provides the external id and policy JSON (this one encoded in base64) for AWS credential creation. |
GetGovCloudCredentialPrerequisitesRequest
Request object for getting the credential prerequisites for GovCloud for the enabled providers.
| Name | Description | Schema |
|---|---|---|
cloudPlatform |
The kind of cloud platform. As of now, the following cloud provider is accepted as the value of this field - AWS |
string |
GetGovCloudCredentialPrerequisitesResponse
The credential prerequisites for GovCloud for the enabled providers.
| Name | Description | Schema |
|---|---|---|
accountId |
The provider specific identifier of the account/subscription/project. |
string |
aws |
Provides the external id and policy JSON (this one encoded in base64) for AWS GovCloud credential creation. |
GetIdBrokerMappingsRequest
Request object for getting ID Broker mappings for an environment.
| Name | Description | Schema |
|---|---|---|
environmentName |
The name or CRN of the environment. |
string |
GetIdBrokerMappingsResponse
Response object for getting ID Broker mappings for an environment.
| Name | Description | Schema |
|---|---|---|
baselineRole |
Deprecated. Please use rangerAuditRole instead. |
string |
dataAccessRole |
The cloud provider role to which data access services will be mapped (e.g. an ARN in AWS, a Resource ID in Azure). |
string |
mappings |
ID Broker mappings for individual actors and groups. Does not include mappings for data access services. May be empty if no individual mappings are needed. |
< IdBrokerMapping > array |
mappingsVersion |
The version of the mappings. |
integer (int64) |
rangerAuditRole |
The cloud provider role to which services that write to Ranger audit logs will be mapped (e.g. an ARN in AWS, a Resource ID in Azure). Note that some data access services also write to Ranger audit logs; such services will be mapped to the dataAccessRole, not the rangerAuditRole. |
string |
rangerCloudAccessAuthorizerRole |
The cloud provider role to which the Ranger RAZ service will be mapped (e.g. an ARN in AWS, a Resource ID in Azure). |
string |
GetIdBrokerMappingsSyncStatusRequest
Request object for getting ID Broker mappings sync status.
| Name | Description | Schema |
|---|---|---|
environmentName |
The name or CRN of the environment. |
string |
GetIdBrokerMappingsSyncStatusResponse
Response object for getting ID Broker mappings sync status.
| Name | Description | Schema |
|---|---|---|
globalStatus |
The overall mappings sync status for all datalake clusters in the environment. |
|
statuses |
Map of datalake cluster CRN to mappings sync status for each datalake cluster in the environment. |
< string, IdBrokerSyncStatus > map |
syncNeeded |
Whether a sync is needed to bring in-cluster mappings up-to-date. |
boolean |
GetKeytabRequest
Request object for get keytab request.
| Name | Description | Schema |
|---|---|---|
actorCrn |
The CRN of the user or machine user to retrieve the keytab for. If it is not included, it defaults to the user making the request. |
string |
environmentName |
The name or CRN of the environment. |
string |
GetKeytabResponse
Request object for get keytab request.
| Name | Description | Schema |
|---|---|---|
contents |
The contents of the keytab encoded as a base64 string. |
string |
GetOperationRequest
Request object for tracking the latest (current/last) operation on the environment resource.
| Name | Description | Schema |
|---|---|---|
environmentName |
Name of the environment resource. |
string |
GetOperationResponse
Response object for tracking the latest (current/last) operation on the environment resource.
| Name | Description | Schema |
|---|---|---|
operationId |
Identifier of the operation. |
string |
operationStatus |
Status of the operation. |
enum (UNKNOWN, RUNNING, FAILED, FINISHED, CANCELLED) |
operationType |
Type of the operation. |
string |
progress |
Progress percentage of the operation. |
integer (int32) |
GetRepairFreeipaStatusRequest
Request object for Repair Status.
| Name | Description | Schema |
|---|---|---|
operationId |
operationId for the previously requested repair operation. |
string |
GetRepairFreeipaStatusResponse
Response object for Repair Operation.
| Name | Description | Schema |
|---|---|---|
endDate |
Date when the operation ended. Omitted if operation has not ended. |
string (date-time) |
error |
If there is any error associated. The error will be populated on any error and it may be populated when the operation failure details are empty. The error will typically contain the high level information such as the assocated repair failure phase. |
string |
failureOperationDetails |
List of operation details for failures. If the repair is only partially successful both successful and failure operation details will be populated. |
< RepairOperationDetails > array |
startDate |
Date when the operation started. |
string (date-time) |
status |
Status of this operation. |
|
successfulOperationDetails |
List of operation details for all successes. If the repair is only partially successful both successful and failure operation details will be populated. |
< RepairOperationDetails > array |
GetRootCertificateRequest
Request object for obtaining public certificate of an environment.
| Name | Description | Schema |
|---|---|---|
environmentName |
The name or CRN of the environment. |
string |
GetRootCertificateResponse
Response object with base64 encoded contents of the public certificate for an environment.
| Name | Description | Schema |
|---|---|---|
contents |
Contents of a certificate. |
string |
IdBrokerMapping
A mapping of an actor or group to a cloud provider role.
| Name | Description | Schema |
|---|---|---|
accessorCrn |
The CRN of the actor or group. |
string |
role |
The cloud provider role (e.g., ARN in AWS, Resource ID in Azure) to which the actor or group is mapped. |
string |
IdBrokerMappingRequest
A mapping of an actor or group to a cloud provider role, used in request objects.
| Name | Description | Schema |
|---|---|---|
accessorCrn |
The CRN of the actor or group. |
string |
role |
The cloud provider role (e.g., ARN in AWS, Resource ID in Azure) to which the actor or group is mapped. |
string |
IdBrokerSyncStatus
Status of an ID Broker mappings sync operation.
| Name | Description | Schema |
|---|---|---|
endDate |
The date when the mappings sync completed or was terminated. Omitted if status is NEVER_RUN or RUNNING. |
string (date-time) |
errorDetail |
The detail of the error. Omitted if status is not FAILED. |
string |
startDate |
The date when the mappings sync started executing. Omitted if status is NEVER_RUN. |
string (date-time) |
status |
The mappings sync summary status. |
ImageInfoResponse
Information about FreeIPA image.
| Name | Description | Schema |
|---|---|---|
catalog |
Image catalog URL. |
string |
catalogName |
Image catalog name. |
string |
date |
Creation date of the image from catalog. |
string |
id |
Virtual machine image ID from ImageCatalog, machines of the cluster will be started from this image. |
string |
imageName |
Image name |
string |
os |
OS type of the image, this property is only considered when no specific image ID is provided. |
string |
InitializeAWSComputeClusterRequest
Request object for a initialize AWS default compute cluster.
| Name | Description | Schema |
|---|---|---|
computeClusterConfiguration |
The Externalized k8s configuration create request for the environment |
|
environmentName |
The name of the environment. |
string |
InitializeAWSComputeClusterResponse
Response object for an initialize AWS default compute cluster request.
| Name | Description | Schema |
|---|---|---|
operationId |
The id of the related operation. |
string |
InitializeAzureComputeClusterRequest
Request object for a initialize Azure default compute cluster.
| Name | Description | Schema |
|---|---|---|
computeClusterConfiguration |
The Externalized k8s configuration create request for the environment |
|
environmentName |
The name of the environment. |
string |
InitializeAzureComputeClusterResponse
Response object for an initialize Azure default compute cluster request.
| Name | Description | Schema |
|---|---|---|
operationId |
The id of the related operation. |
string |
InstanceTemplate
Instance template that specifies the core information for the instances.
| Name | Description | Schema |
|---|---|---|
attachedVolumes |
The attached volume configuration(s). |
< AttachedVolume > array |
awsProperties |
AWS specific FreeIPA parameters. |
|
instanceType |
The type of the instance. |
string |
LastAutomatedSyncDetails
The details of the last sync performed by automated user sync.
| Name | Description | Schema |
|---|---|---|
status |
The status of the sync. |
enum (UNKNOWN, SUCCESS, FAILED) |
statusMessages |
Additional detail related to the status. |
< string > array |
timestamp |
The time when the sync was processed. |
string (date-time) |
LastSyncStatusRequest
Request object for Sync Status.
| Name | Description | Schema |
|---|---|---|
envNameOrCrn |
Name or Crn of the environment. |
string |
LastSyncStatusResponse
Response object for Sync Operation.
| Name | Description | Schema |
|---|---|---|
endDate |
Date when the sync operation ended. Omitted if operation has not ended. |
string (date-time) |
error |
If there is any error associated. The error will be populated on any error and it may be populated when the operation failure details are empty. |
string |
failure |
List of sync operation details for all failed environments. |
< SyncOperationDetails > array |
operationId |
UUID of the request for this operation. This Id can be used for geting status on the operation. |
string |
operationType |
Operation type, set password or user sync |
|
startDate |
Date when the sync operation started. |
string (date-time) |
status |
Status of this operation. Status can be one of these values (REQUESTED, RUNNING, COMPLETED, FAILED, REJECTED, TIMEDOUT) |
|
success |
List of sync operation details for all succeeded environments. |
< SyncOperationDetails > array |
ListAuditCredentialsRequest
Request object for a list audit credentials request.
Type : object
ListAuditCredentialsResponse
Response object for a list audit credentials request.
| Name | Description | Schema |
|---|---|---|
credentials |
The credentials. |
< Credential > array |
ListConnectedDataServicesRequest
Request object for listing connected Data Service(s) for a given environment.
| Name | Description | Schema |
|---|---|---|
environment |
Name or CRN of the environment. |
string |
ListConnectedDataServicesResponse
Response object for listing connected Data Service(s) for a given environment.
| Name | Description | Schema |
|---|---|---|
result |
List of connected Data Service for the given environment. |
< ConnectedDataService > array |
ListCredentialsRequest
Request object for a list credentials request.
| Name | Description | Schema |
|---|---|---|
credentialName |
An optional credential name to search by. |
string |
ListCredentialsResponse
Response object for a list credentials request.
| Name | Description | Schema |
|---|---|---|
credentials |
The credentials. |
< Credential > array |
ListEnvironmentsRequest
Request object for a list environments request.
Type : object
ListEnvironmentsResponse
Response object for a list environments request.
| Name | Description | Schema |
|---|---|---|
environments |
The environment. |
< EnvironmentSummary > array |
ListFreeipaDiagnosticsRequest
Request object for listing recent FreeIPA diagnostics collections.
| Name | Description | Schema |
|---|---|---|
environmentName |
The name or CRN of the environment. |
string |
ListFreeipaDiagnosticsResponse
Response object for listing recent FreeIPA diagnostics collections.
| Name | Description | Schema |
|---|---|---|
collections |
description. |
< FreeipaDiagnosticsCollectionResponse > array |
ListFreeipaSecretTypesRequest
Request for listing possible secret values for Freeipa.
| Name | Description | Schema |
|---|---|---|
environment |
The environment CRN where Freeipa is located. |
string |
ListFreeipaSecretTypesResponse
Response for listing possible secret values for Freeipa.
| Name | Description | Schema |
|---|---|---|
freeipaSecretTypes |
The list of secret types supported by FreeIpa. |
< SecretTypeResponse > array |
ListProxyConfigsRequest
Request object for a list proxy configs request.
| Name | Description | Schema |
|---|---|---|
proxyConfigName |
An optional proxy config name to search by. |
string |
ListProxyConfigsResponse
Response object for a list proxy configs request.
| Name | Description | Schema |
|---|---|---|
proxyConfigs |
The proxy configs. |
< ProxyConfig > array |
LogStorage
Storage configuration for cluster and audit logs.
| Name | Description | Schema |
|---|---|---|
awsDetails |
AWS-specific log storage configuration information. |
|
azureDetails |
Azure-specific log storage configuration information. |
|
enabled |
Whether external log storage is enabled. |
boolean |
gcpDetails |
GCP-specific log storage configuration information. |
awsDetails
| Name | Description | Schema |
|---|---|---|
instanceProfile |
The AWS instance profile that which contains the necessary permissions to access the S3 storage location. |
string |
storageLocationBase |
The base location to store logs in S3. This should be an s3a:// url. |
string |
azureDetails
| Name | Description | Schema |
|---|---|---|
managedIdentity |
The managed identity associated with the logger. This identity should have Storage Blob Data Contributor role on the given storage account. |
string |
storageLocationBase |
The storage location to use. The location has to be in the following format abfs://filesystem@storage-account-name.dfs.core.windows.net. |
string |
gcpDetails
| Name | Description | Schema |
|---|---|---|
serviceAccountEmail |
Email ID of the service account associated with the logging instances. |
string |
storageLocationBase |
The storage location to use. This should be a gs:// url. |
string |
Network
The network.
| Name | Description | Schema |
|---|---|---|
aws |
AWS network parameters. |
|
azure |
Azure network parameters. |
|
endpointAccessGatewayScheme |
The scheme for the endpoint gateway. PUBLIC indicates an external endpoint that can be accessed over the Internet. |
enum (PUBLIC, PRIVATE) |
endpointAccessGatewaySubnetIds |
The subnets to use for endpoint access gateway. |
< string > array |
gcp |
GCP network parameters. |
|
networkCidr |
The range of private IPv4 addresses that resources will use under this network. |
string |
networkName |
Name or id of the network |
string |
subnetIds |
Subnet names or ids of the network. |
< string > array |
subnetMetadata |
Additional subnet metadata of the network. |
< string, CloudSubnet > map |
NetworkAwsParams
AWS network parameters.
| Name | Description | Schema |
|---|---|---|
vpcId |
VPC ids of the specified networks. |
string |
NetworkAzureParams
Azure network parameters.
| Name | Description | Schema |
|---|---|---|
aksPrivateDnsZoneId |
The full Azure resource ID of an existing Private DNS zone used for the AKS. |
string |
databasePrivateDnsZoneId |
The full Azure resource ID of the existing Private DNS Zone used for Flexible Server and Single Server Databases. |
string |
enableOutboundLoadBalancer |
Whether the outbound load balancer was created for this environment. |
boolean |
flexibleServerSubnetIds |
The subnets delegated for Flexible Server database. Accepts either the name or the full resource id. |
< string > array |
networkId |
The id of the Azure VNet. |
string |
resourceGroupName |
The name of the resource group associated with the VNet. |
string |
usePublicIp |
Whether to associate public ip’s to the resources within the network. |
boolean |
NetworkGcpParams
GCP network parameters.
| Name | Description | Schema |
|---|---|---|
networkName |
The name of the GCP VPC. |
string |
sharedProjectId |
The ID of the Google project associated with the VPC. |
string |
usePublicIp |
Whether to associate public ip’s to the resources within the network. |
boolean |
OperationDetails
Details object of the operation for success or falure.
| Name | Description | Schema |
|---|---|---|
environmentCrn |
environment crn. |
string |
message |
The detail of the success or failure. |
string |
OperationResponse
Response object for a FreeIPA operation.
| Name | Description | Schema |
|---|---|---|
endDate |
Date when the operation ended. Omitted if operation has not ended. |
string (date-time) |
error |
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 |
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 |
Operation ID of the request for this operation. This ID can be used for getting status of the operation. |
string |
startDate |
Date when the operation started. |
string (date-time) |
status |
Status of this operation. |
|
successfulOperationDetails |
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)
ProxyConfig
A proxy config object.
| Name | Description | Schema |
|---|---|---|
crn |
The CRN of the proxy config. |
string |
description |
A description for the proxy config. |
string |
host |
The proxy host. |
string |
inboundProxyCidr |
Allow these CIDR for Inbound communication. |
< string > array |
noProxyHosts |
Comma-separated list of 'CIDR', '[.]host[:port]' (can be a subdomain as well) and 'IP[:port]' entries that should not be proxied. Wildcards are not accepted. For example .cloudera.com,192.168.1.1 |
string |
password |
The proxy password. |
string |
port |
The proxy port. |
integer (int32) |
protocol |
The protocol. |
string |
proxyConfigName |
The name of the proxy config. |
string |
user |
The proxy user. |
string |
RebuildFreeipaRequest
Request object for rebuilding the FreeIPA servers.
| Name | Description | Schema |
|---|---|---|
dataBackupStorageLocation |
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 |
The environment name or CRN. |
string |
freeipaCrn |
CRN of the FreeIPA to rebuild. Must be in the environment specified in 'environmentName'. |
string |
fullBackupStorageLocation |
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 |
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.
| Name | Description | Schema |
|---|---|---|
dataBackupStorageLocation |
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 |
The environment CRN of the FreeIPA to rebuild |
string |
freeipaCrn |
CRN of the FreeIPA to rebuild. Must be in the environment specified in 'environmentName'. |
string |
fullBackupStorageLocation |
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 |
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 |
Operation response of the request for this operation. |
RepairFreeipaRequest
Request object for repairing the FreeIPA servers.
| Name | Description | Schema |
|---|---|---|
environmentName |
The environment name or CRN of the FreeIPA to repair |
string |
force |
Force the repair even if the status if the FreeIPA nodes are good. |
boolean |
instances |
The instance Ids to repair. If not provided then all instances are looked at for repair. |
< string > array |
repairType |
The type of FreeIPA repair to perform. * AUTO - Currently, this is the same as reboot but this may change in the future. * REBOOT - Repair the failed instances by rebooting them. * REBUILD - Repair the failed instances by deleting them and creating new instances, then replicate data from an existing instance to the new instances. |
enum (AUTO, REBOOT, REBUILD) |
RepairFreeipaResponse
Response object for an FreeIPA repair request.
| Name | Description | Schema |
|---|---|---|
endDate |
Date when the operation ended. Omitted if operation has not ended. |
string (date-time) |
error |
If there is any error associated. The error will be populated on any error and it may be populated when the operation failure details are empty. The error will typically contain the high level information such as the assocated repair failure phase. |
string |
failureOperationDetails |
List of operation details for failures. If the repair is only partially successful both successful and failure operation details will be populated. |
< RepairOperationDetails > array |
operationId |
Operation ID of the request for this operation. This ID can be used for geting status on the operation. |
string |
startDate |
Date when the operation started. |
string (date-time) |
status |
Status of this operation. |
|
successfulOperationDetails |
List of operation details for all successes. If the repair is only partially successful both successful and failure operation details will be populated. |
< RepairOperationDetails > array |
RepairOperationDetails
Details object of the repair operation for success or falure.
| Name | Description | Schema |
|---|---|---|
environmentCrn |
environment crn. |
string |
message |
The detail of the success or failure. |
string |
RepairStatus
Status of a repair operation.
Type : enum (NEVER_RUN, REQUESTED, REJECTED, RUNNING, COMPLETED, FAILED, TIMEDOUT)
RetryFreeipaRequest
Request object for retry FreeIPA request.
| Name | Description | Schema |
|---|---|---|
environment |
The name or CRN of the environment. |
string |
RetryFreeipaResponse
Response object for retry FreeIPA operation on an environment.
Type : object
RotateFreeipaSecretsRequest
Request object for starting secret rotation for FreeIPA.
| Name | Description | Schema |
|---|---|---|
environment |
The environment CRN where FreeIPA is located and we wish to rotate secrets. |
string |
secretTypes |
The list of secrets that need replacement. |
< string > array |
RotateFreeipaSecretsResponse
Response object for rotating secrets.
Type : object
RotateSaltPasswordRequest
Request object for rotating SaltStack user password on FreeIPA instances (Deprecated).
| Name | Description | Schema |
|---|---|---|
environment |
The name or CRN of the environment. |
string |
RotateSaltPasswordResponse
Response object for rotating SaltStack user password on FreeIPA instances (Deprecated).
Type : object
SecretTypeResponse
Response object for showing the secret types and descriptions.
| Name | Description | Schema |
|---|---|---|
description |
The description of the secret type. |
string |
secretType |
The type of secret that can be used with the rotate-freeipa-secrets command. |
string |
SecurityAccess
Security control configuration for FreeIPA and Datalake deployment.
| Name | Description | Schema |
|---|---|---|
cidr |
CIDR range which is allowed for inbound traffic. Either IPv4 or IPv6 is allowed. |
string |
defaultSecurityGroupId |
Security group where all other hosts are placed. |
string |
securityGroupIdForKnox |
Security group where Knox-enabled hosts are placed. |
string |
SecurityAccessRequest
Security control configuration for FreeIPA and Datalake deployment. Choosing a CIDR will automatically create security groups. Alternatively existing security groups can be specified.
| Name | Description | Schema |
|---|---|---|
cidr |
CIDR range which is allowed for inbound traffic. Either IPv4 or IPv6 is allowed. |
string |
defaultSecurityGroupIDs |
Security group IDs where all other hosts are placed. Mutually exclusive with CIDR. |
< string > array |
defaultSecurityGroupId |
Security group where all other hosts are placed. Mutually exclusive with cidr. |
string |
securityGroupIDsForKnox |
Security group IDs where Knox-enabled hosts are placed. Mutually exclusive with CIDR. |
< string > array |
securityGroupIdForKnox |
Security group where Knox-enabled hosts are placed. Mutually exclusive with cidr. |
string |
SetAWSAuditCredentialRequest
Request object for a set AWS audit credential request.
| Name | Description | Schema |
|---|---|---|
roleArn |
The ARN of the delegated access role. |
string |
SetAWSAuditCredentialResponse
Response object for a set AWS audit credential request.
| Name | Description | Schema |
|---|---|---|
credential |
The credential object. |
SetAWSGovCloudAuditCredentialRequest
Request object for a set AWS GovCloud audit credential request.
| Name | Description | Schema |
|---|---|---|
roleArn |
The ARN of the delegated access role. |
string |
SetAWSGovCloudAuditCredentialResponse
Response object for a set AWS GovCloud audit credential request.
| Name | Description | Schema |
|---|---|---|
credential |
The credential object. |
SetAccountTelemetryRequest
Request object to enable environment level telemetry features.
| Name | Description | Schema |
|---|---|---|
reportDeploymentLogs |
Flag to enable account level deployment log collection. (that will be used as a default for environment) |
boolean |
rules |
List of anonymization rules that are applied on logs that are shipped to Cloudera |
< AnonymizationRuleRequest > array |
workloadAnalytics |
Flag to enable account level workload analytics. (that will be used as a default for environment) |
boolean |
SetAccountTelemetryResponse
Response object for set account level telemetry settings.
| Name | Description | Schema |
|---|---|---|
reportDeploymentLogs |
Flag to enable account level deployment log collection. (that will be used as a default for environment) |
boolean |
rules |
List of anonymization rules that are applied on logs that are shipped to Cloudera |
< AnonymizationRuleResponse > array |
workloadAnalytics |
Flag to enable account level workload analytics. (that will be used as a default for environment) |
boolean |
SetAzureAuditCredentialRequest
Request object for a set Azure audit credential request.
| Name | Description | Schema |
|---|---|---|
appBased |
Additional configurations needed for app-based authentication. |
|
subscriptionId |
The Azure subscription ID. |
string |
tenantId |
The Azure AD tenant ID for the Azure subscription. |
string |
appBased
| Name | Description | Schema |
|---|---|---|
applicationId |
The id of the application registered in Azure. |
string |
secretKey |
The client secret key (also referred to as application password) for the registered application. |
string |
SetAzureAuditCredentialResponse
Response object for a set Azure audit credential request.
| Name | Description | Schema |
|---|---|---|
credential |
The credential object. |
SetCatalogRequest
The request object to set catalog for a FreeIPA.
| Name | Description | Schema |
|---|---|---|
catalog |
URL of the FreeIPA catalog to be used. |
string |
environment |
The name or CRN of the affected environment that holds the FreeIPA installation. |
string |
SetCatalogResponse
The response object to set catalog for a FreeIPA request.
Type : object
SetEndpointAccessGatewayRequest
Request object to set endpoint access gateway settings.
| Name | Description | Schema |
|---|---|---|
endpointAccessGatewayScheme |
The scheme for the endpoint gateway. PUBLIC creates an external endpoint that can be accessed over internet. Defaults to PRIVATE which restricts the traffic to be internal to the VPC / Vnet. |
enum (PUBLIC, PRIVATE) |
endpointAccessGatewaySubnetIds |
The subnets to use for endpoint access gateway. |
< string > array |
environment |
The name or CRN of the environment. Empty to get system wide settings. |
string |
SetEndpointAccessGatewayResponse
Response object for set endpoint access gateway request.
Type : object
SetEnvironmentSettingRequest
Request object to set environment configuration settings.
| Name | Description | Schema |
|---|---|---|
environmentName |
The name or CRN of the environment. Empty to set system wide settings. |
string |
settings |
Dictionary of settings to set. |
< string, string > map |
SetEnvironmentSettingResponse
Response object to set configuration.
Type : object
SetGCPAuditCredentialRequest
Request object for a set GCP audit credential request.
| Name | Description | Schema |
|---|---|---|
credentialKey |
The JSON key for the service account. Please use the local path when using the CLI (e.g. file:///absolute/path/to/cred.json) to avoid exposing the keys in the command line history. |
string |
SetGCPAuditCredentialResponse
Response object for a set GCP audit credential request.
| Name | Description | Schema |
|---|---|---|
credential |
The credential object. |
SetIdBrokerMappingsRequest
Request object for setting ID Broker mappings for an environment. Overwrites all existing mappings.
| Name | Description | Schema |
|---|---|---|
baselineRole |
Deprecated. Please use rangerAuditRole instead. |
string |
dataAccessRole |
The cloud provider role to which data access services will be mapped (e.g. an ARN in AWS, a Resource ID in Azure). |
string |
environmentName |
The name or CRN of the environment. |
string |
mappings |
ID Broker mappings for individual actors and groups. Does not include mappings for data access services. If omitted or set to an empty list, you must also specify the |
< IdBrokerMappingRequest > array |
rangerAuditRole |
The cloud provider role to which services that write to Ranger audit logs will be mapped (e.g. an ARN in AWS, a Resource ID in Azure). Note that some data access services also write to Ranger audit logs; such services will be mapped to the dataAccessRole, not the rangerAuditRole. |
string |
rangerCloudAccessAuthorizerRole |
The cloud provider role to which the Ranger RAZ service will be mapped (e.g. an ARN in AWS, a Resource ID in Azure). This is required in RAZ-enabled environments. |
string |
setEmptyMappings |
Whether to install an empty set of individual mappings, deleting any existing mappings. The |
boolean |
SetIdBrokerMappingsResponse
Response object for setting ID Broker mappings for an environment.
| Name | Description | Schema |
|---|---|---|
baselineRole |
Deprecated. Please use rangerAuditRole instead. |
string |
dataAccessRole |
The cloud provider role to which data access services will be mapped (e.g. an ARN in AWS, a Resource ID in Azure). |
string |
mappings |
ID Broker mappings for individual actors and groups. Does not include mappings for data access services. May be empty if no individual mappings are needed. |
< IdBrokerMapping > array |
mappingsVersion |
The version of the mappings. |
integer (int64) |
rangerAuditRole |
The cloud provider role to which services that write to Ranger audit logs will be mapped (e.g. an ARN in AWS, a Resource ID in Azure). Note that some data access services also write to Ranger audit logs; such services will be mapped to the dataAccessRole, not the rangerAuditRole. |
string |
rangerCloudAccessAuthorizerRole |
The cloud provider role to which the Ranger RAZ service will be mapped (e.g. an ARN in AWS, a Resource ID in Azure). |
string |
SetPasswordRequest
Request object for set password request. (deprecated)
| Name | Description | Schema |
|---|---|---|
environmentCRNs |
Optional list of environment CRNs. Only the passed environments user’s password will be affected. If this field is not present, all environments will be affected. |
< string > array |
password |
password field. |
string |
SetPasswordResponse
Response object for set password request. (deprecated)
| Name | Description | Schema |
|---|---|---|
endTime |
Sync operation end timestamp. |
string |
error |
If there is any error associated. |
string |
failure |
List of sync operation details for all failed envs. |
< SyncOperationDetails > array |
operationId |
UUID of the request for this operation. This Id can be used for geting status on the operation. |
string |
operationType |
Operation type, set password or user sync |
|
startTime |
Sync operation start timestamp. |
string |
status |
Status of this operation. Status can be one of these values (REQUESTED, RUNNING, COMPLETED, FAILED, REJECTED, TIMEDOUT) |
|
success |
List of sync operation details for all succeeded environments. |
< SyncOperationDetails > array |
SetTelemetryFeaturesRequest
Request object to enable environment level telemetry features.
| Name | Description | Schema |
|---|---|---|
environmentName |
The name or CRN of the environment. |
string |
reportDeploymentLogs |
Flag to enable environment level deployment log collection. |
boolean |
workloadAnalytics |
Flag to enable environment level workload analytics. |
boolean |
SetTelemetryFeaturesResponse
Response object to enable environment level telemetry features.
Type : object
StartEnvironmentRequest
Request object for a start environment request.
| Name | Description | Schema |
|---|---|---|
environmentName |
The name or CRN of the environment. |
string |
withDatahubStart |
Whether the Data Hub clusters should start or not at the environment (re-)start |
boolean |
StartEnvironmentResponse
Response object for a start environment request.
Type : object
StartFreeIpaVerticalScalingRequest
The request object for FreeIPA vertical scaling.
| Name | Description | Schema |
|---|---|---|
environment |
The name or CRN of the environment. |
string |
instanceTemplate |
Instance template that specifies the core information for the vertical scale. |
StartFreeIpaVerticalScalingResponse
The response object for FreeIPA vertical scaling.
| Name | Description | Schema |
|---|---|---|
result |
The result of the operation. |
string |
StopEnvironmentRequest
Request object for a stop environment request.
| Name | Description | Schema |
|---|---|---|
environmentName |
The name or CRN of the environment. |
string |
StopEnvironmentResponse
Response object for a stop environment request.
Type : object
SyncAllUsersRequest
Request object for a All Users and Groups Sync.
| Name | Description | Schema |
|---|---|---|
environmentNames |
List of environments to be synced. If not present, all environments will be synced. |
< string > array |
SyncAllUsersResponse
All Users and Groups Sync Response Object
| Name | Description | Schema |
|---|---|---|
endTime |
Sync operation end timestamp. |
string |
error |
If there is any error associated. |
string |
failure |
List of sync operation details for all failed envs. |
< SyncOperationDetails > array |
operationId |
UUID of the request for this operation. This Id can be used for geting status on the operation. |
string |
operationType |
Operation type, set password or user sync |
|
startTime |
Sync operation start timestamp. |
string |
status |
Status of this operation. Status can be one of these values (REQUESTED, RUNNING, COMPLETED, FAILED, REJECTED, TIMEDOUT) |
|
success |
List of sync operation details for all succeeded environments. |
< SyncOperationDetails > array |
SyncIdBrokerMappingsRequest
Request object for synchronizing ID Broker mappings for an environment.
| Name | Description | Schema |
|---|---|---|
environmentName |
The name or CRN of the environment. |
string |
SyncIdBrokerMappingsResponse
Response object for synchronizing ID Broker mappings for an environment.
Type : object
SyncOperationDetails
Details object of the sync operation for success or falure.
| Name | Description | Schema |
|---|---|---|
environmentCrn |
environment crn. |
string |
message |
The detail of the success or failure. |
string |
SyncStatus
Status of a sync operation.
Type : enum (NEVER_RUN, REQUESTED, REJECTED, RUNNING, COMPLETED, FAILED, TIMEDOUT)
SyncStatusRequest
Request object for Sync Status.
| Name | Description | Schema |
|---|---|---|
operationId |
operationId for the previously requested sync operation for user sync or password. |
string |
SyncStatusResponse
Response object for Sync Operation.
| Name | Description | Schema |
|---|---|---|
endTime |
Sync operation end timestamp. |
string |
error |
If there is any error associated. |
string |
failure |
List of sync operation details for all failed envs. |
< SyncOperationDetails > array |
operationId |
UUID of the request for this operation. This Id can be used for geting status on the operation. |
string |
operationType |
Operation type, set password or user sync |
|
startTime |
Sync operation start timestamp. |
string |
status |
Status of this operation. Status can be one of these values (REQUESTED, RUNNING, COMPLETED, FAILED, REJECTED, TIMEDOUT) |
|
success |
List of sync operation details for all succeeded environments. |
< SyncOperationDetails > array |
SyncUserRequest
Request Object for single user sync operation.
Type : object
SyncUserResponse
Response Object for single user sync operation.
| Name | Description | Schema |
|---|---|---|
endTime |
Sync operation end timestamp. |
string |
error |
If there is any error associated. |
string |
failure |
List of sync operation details for all failed envs. |
< SyncOperationDetails > array |
operationId |
UUID of the request for this operation. This Id can be used for geting status on the operation. |
string |
operationType |
Operation type, set password or user sync |
|
startTime |
Sync operation start timestamp. |
string |
status |
Status of this operation. Status can be one of these values (REQUESTED, RUNNING, COMPLETED, FAILED, REJECTED, TIMEDOUT) |
|
success |
List of sync operation details for all succeeded environments. |
< SyncOperationDetails > array |
SynchronizeAllEnvironmentsRequest
Request object for synchronizing all environments.
Type : object
SynchronizeAllEnvironmentsResponse
Response object for synchronizing all environments.
Type : object
TagRequest
A label that can be attached to some resources.
| Name | Description | Schema |
|---|---|---|
key |
The tag’s name. |
string |
value |
The associated value of the tag. |
string |
TestAccountTelemetryRulesRequest
Request object for testing text input against provided account telemetry anonymization rules.
| Name | Description | Schema |
|---|---|---|
rules |
List of anonymization rules that are applied on logs that are shipped to Cloudera |
< AnonymizationRuleRequest > array |
testInput |
Text input that will be tested against the provided account telemetry anonymization rules. |
string |
TestAccountTelemetryRulesResponse
Response object for testing anonymization rules for account telemetry.
| Name | Description | Schema |
|---|---|---|
output |
Output text after applying the anonymization rules on the test input. |
string |
TunnelType
Supported CCM versions
Type : enum (CCM, CCMV2, CCMV2_JUMPGATE)
UpdateAwsCredentialRequest
Request object for an update AWS credential request.
| Name | Description | Schema |
|---|---|---|
credentialName |
The name of the credential. |
string |
description |
A description for the credential. |
string |
roleArn |
The ARN of the delegated access role. |
string |
skipOrgPolicyDecisions |
Whether to skip organizational policy decision checks or not. |
boolean |
verifyPermissions |
Whether to verify permissions upon saving or not. |
boolean |
UpdateAwsCredentialResponse
Response object for an update AWS credential request.
| Name | Description | Schema |
|---|---|---|
credential |
The credential object. |
UpdateAwsDiskEncryptionParametersRequest
Request object for updating AWS encryption parameters.
| Name | Description | Schema |
|---|---|---|
encryptionKeyArn |
The ARN of an encryption key, which will be used to encrypt the AWS EBS volumes, if the entitlement has been granted. |
string |
environment |
The name or CRN of the environment. |
string |
UpdateAwsDiskEncryptionParametersResponse
Response object for an update AWS encryption parameters request.
| Name | Description | Schema |
|---|---|---|
awsDiskEncryptionParameters |
Object containing details of encryption parameters for AWS cloud. |
|
environment |
The environment summary. |
UpdateAzureAvailabilityZonesRequest
Request object to update Availability Zones for Azure environment.
| Name | Description | Schema |
|---|---|---|
availabilityZones |
List of availability zones for the environment. |
< string > array |
environment |
The name or CRN of the environment. |
string |
UpdateAzureAvailabilityZonesResponse
Response object for a update Azure Availability Zones request.
| Name | Description | Schema |
|---|---|---|
environment |
The environment summary. |
UpdateAzureCredentialRequest
Request object for an update Azure credential request.
| Name | Description | Schema |
|---|---|---|
appBased |
Additional configurations needed for app-based authentication. |
|
credentialName |
The name of the credential. |
string |
description |
A description for the credential. |
string |
subscriptionId |
The Azure subscription ID. |
string |
tenantId |
The Azure AD tenant ID for the Azure subscription. |
string |
appBased
| Name | Description | Schema |
|---|---|---|
applicationId |
The id of the application registered in Azure. |
string |
authenticationType |
Authentication type of the credential |
UpdateAzureCredentialResponse
Response object for an update Azure credential request.
| Name | Description | Schema |
|---|---|---|
credential |
The credential object. |
UpdateAzureDatabaseResourcesRequest
Request object for updating Azure Database resources.
| Name | Description | Schema |
|---|---|---|
databasePrivateDnsZoneId |
The full Azure resource ID of the existing Private DNS Zone used for Flexible Server and Single Server Databases. |
string |
environment |
The name or CRN of the environment. |
string |
flexibleServerSubnetIds |
The subnets delegated for Flexible Server database. Accepts either the name or the full resource id. |
< string > array |
UpdateAzureDatabaseResourcesResponse
Response object for a update Azure Database resources request.
| Name | Description | Schema |
|---|---|---|
azureDatabaseResources |
Object containing details of database resources for Azure cloud. |
|
environment |
The environment summary. |
UpdateAzureEncryptionResourcesRequest
Request object for updating Azure encryption resources.
| Name | Description | Schema |
|---|---|---|
encryptionKeyResourceGroupName |
Name of the existing Azure resource group hosting the Azure Key Vault containing customer managed key which will be used to encrypt the Azure Managed Disks. It is required only when the entitlement is granted and the resource group of the key vault is different from the resource group in which the environment is to be created. Omitting it implies that, the key vault containing the encryption key is present in the same resource group where the environment would be created. |
string |
encryptionKeyUrl |
The URL of an encryption key, which will be used to encrypt the Azure Managed Disks, if the entitlement has been granted. |
string |
encryptionUserManagedIdentity |
User managed identity for encryption. |
string |
environment |
The name or CRN of the environment. |
string |
userManagedIdentity |
User managed identity for encryption. (deprecated) |
string |
UpdateAzureEncryptionResourcesResponse
Response object for a update Azure encryption resources request.
| Name | Description | Schema |
|---|---|---|
environment |
The environment summary. |
|
resourceEncryptionParameters |
Object containing details of encryption parameters for Azure cloud. |
UpdateAzureImageTermsPolicyRequest
Request object to enable or disable automatic acceptance of Azure Marketplace image terms.
| Name | Description | Schema |
|---|---|---|
accepted |
Flag to enable or disable automatic acceptance of Azure Marketplace image terms. |
boolean |
UpdateAzureImageTermsPolicyResponse
Response object to enable or disable automatic acceptance of Azure Marketplace image terms.
Type : object
UpdateCustomDockerRegistryRequest
The desired custom docker registry for data services to be used.
| Name | Description | Schema |
|---|---|---|
customDockerRegistry |
The CRN of the desired custom docker registry for data services to be used. |
string |
environment |
The name or CRN of the environment. |
string |
UpdateCustomDockerRegistryResponse
The environment with the updated custom docker registry for data services.
| Name | Description | Schema |
|---|---|---|
environment |
The environment. |
UpdateDataServiceResourcesRequest
Update Data Services parameters request of the environment.
| Name | Description | Schema |
|---|---|---|
dataServices |
Data Services parameters request of the environment. |
|
environment |
The name or CRN of the environment. |
string |
UpdateDataServiceResourcesResponse
Response object for an update environment Data Service resource request.
| Name | Description | Schema |
|---|---|---|
environment |
The environment. |
UpdateFreeipaToAwsImdsV1Request
The related environment where we update the corresponding FreeIPA to use AWS IMDSv1.
| Name | Description | Schema |
|---|---|---|
environmentCrn |
The CRN of the environment. |
string |
UpdateFreeipaToAwsImdsV1Response
Response object for updating corresponding FreeIPA of the given environment to AWS IMDSv1.
Type : object
UpdateFreeipaToAwsImdsV2Request
The related environment where we update the corresponding FreeIPA to use AWS IMDSv2.
| Name | Description | Schema |
|---|---|---|
environmentCrn |
The CRN of the environment. |
string |
UpdateFreeipaToAwsImdsV2Response
Response object for updating corresponding FreeIPA of the given environment to AWS IMDSv2.
Type : object
UpdateOrchestratorStateRequest
Request object for running orchestrator engine state update on the FreeIPA cluster.
| Name | Description | Schema |
|---|---|---|
environment |
The name or CRN of the environment. |
string |
UpdateOrchestratorStateResponse
Response object for running orchestrator engine state update on the FreeIPA cluster.
Type : object
UpdateProxyConfigRequest
Request object for updating the proxy config of the given environment.
| Name | Description | Schema |
|---|---|---|
environment |
The name or CRN of the environment. |
string |
proxyConfigName |
The name of the new proxy config for the environment. Either this or the remove proxy flag has to be given. |
string |
removeProxy |
Flag to indicate that the current proxy config should be removed for the environment. Either this or a proxy config name has to be given. |
boolean |
UpdateProxyConfigResponse
Response object for updating the proxy config of the given environment.
Type : object
UpdateSecurityAccessRequest
The request object for updating security access of the given environment.
| Name | Description | Schema |
|---|---|---|
defaultSecurityGroupId |
Security group ID for non-gateway nodes. |
string |
environment |
The name or the CRN of the environment. |
string |
gatewayNodeSecurityGroupId |
Security group ID where Knox-enabled hosts are placed. |
string |
UpdateSecurityAccessResponse
Response object for an update environment security access request.
| Name | Description | Schema |
|---|---|---|
environment |
The environment. |
UpdateSshKeyRequest
The request object for updating the environment SSH key.
| Name | Description | Schema |
|---|---|---|
environment |
The name or the CRN of the environment. |
string |
existingPublicKeyId |
The ID of the existing SSH public key that is stored on the cloud provider side. Either this or a new public key has to be given. |
string |
newPublicKey |
A new SSH public key that is stored locally. Either this or an existing public key ID has to be given. |
string |
UpdateSshKeyResponse
Response object for an update environment SSH key request.
| Name | Description | Schema |
|---|---|---|
environment |
The environment. |
UpdateSubnetRequest
The request for updating subnets of the given environment.
| Name | Description | Schema |
|---|---|---|
endpointAccessGatewaySubnetIds |
The selected subnets to update for the given environment’s endpoint access gateway. |
< string > array |
environment |
The name or the CRN of the environment. |
string |
subnetIds |
The selected subnets to update the given environment to. |
< string > array |
UpdateSubnetResponse
Response object for an update environment subnet request.
| Name | Description | Schema |
|---|---|---|
environment |
The environment. |
UpgradeCcmRequest
Request object for upgrading Cluster Connectivity Manager on an environment.
| Name | Description | Schema |
|---|---|---|
environment |
The name or CRN of the environment. |
string |
UpgradeCcmResponse
Response object for upgrading Cluster Connectivity Manager request on an environment.
Type : object
UpgradeFreeipaRequest
The request object for FreeIPA upgrade.
| Name | Description | Schema |
|---|---|---|
allowMajorOsUpgrade |
Allows the upgrade to a subsequent major OS version in the series. |
boolean |
environmentName |
The name or CRN of the environment. |
string |
imageId |
Target image ID for upgrade. |
string |
UpgradeFreeipaResponse
The response object for FreeIPA upgrade.
| Name | Description | Schema |
|---|---|---|
operationId |
UUID of the request for this operation. This ID can be used for geting status on the operation. |
string |
originalImage |
Original, current image. |
|
targetImage |
Image selected for upgrade. |
UpscaleFreeipaRequest
The request object for FreeIPA upscale.
| Name | Description | Schema |
|---|---|---|
environmentName |
The name or CRN of the environment. |
string |
targetAvailabilityType |
The target FreeIPA availability type. |
enum (HA) |
UpscaleFreeipaResponse
The response object for FreeIPA upscale.
| Name | Description | Schema |
|---|---|---|
operationId |
UUID of the request for this operation. This ID can be used to get the status of the operation. |
string |
originalAvailabilityType |
The original FreeIPA availability type. |
enum (NON_HA, TWO_NODE_BASED) |
targetAvailabilityType |
The target FreeIPA availability type. |
enum (HA) |
ValidateAwsCloudStorageRequest
Request object for AWS environment cloud storage validation.
| Name | Description | Schema |
|---|---|---|
credentialCrn |
The CRN of the credential. |
string |
instanceProfile |
AWS instance profile. |
string |
storageLocation |
AWS S3 storage bucket location for logging. |
string |
ValidateAwsCloudStorageResponse
Response object for AWS environment cloud storage validation.
| Name | Description | Schema |
|---|---|---|
error |
Error message if validation failed. |
string |
status |
Validation result. Allowed values are "OK", "ACCESS_DENIED", "ERROR", "RESOURCE_NOT_FOUND". |
string |
ValidateAzureCloudStorageRequest
Request object for Azure environment cloud storage validation.
| Name | Description | Schema |
|---|---|---|
accountKey |
Azure account key. |
string |
accountName |
Azure account name. |
string |
credentialCrn |
The CRN of the credential. |
string |
managedIdentity |
Azure managed identity. |
string |
secure |
Azure secure flag. |
boolean |
storageLocation |
Azure storage location for logging. |
string |
ValidateAzureCloudStorageResponse
Response object for Azure environment cloud storage validation.
| Name | Description | Schema |
|---|---|---|
error |
Error message if validation failed. |
string |
status |
Validation result. Allowed values are "OK", "ACCESS_DENIED", "ERROR", "RESOURCE_NOT_FOUND". |
string |