Overview

Interact with the Cloudera Operational Database service

Version information

Version : 0.9.111

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

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

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

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

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

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

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

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

AutoScalingParameters

A Parameters to configure AutoScaling

Name Description Schema

evaluationPeriod
optional

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

integer (int64)

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)

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

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

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

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

customUserTags
optional

Optional tags to apply to launched infrastructure resources

< KeyValuePair > array

databaseName
required

database name

string

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

image
optional

Image details for the database.

Image

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

scaleType
optional

Optional tags to choose one of the predefined cluster sizes.

ScaleType

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.

string

CreateDatabaseResponse

A response which gives status of the database creation

Name Description Schema

databaseDetails
required

Details of the Database created

DatabaseDetails

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

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

dbVersion
optional

Database version

string

environmentCrn
required

environment crn

string

environmentName
optional

Environment name

string

hueEndpoint
optional

Hue endpoint

string

internalName
optional

Internal cluster name for this database

string

status
optional

Status of the database creation

StatusType

storageLocation
optional

HBase cloud storage location

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

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

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

Image

Details of an Image.

Name Description Schema

catalog
required

Catalog name for the image.

string

id
required

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.

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)

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

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

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)

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

StorageType

Storage type for clusters. CLOUD_WITH_EPHEMERAL - Cloud with ephemeral storage. CLOUD - Cloud storage without ephemeral storage. HDFS - HDFS storage.

Type : enum (CLOUD_WITH_EPHEMERAL, CLOUD, HDFS)

UpgradeDatabaseRequest

Asynchronous request to upgrade the CDP Runtime for a database.

Name Description Schema

database
optional

The name or CRN of the database.

string

environment
optional

The name or CRN of the environment.

string

osUpgradeOnly
optional

Only perform an Operating System upgrade.

boolean

runtime
optional

The CDP Runtime version to upgrade to.

string

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

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.