Overview

Interact with the Cloudera Operational Database service

Version information

Version : 0.9.126 (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

Add a coprocessor for a specific table

POST /api/v1/opdb/addCoprocessor

Description

Adds a coprocessor for a specific table.

Parameters

Type Name Schema

Body

input
required

AddCoprocessorRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

AddCoprocessorResponse

default

The default response on an error.

Error

Collect diagnostic data bundles from the database

POST /api/v1/opdb/collectDiagnostics

Description

returns details of running command

Parameters

Type Name Schema

Body

input
required

CollectDiagnosticsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

CollectDiagnosticsResponse

default

The default response on an error.

Error

Create opDb

POST /api/v1/opdb/createDatabase

Description

Create a operational database in a environment

Parameters

Type Name Schema

Body

input
required

CreateDatabaseRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

CreateDatabaseResponse

default

The default response on an error.

Error

Creates a snapshot for a specific table

POST /api/v1/opdb/createSnapshot

Description

Returns id state and creation time

Parameters

Type Name Schema

Body

input
required

CreateSnapshotRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

CreateSnapshotResponse

default

The default response on an error.

Error

Deletes a snapshot

POST /api/v1/opdb/deleteSnapshot

Description

Returns state of operation

Parameters

Type Name Schema

Body

input
required

DeleteSnapshotRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DeleteSnapshotResponse

default

The default response on an error.

Error

Returns client connectivity details

POST /api/v1/opdb/describeClientConnectivity

Description

Returns details to enable programmatic client connectivity for a database

Parameters

Type Name Schema

Body

input
required

DescribeClientConnectivityRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeClientConnectivityResponse

default

The default response on an error.

Error

Describe a opDb

POST /api/v1/opdb/describeDatabase

Description

Details about the operational database

Parameters

Type Name Schema

Body

input
required

DescribeDatabaseRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeDatabaseResponse

default

The default response on an error.

Error

Describes the configuration of HBase.

POST /api/v1/opdb/describeHbaseConfiguration

Description

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

Parameters

Type Name Schema

Body

input
required

DescribeHbaseConfigurationRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeHbaseConfigurationResponse

default

The default response on an error.

Error

Describes the upgrade availability.

POST /api/v1/opdb/describeUpgradeDatabase

Description

Describes the upgrade availability for an operational database.

Parameters

Type Name Schema

Body

input
required

DescribeUpgradeDatabaseRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeUpgradeDatabaseResponse

default

The default response on an error.

Error

drop a opDb

POST /api/v1/opdb/dropDatabase

Description

drop the operational database

Parameters

Type Name Schema

Body

input
required

DropDatabaseRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DropDatabaseResponse

default

The default response on an error.

Error

Lists coprocessors in a database

POST /api/v1/opdb/listCoprocessors

Description

Lists coprocessors in a database.

Parameters

Type Name Schema

Body

input
required

ListCoprocessorsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListCoprocessorsResponse

default

The default response on an error.

Error

List all opDbs in an environment

POST /api/v1/opdb/listDatabases

Description

Fetch a list of all operational databases in an environment

Parameters

Type Name Schema

Body

input
required

ListDatabasesRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListDatabasesResponse

default

The default response on an error.

Error

List all diagnostics associated to the database

POST /api/v1/opdb/listDiagnostics

Description

returns list of diagnostics collections

Parameters

Type Name Schema

Body

input
required

ListDiagnosticsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListDiagnosticsResponse

default

The default response on an error.

Error

Lists edge nodes in a database

POST /api/v1/opdb/listEdgeNodes

Description

Lists edge nodes in a database.

Parameters

Type Name Schema

Body

input
required

ListEdgeNodesRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListEdgeNodesResponse

default

The default response on an error.

Error

Lists events

POST /api/v1/opdb/listEvents

Description

Lists events in reverse chronological order for an operational database.

Parameters

Type Name Schema

Body

input
required

ListEventsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListEventsResponse

default

The default response on an error.

Error

Lists instances when a snapshot was restored to a database

POST /api/v1/opdb/listRestoreSnapshots

Description

Returns a list of snapshots restored into a database.

Parameters

Type Name Schema

Body

input
required

ListRestoreSnapshotsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListRestoreSnapshotsResponse

default

The default response on an error.

Error

Lists scaling events

POST /api/v1/opdb/listScalingEvents

Description

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

Parameters

Type Name Schema

Body

input
required

ListScalingEventsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListScalingEventsResponse

default

The default response on an error.

Error

Shows snapshot for a table name in a specific location

POST /api/v1/opdb/listSnapshots

Description

Returns list of snapshot names

Parameters

Type Name Schema

Body

input
required

ListSnapshotsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListSnapshotsResponse

default

The default response on an error.

Error

List of environments available for the database creation

POST /api/v1/opdb/listSupportedEnvironments

Description

Fetches a list of environments available for the database creation

Parameters

Type Name Schema

Body

input
required

ListSupportedEnvironmentsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListSupportedEnvironmentsResponse

default

The default response on an error.

Error

Lists instance types supported by COD

POST /api/v1/opdb/listSupportedInstanceTypes

Description

Lists instance types supported by COD.

Parameters

Type Name Schema

Body

input
required

ListSupportedInstanceTypesRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListSupportedInstanceTypesResponse

default

The default response on an error.

Error

Prepare database upgrade.

POST /api/v1/opdb/prepareUpgradeDatabase

Description

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

Parameters

Type Name Schema

Body

input
required

PrepareUpgradeDatabaseRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

PrepareUpgradeDatabaseResponse

default

The default response on an error.

Error

Removes a coprocessor for a specific table

POST /api/v1/opdb/removeCoprocessor

Description

Removes a coprocessor for a specific table.

Parameters

Type Name Schema

Body

input
required

RemoveCoprocessorRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

RemoveCoprocessorResponse

default

The default response on an error.

Error

Restores a snapshot

POST /api/v1/opdb/restoreSnapshot

Description

Returns state of operation

Parameters

Type Name Schema

Body

input
required

RestoreSnapshotRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

RestoreSnapshotResponse

default

The default response on an error.

Error

Starts the database

POST /api/v1/opdb/startDatabase

Description

Starts a previously stopped database

Parameters

Type Name Schema

Body

input
required

StartDatabaseRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

StartDatabaseResponse

default

The default response on an error.

Error

Stops the database

POST /api/v1/opdb/stopDatabase

Description

Stops a running database

Parameters

Type Name Schema

Body

input
required

StopDatabaseRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

StopDatabaseResponse

default

The default response on an error.

Error

Updates the database

POST /api/v1/opdb/updateDatabase

Description

Update an operational database in an environment

Parameters

Type Name Schema

Body

input
required

UpdateDatabaseRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

UpdateDatabaseResponse

default

The default response on an error.

Error

Update edge nodes in a database

POST /api/v1/opdb/updateEdgeNodes

Description

Update edge nodes in a database.

Parameters

Type Name Schema

Body

input
required

UpdateEdgeNodesRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

UpdateEdgeNodesResponse

default

The default response on an error.

Error

Updates the configuration of HBase.

POST /api/v1/opdb/updateHbaseConfiguration

Description

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

Parameters

Type Name Schema

Body

input
required

UpdateHbaseConfigurationRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

UpdateHbaseConfigurationResponse

default

The default response on an error.

Error

Upgrades the database.

POST /api/v1/opdb/upgradeDatabase

Description

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

Parameters

Type Name Schema

Body

input
required

UpgradeDatabaseRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

UpgradeDatabaseResponse

default

The default response on an error.

Error

Definitions

AddCoprocessorRequest

The request for adding a coprocessor of a table in a database.

Name Description Schema

coprocessorArgs
optional

The optional coprocessor arguments in comma-separated list.

string

coprocessorCanonicalName
required

The coprocessor canonical name. It is unique per database.

string

coprocessorLocationUrl
optional

The coprocessor location URL. This URL could be an object store path, or it could be an HDFS path if it’s a built-in coprocessor.

string

database
optional

The name or CRN of the database.

string

environment
optional

The name or CRN of the environment.

string

tableName
required

Fully qualified table name.

string

AddCoprocessorResponse

The response for adding a coprocessor of a table in a database.

Name Description Schema

commandId
optional

The command ID of the submitted request.

integer (int64)

creationTime
optional

When the coprocessor request was submitted.

integer (int64)

database
optional

The name or CRN of the database.

string

environment
optional

The name or CRN of the environment.

string

status
optional

The current status when submitting the add coprocessor request.

CoprocessorStatusType

statusReason
optional

Reason for the response if any.

string

ArchitectureType

Architecture type for cluster. X86_64 - X64 CPU Architecture is used for the cluster. ARM64 - ARM64 CPU Architecture is used for the cluster.

Type : enum (X86_64, ARM64)

AttachedStorageForWorkers

Attached storage for the worker nodes for AWS, Azure, and GCP cloud providers.

Name Description Schema

volumeCount
optional

The number of Volumes. Default is 4. Valid Range: Minimum value of 1, maximum value 8.
Minimum value : 1
Maximum value : 8

integer (int32)

volumeSize
optional

The target size of the volume, in GiB. Default is 2048.

integer (int32)

volumeType
optional

The volume type. This parameter can be HDD or SSD. Default is HDD.

VolumeType

AutoScalingConfig

A config for Autoscaling

Name Description Schema

evaluationPeriod
optional

Period of metrics(in seconds) needs to be considered.

integer (int64)

maxComputeNodesForDatabase
optional

The maximum number of compute nodes, as per these metrics can be scaled up to.
Default : -1

integer (int32)

maxCpuUtilization
optional

The maximum percentage threshold for the CPU utilization of the worker nodes. The CPU utilization is obtained from the Cloudera Manager metric 'cpu_percent' across worker nodes. Set 100 or more to disable the CPU metrics.

integer (int32)

maxHdfsUsagePercentage
optional

The maximum percentage of HDFS utilization for the database before the scaling is triggered.

integer (int32)

maxRegionsPerRegionServer
optional

The maximum number of regions per region server.

integer (int32)

maxWorkersForDatabase
optional

Maximum number of worker nodes as per this metrics can be scaled up to.

integer (int32)

maxWorkersPerBatch
optional

Maximum number of worker nodes as per this metrics can be scaled up to in one batch.

integer (int32)

minComputeNodesForDatabase
optional

The minimum number of compute nodes as per these metrics can be scaled down to.
Default : -1

integer (int32)

minWorkersForDatabase
optional

Minimum number of worker nodes as per this metrics can be scaled down to.

integer (int32)

minimumBlockCacheGb
optional

The amount of block cache, in Gigabytes, which the database should have.

integer (int32)

targetedValueForMetric
optional

The target value of the metric a user expect to maintain for the cluster

integer (int64)

AutoScalingParameters

A Parameters to configure AutoScaling

Name Description Schema

evaluationPeriod
optional

Period of metrics(in seconds) needs to be considered.

integer (int64)

maxComputeNodesForDatabase
optional

The maximum number of compute nodes, as per these metrics, that can be scaled up to.
Default : -1

integer (int32)

maxCpuUtilization
optional

This configuration is effective when compute nodes are enabled. The maximum percentage threshold for the CPU utilization of nodes. The CPU utilization is obtained from the Cloudera Manager metric 'cpu_percent' across worker and compute nodes. Set 100 or more to disable the CPU metrics.

integer (int32)

maxHdfsUsagePercentage
optional

The maximum percentage of HDFS utilization for the database before we trigger the scaling.

integer (int32)

maxRegionsPerRegionServer
optional

The maximum number of regions per region server.

integer (int32)

maxWorkersForDatabase
optional

Maximum number of worker nodes as per this metrics can be scaled up to.

integer (int32)

maxWorkersPerBatch
optional

Maximum number of worker nodes as per this metrics can be scaled up to in one batch.

integer (int32)

minComputeNodesForDatabase
optional

The minimum number of compute nodes, as per these metrics, that can be scaled down to.
Default : -1

integer (int32)

minWorkersForDatabase
optional

Minimum number of worker nodes as per this metrics can be scaled down to.

integer (int32)

minimumBlockCacheGb
optional

The amount of block cache, in Gigabytes, which the database should have.

integer (int32)

targetedValueForMetric
optional

The target value of the metric a user expect to maintain for the cluster

integer (int64)

ClientConfigurationDetails

A URL which holds information necessary to configure a Connector.

Name Description Schema

name
optional

The name of this configuration

string

url
optional

The URL from which to fetch the configuration

string

CloudPlatform

Cloud Provider that cluster is exhibited on. AWS - AWS AZURE - Azure GCP - GCP

Type : enum (AWS, AZURE, GCP)

CollectDiagnosticsRequest

Enables starting collection of the diagnostics. This is an asynchronous API and not expected to block.

Name Description Schema

databaseName
required

The name of the database

string

endTime
required

The end time (in ISO 8601 format) of the period to collection statistics for.

string

environmentName
required

The name of the environment

string

startTime
optional

The start time (in ISO 8601 format) of the period to collection statistics for.

string

CollectDiagnosticsResponse

Information about diagnostic bundle generation

Name Description Schema

diagnosticsBundle
optional

Details of requested diagnostic bundle collection

DiagnosticsBundle

ComponentsVersion

Versions of the CDP runtime and Operating system components.

Name Description Schema

cdp
optional

CDP Runtime version.

string

cm
optional

Version of Cloudera Manager.

string

os
optional

Operation System name and version.

string

osPatchLevel
optional

Operation System patch level.

string

ConfigurationType

Type of an HBase configuration. SERVICE - Service level configuration. MASTER - Configuration for the Master nodes. REGIONSERVER - Configuration for the RegionServer nodes. STRONGMETA - Configuration for the StrongMeta RegionServer nodes. GATEWAY - Configuration for the Gateway nodes.

Type : enum (SERVICE, MASTER, REGIONSERVER, STRONGMETA, GATEWAY)

Connector

Information to use to connect to a database via some mechanism.

Name Description Schema

configuration
optional

Runtime details required to use the connector.

ConnectorConfiguration

dependencies
optional

Software dependency information necessary to use the connector.

DependencyManagement

kind
optional

A categorization of this connector.

Kind

name
optional

The name of the API/Library this connector represents.

string

requiresKerberos
optional

True if the connector requires Kerberos to authenticate.

boolean

version
optional

The version of the connector.

string

ConnectorConfiguration

Runtime details necessary to use a connector.

Name Description Schema

clientConfigurationDetails
optional

Configuration information required to use a Connector

< ClientConfigurationDetails > array

jdbcUrl
optional

A base JDBC URL if the connector is a JDBC driver.

string

serviceUrl
optional

A base service URL

string

Coprocessor

An instance of a coprocessor.

Name Description Schema

commandId
optional

The last committed command ID of the coprocessor.

integer (int64)

coprocessorArgs
optional

The optional coprocessor arguments in comma-separated list.

string

coprocessorCanonicalName
optional

The coprocessor canonical name. It is unique per database.

string

coprocessorLocationUrl
optional

The coprocessor location URL.

string

status
optional

The current status when listing coprocessors.

CoprocessorStatusType

statusReason
optional

The reason of the current status.

string

tableName
optional

Fully qualified table name.

string

CoprocessorStatusType

Coprocessor status type. ADD_NEW - When an add coprocessor request was just requested. ADD_IN_PROGRESS - When an add coprocessor request is in progress. ADD_FAILED - When an add coprocessor request has failed. ADD_SUCCESSFUL - Add coprocessor request has been completed successfully. REMOVE_NEW - When a remove coprocessor request was just requested. REMOVE_IN_PROGRESS - When a remove coprocessor is in progress. REMOVE_FAILED - When a remove coprocessor request has failed. REMOVE_SUCCESSFUL - Remove coprocessor request has been completed successfully.

Type : enum (ADD_NEW, ADD_IN_PROGRESS, ADD_FAILED, ADD_SUCCESSFUL, REMOVE_NEW, REMOVE_IN_PROGRESS, REMOVE_FAILED, REMOVE_SUCCESSFUL, UNKNOWN)

CreateDatabaseRequest

A request to create the database

Name Description Schema

attachedStorageForWorkers
optional

Attached storage for the worker nodes for AWS, Azure, and GCP cloud providers.

AttachedStorageForWorkers

autoScalingParameters
optional

Parameters to configure the AutoScaling

AutoScalingParameters

computeClusterCrn
optional

Utilizes the existing compute cluster with the provided CRN instead of creating a new one.

string

computeClusterId
optional

Uses provided compute cluster for Kubernetes clusters instead of creating a new one. Deprecated, use computeClusterCrn instead.

string

customInstanceTypes
optional

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

CustomInstanceTypes

customUserTags
optional

Optional tags to apply to launched infrastructure resources

< KeyValuePair > array

databaseName
required

database name

string

disableExternalDB
optional

Skips external database creation to avoid DB creation time.

boolean

disableJwtAuth
optional

Disable OAuth Bearer (JWT) authentication scheme.

boolean

disableKerberos
optional

Disable Kerberos authentication.

boolean

disableMultiAz
optional

Disable deployment into multiple availability-zones (the database will be deployed into one subnet).

boolean

enableGrafana
optional

To enable grafana server for the database.

boolean

enableRegionCanary
optional

To enable the region canary for the database.

boolean

environmentName
required

environment name

string

gatewayNodesCount
optional

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

integer (int32)

image
optional

Image details for the database.

Image

javaVersion
optional

Optional tag to configure the major version of Java on the cluster.

integer (int32)

numEdgeNodes
optional

Number of edge nodes to be created for the database. A positive, non-zero number is required. The default value is 0.

integer (int32)

recipes
optional

Custom recipes for the database.

< CustomRecipe > array

restworkerNodesCount
optional

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

integer (int32)

rootVolumeSize
optional

Root volume size in GiB.

integer (int32)

scaleType
optional

Optional tags to choose one of the predefined cluster sizes.

ScaleType

storageLocation
optional

Provide an optional external storage location for a non-CDP managed bucket as the HBase root.

string

storageType
optional

Optional tag to choose the storage types.

StorageType

subnetId
optional

Override subnet where the database will be deployed. Disables Multi-AZ if set [only for AWS].

string

volumeEncryptions
optional

Specifies encryption key to encrypt volume for instance group. It is currently supported for AWS cloud provider only.

< VolumeEncryption > array

CreateDatabaseResponse

A response which gives status of the database creation

Name Description Schema

databaseDetails
required

Details of the Database created

DatabaseDetails

CreateSnapshotRequest

Create Snapshot Request.

Name Description Schema

databaseName
required

The name of the database.

string

environmentName
required

The name of the environment

string

snapshotLocation
required

Snapshot location URL on object store

string

snapshotName
required

Snapshot name unique per database.

string

tableName
required

fully qualified table name

string

CreateSnapshotResponse

Create Snapshot Response.

Name Description Schema

commandID
optional

command id

integer (int64)

creationTime
optional

When the snapshot was created

integer (int64)

databaseName
optional

The name of the database

string

environmentName
optional

The name of the environment

string

status
optional

Status

SnapshotStatusType

statusReason
optional

Reason for the status

string

CustomInstanceType

Parameters to configure custom VM Instance Types.

Name Description Schema

instanceGroup
optional

The Instance Group Type.

InstanceGroupType

instanceType
optional

The Custom VM Instance Type.

string

CustomInstanceTypes

Custom VM Instance Types.

Name Description Schema

computeType
optional

Compute VM Instance Type.

string

edgeType
optional

Edge VM Instance Type.

string

gatewayType
optional

Gateway VM Instance Type.

string

leaderType
optional

Leader VM Instance Type.

string

masterType
optional

Master VM Instance Type.

string

workerType
optional

Worker VM Instance Type.

string

CustomRecipe

Describe a custom recipe.

Name Description Schema

instanceGroup
required

Instance group to apply the recipe to.

InstanceGroupType

names
required

Name of the recipe.

< string > array

DatabaseDetails

Details of the databases.

Name Description Schema

autoScalingConfig
optional

The autoscaling config

AutoScalingConfig

computeNodesCount
optional

Number of active compute nodes in the database (does not include the stopped nodes).

integer (int32)

creationDate
required

The creation time of the database

string (date-time)

creatorCrn
optional

Crn of the creator

string

crn
required

database crn

string

databaseName
required

The name of the database.

string

dbEdgeNodeCount
optional

The number of edge nodes for this database.

integer (int32)

dbVersion
optional

Database version

string

environmentCrn
required

environment crn

string

environmentName
optional

Environment name

string

gatewayNodesCount
optional

Number of gateway nodes for the database.

integer (int32)

hueEndpoint
optional

Hue endpoint

string

internalName
optional

Internal cluster name for this database

string

javaVersion
optional

The version of java on the cluster.

string

numStrongMetaServers
optional

The number of strong meta servers for this database. Requires the COD_STRONG_META_SERVERS entitlement.

integer (int32)

restworkerNodesCount
optional

Number of REST Worker nodes for the database.

integer (int32)

scaleType
optional

The predetermined size of the cluster.

ScaleType

status
optional

Status of the database creation

StatusType

storageDetailsForWorkers
optional

The list of storage details for the worker nodes for AWS, Azure, and GCP cloud providers.

< StorageDetailsForWorker > array

storageLocation
optional

HBase cloud storage location

string

totalComputeNodesCount
optional

Total number of compute nodes in the database (including stopped nodes).

integer (int32)

DeleteSnapshotRequest

Delete Snapshot Request.

Name Description Schema

databaseName
required

The name of the database

string

environmentName
required

The name of the environment

string

snapshotName
required

Snapshot name

string

DeleteSnapshotResponse

Delete Snapshot Response.

Name Description Schema

commandID
optional

command id

integer (int64)

databaseName
optional

The name of the database

string

environmentName
optional

The name of the environment

string

snapshotName
optional

Snapshot name

string

status
optional

Status

SnapshotStatusType

statusReason
optional

Reason for the status

string

DependencyManagement

Information about dependencies necessary to use a connector.

Name Description Schema

mavenUrl
optional

The URL of a Maven repository containing the client JARs.

string

DescribeClientConnectivityRequest

A request for client API connectivity to a database.

Name Description Schema

databaseName
required

The name of the database

string

environmentName
required

The name of the environment

string

DescribeClientConnectivityResponse

A response with client API connectivity to a database.

Name Description Schema

connectors
optional

Available connectors for this database

< Connector > array

kerberosConfiguration
optional

Kerberos configuration information

KerberosConfiguration

DescribeDatabaseRequest

request to get details of the database in a particular environment

Name Description Schema

databaseName
required

The name of the database.

string

environmentName
required

The name of the environment.

string

DescribeDatabaseResponse

Details of the database.

Name Description Schema

databaseDetails
optional

The details of the database.

DatabaseDetails

DescribeHbaseConfigurationRequest

A request to describe the HBase configuration.

Name Description Schema

configurationName
required

The name of the configuration used in Cloudera Manager.

string

configurationType
required

The type of the configuration.

ConfigurationType

database
required

The name or CRN of the database.

string

environment
required

The name or CRN of the environment.

string

DescribeHbaseConfigurationResponse

A response to describe the HBase configuration request.

Name Description Schema

configuration
optional

The details of the configuration.

HBaseConfiguration

DescribeUpgradeDatabaseRequest

Request to describe the upgrade availability of CDP Runtime and Operating System for a database.

Name Description Schema

database
required

The name or CRN of the database.

string

environment
required

The name or CRN of the environment.

string

DescribeUpgradeDatabaseResponse

Response with upgrade availability of CDP Runtime and Operating System for a database.

Name Description Schema

availableComponentVersions
optional

List of available versions for upgrade.

< ComponentsVersion > array

currentComponentVersion
optional

Versions of currently deployed CDP runtime and operating system.

ComponentsVersion

isOSUpgradeAvailable
optional

Is an OS upgrade available.

boolean

isRuntimeUpgradeAvailable
optional

Is a CDP Runtime upgrade available.

boolean

statusReason
optional

The reason whether upgrade request is accepted or why it is not possible.

string

DiagnosticsBundle

Describe a diagnostics bundle

Name Description Schema

crn
optional

The object on which diagnostics was collected

string

endTime
optional

The end time, if the command is finished.

string (date-time)

id
optional

Identifier for each bundle collection

string

result
optional

If this is a download, a link to the download location of the bundle

string

startTime
optional

Start time

string (date-time)

status
optional

A status of the diagnostics collection process

string

DropDatabaseRequest

A request to drop the database

Name Description Schema

databaseName
required

database name

string

environmentName
required

environment name

string

DropDatabaseResponse

A response which gives status of the database deletion

Name Description Schema

status
optional

status of delete database request

StatusType

EdgeNode

An instance of a edge nodes.

Name Description Schema

discoveryFQDN
required

Fully qualified domain name

string

instanceId
required

Instance ID.

string

privateIp
required

Private IP.

string

publicIp
required

Public Ip

string

EdgeUpgradeStrategy

Edge node upgrade strategy. ALL - Upgrade edge nodes together. ONE_BY_ONE - Upgrade edge nodes one by one.

Type : enum (ALL, ONE_BY_ONE)

Environment

Details of the environment

Name Description Schema

crn
required

The crn of the environment

string

name
required

The name of the environment

string

Error

An object returned on an error.

Name Description Schema

code
optional

The error code.

string

message
optional

The error message.

string

Event

Details of an event.

Name Description Schema

attributes
optional

Map containing event attributes. Set verbose true to get map of event attributes.

< string, string > map

autoHealAlertId
optional

UUID linking the alert due to node failure and corresponding autoHealing event.

string

createTimestamp
optional

The event creation timestamp.

string (date-time)

expiryTimestamp
optional

The expiration timestamp of the event. Set verbose true to get the expiration timestamp.

string (date-time)

id
required

The event ID.

integer (int64)

lastUpdateTimestamp
optional

The last update timestamp of the event. Set verbose true to get last update timestamp.

string (date-time)

status
required

Event status.

string

statusReason
optional

Event reason. Set verbose true to get event reason.

string

type
required

Event type , currently value can be either ALERT_DELIVERY or AUTO_HEALING but more values could be introduced over time.

string

EventType

Type of an Event

Type : enum (ALERT_DELIVERY, AUTO_HEALING)

GroupType

Group type for the database nodes. GATEWAY - GATEWAY value of the Group variable. MASTER - MASTER value of the Group variable.

Type : enum (GATEWAY, MASTER)

HBaseConfiguration

The details of the HBase configuration.

Name Description Schema

name
required

The name of the configuration.

string

value
optional

The value of the configuration.

string

Image

Details of an Image.

Name Description Schema

catalog
optional

Catalog name for the image.

string

id
optional

Image ID for the database.

string

InstanceGroupType

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

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

KerberosConfiguration

Configuration information to enable Kerberos authentication

Name Description Schema

kdcHost
optional

The hostname of the KDC

string

krb5Conf
optional

A base64-encoded krb5.conf file

string

realm
optional

The Kerberos realm

string

KeyValuePair

Generic key-value type, because map<> is not supported

Name Description Schema

key
optional

Key

string

value
optional

Value

string

Kind

A categorization of a connector to describe how it is broadly used. LIBRARY - A client library or API which user’s code invokes JDBC - A JDBC driver SERVICE - A Service URL ENVIRONMENT - An environment to use to run other commands and tools ODBC - An ODBC driver

Type : enum (LIBRARY, JDBC, SERVICE, ENVIRONMENT)

ListCoprocessorsRequest

The request for listing coprocessors in a database.

Name Description Schema

commandId
optional

The command ID for the requested coprocessor.

integer (int64)

database
optional

The name or CRN of the database.

string

environment
optional

The name or CRN of the environment.

string

tableName
optional

Fully qualified table name.

string

ListCoprocessorsResponse

The response for listing coprocessors in a database.

Name Description Schema

coprocessors
optional

The list of coprocessors.

< Coprocessor > array

database
optional

The name or CRN of the database.

string

environment
optional

The name or CRN of the environment.

string

ListDatabasesRequest

A request to list databases

Name Description Schema

environmentName
optional

name of the environment

string

ListDatabasesResponse

A list of databases in response

Name Description Schema

databases
required

The details of the database

< DatabaseDetails > array

ListDiagnosticsRequest

Lists the in-progress diagnostic bundle operations.

Name Description Schema

databaseName
required

The name of the database

string

environmentName
required

The name of the environment

string

ListDiagnosticsResponse

The list of in-progress diagnostic bundle operations

Name Description Schema

diagnosticsBundles
optional

List of diagnostics operations

< DiagnosticsBundle > array

ListEdgeNodesRequest

The request for listing edge nodes in a database.

Name Description Schema

database
required

The name or CRN of the database.

string

environment
required

The name or CRN of the environment.

string

ListEdgeNodesResponse

The response for listing edge nodes in a database.

Name Description Schema

database
required

The name or CRN of the database.

string

edgeNodes
optional

The list of edge nodes for a database.

< EdgeNode > array

environment
required

The name or CRN of the environment.

string

ListEventsRequest

List events request.

Name Description Schema

database
optional

The name or CRN of the database.

string

environment
optional

The name or CRN of the environment.

string

eventType
optional

The type of the event.

EventType

fromTimestamp
optional

The beginning timestamp for the search range (inclusive).

string (date-time)

pageSize
optional

The page size.
Minimum value : 5
Maximum value : 20

integer (int32)

pageToken
optional

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

string

toTimestamp
optional

The ending timestamp for the search range (exclusive).

string (date-time)

verbose
optional

Verbose flag. Set true to get a detailed response. Default is false.

boolean

ListEventsResponse

List events response.

Name Description Schema

events
required

The list of events.

< Event > array

nextPageToken
optional

The token to use when requesting the next set of results. If not present, there are no additional results.

string

ListRestoreSnapshotsRequest

Show Restore Snapshots Request.

Name Description Schema

commandId
optional

Command Id

integer (int64)

databaseName
required

The name of the database

string

environmentName
required

The name of the environment

string

fromRestoreTime
optional

The starting snapshot restore time to search restore snapshots (inclusive).

string (date-time)

snapshotName
optional

Snapshot Name

string

targetDatabaseName
optional

The name of the target database

string

targetEnvironmentName
optional

The name of the target environment

string

toRestoreTime
optional

The ending snapshot restore time to search restore snapshots (inclusive).

string (date-time)

ListRestoreSnapshotsResponse

Show Restore Snapshots Response.

Name Description Schema

databaseName
required

The name of the database.

string

environmentName
required

The name of the environment.

string

restoreSnapshots
optional

List of snapshots which have been restored against the database.

< RestoreSnapshot > array

ListScalingEventsRequest

List scaling events request.

Name Description Schema

database
optional

The name or CRN of the database.

string

environment
optional

The name or CRN of the environment.

string

fromTimestamp
optional

The beginning timestamp for the search range (inclusive).

string (date-time)

pageSize
optional

The page size.
Minimum value : 5
Maximum value : 20

integer (int32)

pageToken
optional

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

string

toTimestamp
optional

The ending timestamp for the search range (exclusive).

string (date-time)

ListScalingEventsResponse

List scaling events response.

Name Description Schema

nextPageToken
optional

The token to use when requesting the next set of results. If not present, there are no additional results.

string

scalingEvents
optional

The details of the scaling event.

< ScalingEvent > array

ListSnapshotsRequest

Show Snapshots Request.

Name Description Schema

commandId
optional

Command Id

integer (int64)

databaseName
required

The name of the database

string

environmentName
required

The name of the environment

string

fromCreationTime
optional

The starting snapshot creation time to search snapshots (inclusive).

string (date-time)

tableName
optional

Table name

string

toCreationTime
optional

The ending snapshot creation time to search snapshots (inclusive).

string (date-time)

ListSnapshotsResponse

Show Snapshots Response.

Name Description Schema

databaseName
required

The name of the database

string

environmentName
required

The name of the environment

string

snapshots
optional

List of snapshots

< Snapshot > array

status
optional

Status

SnapshotStatusType

statusReason
optional

Reason for the status

string

ListSupportedEnvironmentsRequest

A request to get a list of available environments

Type : object

ListSupportedEnvironmentsResponse

A response which contains a list of available environments

Name Description Schema

environments
optional

The crn of the environment

< Environment > array

ListSupportedInstanceTypesRequest

The request for listing supported instance types.

Name Description Schema

architecture
optional

The Architecture.

ArchitectureType

cloudPlatform
required

The name of Cloud Platform.

CloudPlatform

instanceGroup
optional

The Instance Group Type.

InstanceGroupType

scaleType
required

The Scale Type.

ScaleType

storageType
required

The Storage Type.

StorageType

ListSupportedInstanceTypesResponse

The response for listing supported instance types.

Name Description Schema

supportedInstanceTypesLists
optional

List of supported instance types.

< SupportedInstanceTypesList > array

PrepareUpgradeDatabaseRequest

Asynchronous request to prepare cluster upgrade.

Name Description Schema

database
required

The name or CRN of the database.

string

environment
required

The name or CRN of the environment.

string

imageId
optional

ID of a database image to upgrade to.

string

runtime
optional

The CDP Runtime version to upgrade to.

string

PrepareUpgradeDatabaseResponse

Response with the reason whether prepare upgrade request is accepted or why it is not possible.

Name Description Schema

statusReason
optional

The reason whether upgrade request is accepted or why it is not possible.

string

RemoveCoprocessorRequest

The request for removing a coprocessor of a table in a database.

Name Description Schema

coprocessorCanonicalName
required

The coprocessor canonical name. It is unique per database.

string

database
optional

The name or CRN of the database.

string

environment
optional

The name or CRN of the environment.

string

force
optional

Forcefully remove the coprocessor.

boolean

tableName
required

Fully qualified table name.

string

RemoveCoprocessorResponse

The response for removing a coprocessor of a table in a database.

Name Description Schema

commandId
optional

The command ID of the submitted request.

integer (int64)

status
optional

The current status when submitting the remove coprocessor request.

CoprocessorStatusType

RestoreSnapshot

An instance of restoring a snapshot to a database.

Name Description Schema

commandID
optional

Command id

integer (int64)

failureReason
optional

Reason for the failure in case of restore snapshot failed.

string

restoreTime
optional

When the snapshot restore was started

integer (int64)

snapshotName
optional

The snapshot name

string

status
optional

Status

SnapshotStatusType

targetDatabaseName
optional

The name of the target database

string

targetEnvironmentName
optional

The name of the target environment

string

RestoreSnapshotRequest

Restore Snapshot Request.

Name Description Schema

databaseName
required

The name of the original database

string

environmentName
required

The name of the original environment

string

snapshotName
required

Snapshot name

string

targetDatabaseName
required

The name of the target database where the snapshot should be restored

string

targetEnvironmentName
required

The name of the target environment where the snapshot should be restored

string

RestoreSnapshotResponse

Restore Snapshot Response.

Name Description Schema

commandID
optional

Command id

integer (int64)

databaseName
optional

The name of the database

string

environmentName
optional

The name of the environment

string

restoreTime
optional

When the snapshot restore was started

integer (int64)

snapshotName
optional

The snapshot name

string

status
optional

Status

SnapshotStatusType

statusReason
optional

Reason for the status

string

targetDatabaseName
optional

The name of the target database

string

targetEnvironmentName
optional

The name of the target environment

string

ScaleType

Scale type. MICRO - Create a 2-node cluster (1 gateway and 1 worker) with high availability disabled. LIGHT - Create a multi-node cluster with a light master and gateway instance type. HEAVY - Create a multi-node cluster with heavy master and gateway instance type.

Type : enum (MICRO, LIGHT, HEAVY)

ScalingEvent

Details of a scaling event.

Name Description Schema

eventTimestamp
optional

The time of the event creation.

string (date-time)

metric
optional

JSON of the metric name and value that triggered the scaling event.

string

nodeCountAfter
optional

Node count after scaling event.

integer (int32)

nodeCountBefore
optional

Node count before scaling event.

integer (int32)

reason
optional

Reason for the scaling event in a readable format.

string

status
optional

Scaling event status.

string

Snapshot

An instance of a table’s snapshot.

Name Description Schema

commandID
optional

Command id

integer (int64)

creationTime
optional

Creation Time

integer (int64)

failureReason
optional

Reason for the failure in case of snapshot creation failed.

string

snapshotLocation
optional

Snapshot location

string

snapshotName
required

Snapshot Name

string

status
optional

Status

SnapshotStatusType

tableName
required

Table Name

string

SnapshotStatusType

Snapshot Status Type. NEW - Expected when a snapshot request was just requested. IN_PROGRESS - When a snapshot request is in progress. FAILED - If for any reason a snapshot request has failed. SUCCESSFUL - A snapshot request has completed successfully. LOCKED - A snapshot exists, but can’t be restored or read. DELETED - A snapshot existed but was just deleted. CORRUPT - A snapshot got corrupted. DELETING - A snapshot is being deleted.

Type : enum (NEW, IN_PROGRESS, FAILED, SUCCESSFUL, LOCKED, DELETED, CORRUPT, UNKNOWN)

StartDatabaseRequest

Start the database.

Name Description Schema

databaseName
required

The name of the database.

string

environmentName
required

The name of the environment

string

StartDatabaseResponse

A response from starting the database.

Name Description Schema

previousStatus
optional

The status of the database prior to the start request.

StatusType

wasStarted
optional

True if the database start request accepted

boolean

StatusType

status of the database

Type : enum (REQUESTED, CREATE_IN_PROGRESS, AVAILABLE, UPDATE_IN_PROGRESS, UPDATE_REQUESTED, UPDATE_FAILED, CREATE_FAILED, ENABLE_SECURITY_FAILED, PRE_DELETE_IN_PROGRESS, 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, REQUESTING, MISSING, BACKUP_IN_PROGRESS, BACKUP_FAILED, BACKUP_FINISHED, RESTORE_IN_PROGRESS, RESTORE_FAILED, RESTORE_FINISHED, DELETED_ON_PROVIDER_SIDE, AMBIGUOUS, EXTERNAL_DATABASE_CREATION_IN_PROGRESS, EXTERNAL_DATABASE_CREATION_FAILED, EXTERNAL_DATABASE_DELETION_IN_PROGRESS, EXTERNAL_DATABASE_DELETION_FINISHED, EXTERNAL_DATABASE_DELETION_FAILED, UNKNOWN, EXTERNAL_DATABASE_START_IN_PROGRESS, EXTERNAL_DATABASE_START_FINISHED, EXTERNAL_DATABASE_START_FAILED, EXTERNAL_DATABASE_STOP_IN_PROGRESS, EXTERNAL_DATABASE_STOP_FINISHED, EXTERNAL_DATABASE_STOP_FAILED, LOAD_BALANCER_UPDATE_IN_PROGRESS, LOAD_BALANCER_UPDATE_FINISHED, LOAD_BALANCER_UPDATE_FAILED, UNREACHABLE, NODE_FAILURE, RECOVERY_IN_PROGRESS, RECOVERY_REQUESTED, RECOVERY_FAILED)

StopDatabaseRequest

Stop the database.

Name Description Schema

databaseName
required

The name of the database.

string

environmentName
required

The name of the environment

string

StopDatabaseResponse

A response from stopping the database.

Name Description Schema

previousStatus
optional

The status of the database prior to the stop request.

StatusType

wasStopped
optional

True if the database stop request accepted

boolean

StorageDetailsForWorker

Storage details for the worker node for AWS, Azure, and GCP cloud providers.

Name Description Schema

volumeCount
optional

The number of volumes.

integer (int32)

volumeSize
optional

The target size of the volume, in GiB.

integer (int32)

volumeType
optional

The volume type.

VolumeType

StorageType

Storage type for clusters. CLOUD_WITH_EPHEMERAL - Cloud with ephemeral storage. CLOUD - Cloud storage without ephemeral storage. HDFS - HDFS storage. CLOUD_WITH_EPHEMERAL_DATATIERING - Cloud with Ephemeral Storage and Datatiering.

Type : enum (CLOUD_WITH_EPHEMERAL, CLOUD, HDFS)

SupportedInstanceTypesList

Instance Types list for listing supported instance types.

Name Description Schema

defaultInstanceTypes
optional

The default instance type.

string

instanceGroup
optional

The Instance Group Type.

string

supportedInstanceTypes
optional

The other instance types supported.

string

UpdateDatabaseRequest

A request to update the database

Name Description Schema

autoScalingParameters
optional

Parameters to configure the scaling policy

AutoScalingParameters

catalog
optional

Catalog name for the image.

string

databaseName
required

database name

string

environmentName
required

environment name

string

numDesiredRestworkerNodes
optional

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

integer (int32)

numDesiredStrongMetaServers
optional

The desired number of strong meta servers for this database. A positive, non-zero number is required. Use removeStrongMetaServers to remove strong meta servers entirely. Requires the COD_STRONG_META_SERVERS entitlement.

integer (int32)

removeRestworkerNodes
optional

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

boolean

removeStrongMetaServers
optional

Removes any strong meta servers provisioned for this database. Requires the COD_STRONG_META_SERVERS entitlement.

boolean

switchInstanceType
optional

Provide custom VM instance types to switch instance types for instance groups. Requires COD_USE_CUSTOM_INSTANCE_TYPES entitlement.

CustomInstanceType

verticalScale
optional

Vertical Scale request for database.

GroupType

UpdateDatabaseResponse

A response to database update request

Name Description Schema

status
optional

Status of whether the update was successful or not.

string

UpdateEdgeNodesRequest

The request for updating edge nodes in a database.

Name Description Schema

database
required

The name or CRN of the database.

string

deleteEdgeInstances
optional

The instance(s) of database edge node to be deleted. An instance id of the node is required.

< string > array

environment
required

The name or CRN of the environment.

string

numAddEdgeNodes
optional

The additional number of edge nodes for this database. A positive, non-zero number is required.

integer (int32)

UpdateEdgeNodesResponse

The response for updating edge nodes in a database.

Name Description Schema

database
required

The name or CRN of the database.

string

edgeNodes
optional

The list of edge nodes for a database.

< EdgeNode > array

environment
required

The name or CRN of the environment.

string

UpdateHbaseConfigurationRequest

A request to update the HBase configuration.

Name Description Schema

configurationName
required

The name of the configuration in Cloudera Manager being updated.

string

configurationType
required

The type of the configuration being updated.

ConfigurationType

configurationValue
required

The new value of the configuration being updated.

string

database
required

The name or CRN of the database.

string

environment
required

The name or CRN of the environment.

string

UpdateHbaseConfigurationResponse

A response to update the HBase configuration request.

Name Description Schema

configuration
optional

The details of the configuration.

HBaseConfiguration

UpgradeDatabaseRequest

Asynchronous request to upgrade the CDP Runtime for a database.

Name Description Schema

database
optional

The name or CRN of the database.

string

edgeUpgradeStrategy
optional

Upgrade strategy for edge nodes.

EdgeUpgradeStrategy

environment
optional

The name or CRN of the environment.

string

imageId
optional

ID of a database image to upgrade to. If this is empty, the default image is used.

string

nonWorkerBatchSize
optional

Batch size of non-worker nodes for restart.

integer (int32)

osUpgradeOnly
optional

Only perform an Operating System upgrade.

boolean

rollingUpgrade
optional

Perform upgrade in a rolling fashion.

boolean

runtime
optional

The CDP Runtime version to upgrade to.

string

workerBatchSize
optional

Batch size of worker nodes for restart.

integer (int32)

UpgradeDatabaseResponse

Response with the reason whether upgrade request is accepted or why it is not possible.

Name Description Schema

statusReason
optional

The reason whether upgrade request is accepted or why it is not possible.

string

VolumeEncryption

Specify volume encryption key for instance group.

Name Description Schema

encryptionKey
required

Encryption key.

string

instanceGroup
required

Instance group to apply the encryption key to.

InstanceGroupType

VolumeType

Volume Type. HDD - Hard disk drives (HDD) volume type. Default is HDD. SSD - Solid disk drives (SSD) volume type. LOCAL_SSD - Local SSD volume type.

Type : enum (HDD, SSD, LOCAL_SSD)


Copyright © 2024 Cloudera, Inc. All rights reserved.