Overview

Defining service of compute public API service

Version information

Version : 0.9.112

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

Describes a deployment

POST /api/v1/compute/describeDeployment

Description

Gets a single deployment along with its extended history. This can also include all of the known templates.

Parameters

Type Name Schema

Body

input
required

DescribeDeploymentRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeDeploymentResponse

default

The default response on an error.

Error

List compute clusters

POST /api/v1/compute/listClusters

Description

List all compute clusters in a CDP Environment

Parameters

Type Name Schema

Body

input
required

ListClustersRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListClustersResponse

default

The default response on an error.

Error

Upgrades a deployment to a different chart.

POST /api/v1/compute/upgradeDeployment

Description

Upgrades a deployment to a different chart.

Parameters

Type Name Schema

Body

input
required

UpgradeDeploymentRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

UpgradeDeploymentResponse

default

The default response on an error.

Error

Definitions

AvailableDeploymentUpgrade

Available deployment upgrade structure.

Name Description Schema

applicationVersion
optional

The version of the components which would be installed from this deployment.

string

deploymentVersion
optional

The version of the deployment that is available to upgrade to.

string

Chart

Chart structure.

Name Description Schema

applicationVersion
optional

The version (usually of the images) of the components being deployed.

string

deploymentVersion
optional

The version of this chart (which is not the version of the components being deployed).

string

description
optional

The chart description.

string

name
optional

The chart name.

string

values
optional

Escaped JSON for values.yaml of that chart.

string

CommonImageCatalogResp

Image catalog response structure.

Name Description Schema

crn
optional

The catalog CRN (either CRN or name is required).

string

name
optional

The catalog name (either CRN or name is required).

string

CommonStorageSpecResp

Storage spec response structure.

Name Description Schema

csiEnabled
optional

Flag to enable CSI (Container Storage Interface). It further sets specific inline cloud formation policies required for CSI.

boolean

ComputeClusterOwner

Compute cluster owner structure.

Name Description Schema

accountId
optional

Owner’s account ID.

string

crn
optional

Owner’s actor CRN.

string

email
optional

Owner’s email.

string

firstName
optional

Owner’s firstname.

string

lastName
optional

Owner’s lastname.

string

userId
optional

Owner’s user ID.

string

ComputeClusterType

Object representing compute cluster types. DedicatedExternal - Value representing an external dedicated compute cluster. Shared - Value representing a shared compute cluster. Dedicated - Value representing an embedded dedicated compute cluster.

Type : enum (DedicatedExternal, Shared, Dedicated)

ComputePlatform

object representing CDP Compute Cluster Platform provider OPENSHIFT - OpenShift Container Platform cluster as compute platform (private cloud only). EKS - EKS cluster as compute platform AKS - AKS cluster as compute platform RKE - Rancher RKE as compute platform (private cloud only).

Type : enum (OPENSHIFT, EKS, AKS, RKE)

Deployment

Deployment structure.

Name Description Schema

chart
optional

Chart that the deployment was created from.

Chart

liftieManaged
optional

True if Liftie is managing this deployment.

boolean

name
optional

The name of the deployment.

string

namespace
optional

The namespace of the deployment.

string

overrides
optional

Escaped JSON overrides for the deployment’s properties.

string

revision
optional

Helm revision.

integer (int32)

status
optional

Status of the deployment. Currently supported values are UNKNOWN, DEPLOYED, UNINSTALLED, SUPERSEDED, FAILED, PENDING-INSTALL, PENDING-UPGRADE and PENDING-ROLLBACK. New values may be added in the future.

string

upgrades
optional

Any upgrades available for this deployment.

< AvailableDeploymentUpgrade > array

DescribeDeploymentRequest

Request structure for describing a deployment.

Name Description Schema

clusterCrn
required

Compute cluster CRN.

string

name
required

The name of the deployment.

string

namespace
required

The namespace of the deployment.

string

DescribeDeploymentResponse

Response structure for describing a deployment.

Name Description Schema

deployment
optional

Deployment details.

Deployment

history
optional

History of the deployment.

< History > array

overrides
optional

Escaped JSON overrides for the deployment’s properties. Deprecated.

string

EnvCloudProvider

object representing CDP Environment cloud provider type AWS - CDP Environment installed in AWS AZURE - CDP Environment installed in Azure OPENSHIFT - CDP Environment installed as on-premise instalation using CDP DC services in base cluster

Type : enum (AWS, AZURE, OPENSHIFT)

Error

An object returned on an error.

Name Description Schema

code
optional

The error code.

string

message
optional

The error message.

string

History

History structure.

Name Description Schema

chart
optional

Chart that the deployment was created from.

Chart

overrides
optional

Escaped JSON overrides for the deployment’s properties for given revision.

string

revision
optional

Helm revision.

integer (int32)

status
optional

Status of the deployment. Currently supported values are UNKNOWN, DEPLOYED, UNINSTALLED, SUPERSEDED, FAILED, PENDING-INSTALL, PENDING-UPGRADE and PENDING-ROLLBACK. New values may be added in the future.

string

ListClusterItem

List clusters item structure.

Name Description Schema

account
optional

/ CDP account ID.

string

availableUpgrades
optional

List of available kubernetes upgrades.

< string > array

clusterCrn
optional

Compute cluster CRN.

string

clusterId
optional

Compute cluster ID.

string

clusterName
optional

Compute cluster name.

string

clusterOwner
optional

Cluster owner.

ComputeClusterOwner

clusterSize
optional

Number of nodes in the cluster.

integer (int32)

clusterStateVersion
optional

Cluster state version.

integer (int32)

clusterType
optional

Compute cluster type.

ComputeClusterType

computePlatform
optional

Compute cluster platform provider.

ComputePlatform

computePlatformVersion
optional

Compute cluster platform version.

string

creationTime
optional

Compute cluster creation time in ISO format.

string

deletionTime
optional

Compute cluster deletion time in ISO format.

string

envCloudProvider
optional

CDP environment cloud provider.

EnvCloudProvider

envCrn
optional

CDP environment CRN.

string

envName
optional

CDP environment name.

string

imageCatalog
optional

The image catalog details.

CommonImageCatalogResp

kubernetesVersion
optional

Kubernetes version.

string

labels
optional

Map of labels associated with this cluster.

< string, string > map

message
optional

Message with additional details about the cluster status.

string

region
optional

Region.

string

status
optional

Compute cluster status.

string

storage
optional

The storage specifications.

CommonStorageSpecResp

updateTime
optional

Compute cluster update time in ISO format.

string

ListClustersRequest

Request object to list clusters.

Name Description Schema

envNameOrCrn
optional

Environment name or crn.

string

includeDeleted
optional

Include deleted clusters in the response. Optional.
Default : false

boolean

pageSize
optional

The size of each page. Default is 100.
Default : 100
Minimum value : 1
Maximum value : 500

integer (int32)

startingToken
optional

A token to specify where to start paginating. This is the nextToken from a previously truncated response. 1 or empty for first page.

string

status
optional

Cluster Status for status filtering.

string

workloads
optional

Workloads for workload filtering.

string

ListClustersResponse

List clusters response.

Name Description Schema

clusters
optional

Array of CDP compute clusters.

< ListClusterItem > array

nextToken
optional

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

string

totalClusters
optional

Total number of clusters.

integer (int32)

totalPages
optional

Total number of pages.

integer (int32)

UpgradeDeploymentRequest

Request structure for upgrading a deployment.

Name Description Schema

chartVersion
optional

The version of the deployment to upgrade to. Defaults to latest version.

string

clusterCrn
required

Compute cluster CRN.

string

name
required

The name of the deployment.

string

namespace
required

The namespace of the deployment.

string

overrides
optional

Escaped JSON overrides for the deployment’s properties.

string

UpgradeDeploymentResponse

Response structure for upgrading a deployment.

Name Description Schema

chart
optional

Chart that the deployment was created from.

Chart

message
optional

A message returned about the status of the upgrade operation.

string

name
optional

The name of the deployment.

string

namespace
optional

The namespace of the deployment.

string

revision
optional

Helm revision.

integer (int32)

status
optional

Status of the deployment. Currently supported values are UNKNOWN, DEPLOYED, UNINSTALLED, SUPERSEDED, FAILED, PENDING-INSTALL, PENDING-UPGRADE and PENDING-ROLLBACK. New values may be added in the future.

string

Copyright © 2024 Cloudera, Inc. All rights reserved.