Overview

Defining service of compute public API service

Version information

Version : 0.9.153 (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 User

POST /api/v1/compute/addUser

Description

Adds a user or a role to a compute cluster.

Parameters

Type Name Schema

Body

input
required

AddUserRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

AddUserResponse

default

The default response on an error.

Error

Create compute cluster

POST /api/v1/compute/createCluster

Description

Creates compute cluster.

Parameters

Type Name Schema

Body

input
required

CreateClusterRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

CreateClusterResponse

default

The default response on an error.

Error

Delete compute cluster

POST /api/v1/compute/deleteCluster

Description

Deletes compute cluster.

Parameters

Type Name Schema

Body

input
required

DeleteClusterRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DeleteClusterResponse

default

The default response on an error.

Error

Deletes a deployment

POST /api/v1/compute/deleteDeployment

Description

Deletes a deployment that is currently installed and managed for this cluster.

Parameters

Type Name Schema

Body

input
required

DeleteDeploymentRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DeleteDeploymentResponse

default

The default response on an error.

Error

Delete User

POST /api/v1/compute/deleteUser

Description

Deletes a user or a role of a compute cluster.

Parameters

Type Name Schema

Body

input
required

DeleteUserRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DeleteUserResponse

default

The default response on an error.

Error

Describe compute cluster

POST /api/v1/compute/describeCluster

Description

Describe compute cluster details in a CDP Environment

Parameters

Type Name Schema

Body

input
required

DescribeClusterRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeClusterResponse

default

The default response on an error.

Error

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

Describe User

POST /api/v1/compute/describeUser

Description

Describes a user or a role of a compute cluster.

Parameters

Type Name Schema

Body

input
required

DescribeUserRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeUserResponse

default

The default response on an error.

Error

Get kube config content

POST /api/v1/compute/getKubeConfig

Description

Get kubernetes configuration content for a compute cluster.

Parameters

Type Name Schema

Body

input
required

GetKubeConfigRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

GetKubeConfigResponse

default

The default response on an error.

Error

GetOperationDetails

POST /api/v1/compute/getOperationDetails

Description

To get detailed information about the long running operation.

Parameters

Type Name Schema

Body

input
required

GetOperationDetailsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

GetOperationDetailsResponse

default

The default response on an error.

Error

GetOperationStatus

POST /api/v1/compute/getOperationStatus

Description

A lightweight API to get status of a long running operation.

Parameters

Type Name Schema

Body

input
required

GetOperationStatusRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

GetOperationStatusResponse

default

The default response on an error.

Error

Installs a deployment

POST /api/v1/compute/installDeployment

Description

Installs a new deployment in the specified namespace.

Parameters

Type Name Schema

Body

input
required

InstallDeploymentRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

InstallDeploymentResponse

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

List deployments in the cluster.

POST /api/v1/compute/listDeployments

Description

Lists the helm charts that are available for deployment or have already been deployed in this cluster.

Parameters

Type Name Schema

Body

input
required

ListDeploymentsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListDeploymentsResponse

default

The default response on an error.

Error

ListOperations

POST /api/v1/compute/listOperations

Description

To list all the long running operations on a given cluster.

Parameters

Type Name Schema

Body

input
required

ListOperationsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListOperationsResponse

default

The default response on an error.

Error

List Users

POST /api/v1/compute/listUsers

Description

Lists users and roles of a compute cluster.

Parameters

Type Name Schema

Body

input
required

ListUsersRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListUsersResponse

default

The default response on an error.

Error

Resume Cluster

POST /api/v1/compute/resumeCluster

Description

Resumes the compute cluster

Parameters

Type Name Schema

Body

input
required

ResumeClusterRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ResumeClusterResponse

default

The default response on an error.

Error

ResetOperation

POST /api/v1/compute/retryOperation

Description

To reset a failed operation for retry.

Parameters

Type Name Schema

Body

input
required

RetryOperationRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

RetryOperationResponse

default

The default response on an error.

Error

Rollbacks a deployment to a previous revision

POST /api/v1/compute/rollbackDeployment

Description

This will perform a rollback.

Parameters

Type Name Schema

Body

input
required

RollbackDeploymentRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

RollbackDeploymentResponse

default

The default response on an error.

Error

Suspend Cluster

POST /api/v1/compute/suspendCluster

Description

Suspends the compute cluster

Parameters

Type Name Schema

Body

input
required

SuspendClusterRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

SuspendClusterResponse

default

The default response on an error.

Error

Update cluster

POST /api/v1/compute/updateCluster

Description

Updates compute cluster.

Parameters

Type Name Schema

Body

input
required

UpdateClusterRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

UpdateClusterResponse

default

The default response on an error.

Error

Update instance group

POST /api/v1/compute/updateInstanceGroup

Description

Updates an instance group of a compute cluster.

Parameters

Type Name Schema

Body

input
required

UpdateInstanceGroupRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

UpdateInstanceGroupResponse

default

The default response on an error.

Error

Upgrade kubernetes version of the cluster

POST /api/v1/compute/upgradeCluster

Description

Upgrades the kubernetes version of the cluster to the specified version.

Parameters

Type Name Schema

Body

input
required

UpgradeClusterRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

UpgradeClusterResponse

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

Validate compute cluster

POST /api/v1/compute/validateCluster

Description

Validates compute cluster.

Parameters

Type Name Schema

Body

input
required

ValidateClusterRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ValidateClusterResponse

default

The default response on an error.

Error

Definitions

AcceleratorConfigResp

Accelerator Configurations structure

Name Description Schema

acceleratorManufacturers
optional

Accelerator Manufacturer type. For eg. amazon-web-service, AMD, nvidia.

< string > array

acceleratorTypes
optional

Accelerator Types. For eg. gpu, inference.

< string > array

Activity

Represents an individual activity within a workflow execution.

Name Description Schema

activityId
optional

Unique identifier for this activity instance.

string

completedAt
optional

Time when the activity completed execution.

string (date-time)

logs
optional

Collection of log messages generated during activity execution.

< string > array

name
optional

Human-readable name of the activity.

string

startedAt
optional

Time when the activity started execution.

string (date-time)

status
optional

Current execution status of the activity.

ExecutionStatus

AddUserRequest

Request object for adding a user or a role to a cluster.

Name Description Schema

clusterCrn
required

Compute cluster CRN.

string

groups
optional

K8s RBAC cluster role bindings.

< string > array

id
required

User ID. Specify user email address for GCP, IAM user ARN for AWS, or Azure AD user object ID for Azure.

string

isAdmin
optional

True if added user is an admin.

boolean

isRole
optional

True if user ID is a role.

boolean

username
optional

Username.

string

AddUserResponse

Add user response.

Name Description Schema

id
optional

User email address for GCP, IAM user ARN for AWS, or Azure AD user object ID for Azure.

string

status
optional

User Status.

string

AksInstanceGroup

AKS instance group response structure.

Name Description Schema

availabilityZones
optional

Availability zones.

< integer (int32) > array

enableAutoScaling
optional

Enable auto scaling.

boolean

instanceCount
optional

Instance count.

integer (int64)

instanceGroupId
optional

Instance group ID.

string

instanceGroupName
optional

Instance group name.

string

instanceStates
optional

Instance states

CommonInstanceStateCounts

instanceTier
optional

Instance tier.

string

instanceType
optional

Instance type.

string

instances
optional

AKS pool instance.

< AksPoolInstance > array

isSystem
optional

True for a system node.

boolean

kubeReservedCpu
optional

Kube reserved CPU.

integer (int64)

kubeReservedMemory
optional

Kube reserved memory.

integer (int64)

kubeReservedStorage
optional

Kube reserved storage.

integer (int64)

labels
optional

Labels.

< string, string > map

maxInstance
optional

Max instances.

integer (int64)

minInstance
optional

Min instances.

integer (int64)

nodePool
optional

AKS node pool.

AksNodePool

nodeVolumeSize
optional

Node volume size.

integer (int64)

singleZone
optional

Single zone.

boolean

systemReservedCpu
optional

System reserved CPU.

integer (int64)

systemReservedMemory
optional

System reserved memory.

integer (int64)

systemReservedStorage
optional

System reserved storage.

integer (int64)

tags
optional

Tags.

< string, string > map

taints
optional

Taints.

< string, string > map

AksNodePool

AKS node pool response structure.

Name Description Schema

availabilityZones
optional

Availability zones.

< string > array

instances
optional

AKS pool instance.

< AksPoolInstance > array

name
optional

Name.

string

provisioningState
optional

Provisioning state.

string

type
optional

Type.

string

AksPoolInstance

AKS pool instance response structure.

Name Description Schema

availabilityZone
optional

Availability zone.

string

instanceId
optional

Instance ID.

string

name
optional

Name.

string

subnetId
optional

Subnet ID.

string

AksState

AKS state response structure.

Name Description Schema

adminUsername
optional

The username to use for Linux VMs.

string

aksManagedIdentity
optional

AksManagedIdentity is the user-assigned managed identity to be used by the AKS control plane.

string

clusterDisplayName
optional

Cluster display name.

string

clusterResourceGroup
optional

The Cluster ResourceGroup. Filled based on Parent ResourceGroup or ClusterDisplayName.

string

clusterResourceGroupCreated
optional

Specifies whether ClusterResourceGroup was created or not.

boolean

deployments
optional

Deployments.

CommonDeploymentsResp

dnsServiceIp
optional

An IP address assigned to the kubernetes DNS service, it must be within the kubernetes service address range specified in serviceCidr.

string

dockerBridgeCidr
optional

A CIDR notation IP range assigned to the Docker bridge network, it must not overlap with any Azure Subnet IP ranges or the kubernetes service address range.

string

egressType
optional

EgressType specifies the outbound type used by the cluster.

string

enableHttpApplicationRouting
optional

Specifies whether httpApplicationRouting addon is enabled or not.

boolean

enableMonitoring
optional

Specifies whether monitoring addon is enabled or not.

boolean

instanceGroups
optional

Instance groups.

< string, AksInstanceGroup > map

logAnalyticsWorkspace
optional

An existing Azure Log Analytics Workspace for monitoring addon.

string

logAnalyticsWorkspaceResourceGroup
optional

The resource group for the Azure Log Analytics Workspace.

string

masterDnsPrefix
optional

DNS prefix used for hostnames in the cluster.

string

networkCidrs
optional

The actual CIDR ranges of the virtual network.

< string > array

networkPlugin
optional

The plugin used for kubernetes network.

string

networkPolicy
optional

The policy used for kubernetes network.

string

oidcIssuerURL
optional

URL of the OIDCIssuer attached to the cluster.

string

parentResourceGroup
optional

The ResourceGroup which may be used for almost all the Azure resources created (with VirtualNetwork and Node ResourceGroup being exceptions).

string

podCidr
optional

A CIDR notation IP range from which to assign pod IPs when networkPlugin is using kubenet.

string

privateDnsZone
optional

PrivateDNSZone for the AKS cluster.

string

provider
optional

Cloud provider.

string

security
optional

Security.

CommonSecurityResp

selectedSubnet
optional

Selected Subnet from the list that is provided

string

serviceCidr
optional

A CIDR notation IP range from which to assign service cluster IPs, it must not overlap with any Azure Subnet IP ranges.

string

sshPublicKey
optional

The local path of the SSH configuration for Linux VMs, Opposite to sshPublicKeyContents.

string

sshPublicKeyContents
optional

The content of the SSH configuration for Linux VMs, Opposite to sshPublicKey.

string

subnets
optional

An array specifying existing Azure Virtual Subnets. Composite of agent virtual network subnet IDs.

< string > array

tags
optional

Tags.

< string, string > map

userData
optional

User data.

string

virtualNetwork
optional

An existing Azure Virtual Network. Composite of agent virtual network subnet ID.

string

virtualNetworkResourceGroup
optional

The resource group for the Azure Virtual Network. Composite of agent virtual network subnet ID.

string

workerEgressRules
optional

Egress rules for worker nodes.

< string > array

workerIngressRules
optional

Ingress rules for worker nodes.

< string > array

AppWorkflowDetail

Details of an application workflow.

Name Description Schema

activities
optional

Activities

< Activity > array

appCrn
optional

Application CRN.

string

domain
optional

Domain of workflow.

string

lastUpdateTime
optional

The last time the workflow status was updated.

string (date-time)

message
optional

Additional details regarding workflow status.

string

runId
optional

Cadence run ID.

string

startTime
optional

The start time of the workflow.

string (date-time)

taskList
optional

List of tasks for workflows.

string

workflowId
optional

Cadence workflow ID.

string

workflowName
optional

Name of the workflow.

string

workflowStatus
optional

Workflow status.

ExecutionStatus

AppWorkflowStatus

Status of an application workflow.

Name Description Schema

appCrn
optional

Application CRN.

string

lastUpdateTime
optional

The last time the workflow status was updated.

string (date-time)

message
optional

Additional details regarding workflow status.

string

startTime
optional

The start time of the workflow.

string (date-time)

workflowStatus
optional

Workflow status.

ExecutionStatus

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

AzureSecretEncryption

Azure Secret Encryption request structure.

Name Description Schema

encryptionKeyUrl
optional

Encryption key URI.

string

userManagedIdentity
optional

Resource ID of the user managed identity.

string

AzureSecretEncryptionResp

Azure Secret Encryption response structure.

Name Description Schema

encryptionKeyUrl
optional

Encryption key URI.

string

userManagedIdentity
optional

Resource ID of the user managed identity.

string

AzureVolumeEncryption

Azure Volume Encryption request structure.

Name Description Schema

diskEncryptionSetId
optional

Disk encryption set ID.

string

AzureVolumeEncryptionResp

Azure Volume Encryption response structure.

Name Description Schema

diskEncryptionSetId
optional

Disk encryption set ID.

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

CommonAlertmanagerResp

Alertmanager response structure.

Name Description Schema

enabled
optional

Flag to indicate if Alertmanager is enabled.

boolean

CommonApiServer

API server request structure.

Name Description Schema

authorizedIpRanges
optional

An array of IPv4 CIDR blocks.

< string > array

enabled
optional

Flag to enable whitelist of IP Ranges (CIDR block) for public access to the kubernetes API server.

boolean

CommonApiServerResp

API server response structure.

Name Description Schema

authorizedIpRanges
optional

An array of IPv4 CIDR blocks.

< string > array

enabled
optional

Flag to indicate if whitelist of IP Ranges (CIDR block) for public access to the kubernetes API server is enabled.

boolean

CommonAutoScaling

AutoScaling structure.

Name Description Schema

enabled
required

Enable flag.

boolean

maxInstance
required

Max instances.

integer (int64)

minInstance
required

Min instances.

integer (int64)

CommonAutoscaler

Autoscaler request structure.

Name Description Schema

maxGracefulTerminationSec
optional

Maximum number of seconds CA waits for pod termination when trying to scale down a node. (Azure Support).

integer (int64)

scaleDownDelayAfterAdd
optional

How long after scale up that scale down evaluation resumes. (Azure/AWS Support).

string

scaleDownDelayAfterDelete
optional

How long after node deletion that scale down evaluation resumes, defaults to scanInterval. (Azure/AWS Support).

string

scaleDownDelayAfterFailure
optional

How long after scale down failure that scale down evaluation resumes. (Azure/AWS Support).

string

scaleDownEnabled
optional

Scale down flag. (AWS Support).

boolean

scaleDownNonEmptyCandidatesCount
optional

Maximum number of non empty nodes considered in one iteration as candidates for scale down with drain. Lower value means better CA responsiveness but possible slower scale down latency. Higher value can affect CA performance with big clusters (100s of nodes). Set to non positive value to turn this heuristic off - CA will not limit the number of nodes it considers. (AWS Support).

integer (int32)

scaleDownUnneededTime
optional

How long a node should be unneeded before it is eligible for scale down. (Azure/AWS Support).

string

scaleDownUnreadyTime
optional

How long an unready node should be unneeded before it is eligible for scale down. (Azure Support).

string

scaleDownUtilizationThreshold
optional

Node utilization level, defined as the sum of requested resources divided by capacity,. below which a node can be considered for scale down. (Azure/AWS Support).

number (double)

scanInterval
optional

Scan interval. (Azure/AWS Support).

string

skipNodesWithLocalStorage
optional

Skip nodes with local storage flag. (AWS Support).

boolean

skipNodesWithSystemPods
optional

Skip nodes with system pods. (AWS Support).

boolean

CommonAutoscalerResp

Autoscaler response structure.

Name Description Schema

maxGracefulTerminationSec
optional

Maximum number of seconds CA waits for pod termination when trying to scale down a node. (Azure Support).

integer (int64)

scaleDownDelayAfterAdd
optional

How long after scale up that scale down evaluation resumes. (Azure/AWS Support).

string

scaleDownDelayAfterDelete
optional

How long after node deletion that scale down evaluation resumes, defaults to scanInterval. (Azure/AWS Support).

string

scaleDownDelayAfterFailure
optional

How long after scale down failure that scale down evaluation resumes. (Azure/AWS Support).

string

scaleDownEnabled
optional

Scale down flag. (AWS Support).

boolean

scaleDownNonEmptyCandidatesCount
optional

Maximum number of non empty nodes considered in one iteration as candidates for scale down with drain. Lower value means better CA responsiveness but possible slower scale down latency. Higher value can affect CA performance with big clusters (100s of nodes). Set to non positive value to turn this heuristic off - CA will not limit the number of nodes it considers. (AWS Support).

integer (int32)

scaleDownUnneededTime
optional

How long a node should be unneeded before it is eligible for scale down. (Azure/AWS Support).

string

scaleDownUnreadyTime
optional

How long an unready node should be unneeded before it is eligible for scale down. (Azure Support).

string

scaleDownUtilizationThreshold
optional

Node utilization level, defined as the sum of requested resources divided by capacity,. below which a node can be considered for scale down. (Azure/AWS Support).

number (double)

scanInterval
optional

Scan interval. (Azure/AWS Support).

string

skipNodesWithLocalStorage
optional

Skip nodes with local storage flag. (AWS Support).

boolean

skipNodesWithSystemPods
optional

Skip nodes with system pods. (AWS Support).

boolean

CommonDeploymentProfileDetailsResp

Deployment Profile details response structure.

Name Description Schema

deploymentProfile
optional

Deployment profile used. Currently supported is common.

string

enabled
optional

Deployment enable flag.

boolean

CommonDeploymentsResp

Deployments response structure.

Name Description Schema

autoscaler
optional

Autoscaler specs.

CommonAutoscalerResp

horizontalPodAutoscaler
optional

Horizontal pod autoscaler specs.

CommonHorizontalPodAutoScalerResp

istio
optional

Istio specs.

CommonDeploymentProfileDetailsResp

knox
optional

Knox specs.

CommonDeploymentProfileDetailsResp

logging
optional

Logging specs.

CommonLoggingResp

metering
optional

Metering specs.

CommonMeteringResp

monitoring
optional

Monitoring specs.

CommonMonitoringResp

nvidia
optional

Nvidia specs.

CommonNvidiaResp

repository
optional

Repository for images.

string

telemetryKmsKeyArn
optional

Telemetry KMS key ARN.

string

yunikorn
optional

Yunikorn specs.

CommonYuniKornResp

CommonEvent

Event response structure.

Name Description Schema

details
optional

Details.

string

name
optional

Event name.

string

progress
optional

Progress.

string

resourceType
optional

Resource type.

string

status
optional

Status.

string

statusReason
optional

Status reason.

string

timestamp
optional

Timestamp.

string

CommonHelm

Helm structure.

Name Description Schema

version
optional

Helm version to be upgraded to.

string

CommonHorizontalPodAutoScalerResp

Horizontal pod autoscaler response structure.

Name Description Schema

enabled
optional

Enable flag.

boolean

CommonImageCatalog

Image catalog request 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

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

CommonInstanceGroup

Instance group structure.

Name Description Schema

autoscaling
optional

Autoscaling specs.

CommonAutoScaling

instanceCount
optional

Instance count.

integer (int64)

instanceTier
optional

Instance tier.

string

instanceTypes
optional

Instance types. General purpose: M4, M5, M5a, M5ad, and M5d. Compute optimized: C3, C4, C5, C5d, C5n, and cc2.8xlarge. Memory optimized: cr1.8xlarge, R3, R4, R5, R5a, R5ad, R5d, X1, X1e, and z1d. Storage optimized: D2, H1, hs1.8xlarge, I2, I3, and I3en. Accelerated computing: F1, G2, G3, P2, and P3.

< string > array

labels
optional

Labels.

< string, string > map

name
required

Name.

string

rootVolume
optional

Root volume specs. Recommended 50.

CommonRootVolume

singleZone
optional

Use single availability zone. Simple boolean for EKS. AKS is used in conjunction with UseAvailabilityZones.

boolean

taints
optional

Taints.

< string, string > map

useAvailabilityZones
optional

Used for Azure clusters only.

boolean

CommonInstanceRequirementsResp

Instance requirements structure.

Name Description Schema

acceleratorConfig
optional

Accelerator Config for AWS.

AcceleratorConfigResp

allowedInstanceTypes
optional

Instance types to include.

< string > array

cpuTypes
optional

CPU types required. For eg. intel, amd, amazon-web-services etc.

< string > array

excludedInstanceTypes
optional

Instance types to exclude, ignored if AllowedInstanceTypes is set.

< string > array

maxCpu
optional

Maximum vCpu count.

integer (int64)

maxMemory
optional

Maximum memory requirement in MiB.

integer (int64)

minCpu
optional

Minimum vCpu count.

integer (int64)

minMemory
optional

Minimum memory requirement in MiB.

integer (int64)

CommonInstanceRequirementsWithMetadataResp

Instance requirements with metadata response structure.

Name Description Schema

architectureTypes
optional

The architecture types. For eg, i386, x86_64, arm64, x86_64_mac, arm64_mac.

< string > array

instanceRequirements
optional

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

CommonInstanceRequirementsResp

virtualizationTypes
optional

The virtualization types. For eg. hvm, paravirtual.

< string > array

CommonInstanceStateCounts

Instance state counts response structure.

Name Description Schema

creating
optional

Number of instances in creating state.

integer (int64)

running
optional

Number of instances in running state.

integer (int64)

terminating
optional

Number of instances in terminating state.

integer (int64)

total
optional

Total number of instances.

integer (int64)

CommonLoggingResp

Logging response structure.

Name Description Schema

enabled
optional

True to enable logging installation (default false).

boolean

CommonMeteringResp

Metering response structure.

Name Description Schema

enabled
optional

Flag to indicate if Monitoring is enabled.

boolean

services
optional

Array of services.

< CommonMeteringServiceResp > array

CommonMeteringServiceResp

Metering service response structure.

Name Description Schema

clusterCrn
optional

Cluster CRN.

string

serviceConfiguration
optional

Service configuration.

string

serviceType
optional

Service type.

string

serviceVersion
optional

Service version.

string

workloadCrn
optional

Workload CRN.

string

CommonMonitoringResp

Monitoring response structure.

Name Description Schema

alertmanager
optional

Alertmanager.

CommonAlertmanagerResp

enabled
optional

Flag to indicate if Monitoring is enabled.

boolean

serverResourceLimits
optional

Server resource limits.

CommonResourceLimitsResp

CommonNetwork

Network structure.

Name Description Schema

outboundType
optional

Cluster outbound type. Currently supported is udr.

string

podCidr
optional

The pod CIDR to use if the backend provider supports setting this.

string

serviceCidr
optional

The CIDR for services declared inside of Kubernetes if the backend provider supports setting this.

string

subnets
optional

Subnets.

< string > array

CommonNodeImageAvailableUpgrade

Structure to list the currently used images and the new upgrades available.

Name Description Schema

current
optional

Currently used node image version.

string

instanceGroup
optional

Instance group name.

string

upgrades
optional

Available node image upgrade versions.

< string > array

CommonNvidiaResp

Nvidia response structure.

Name Description Schema

gpuLabelKey
optional

GPU label key.

string

gpuLabelValue
optional

GPU label value.

string

CommonResourceLimitsResp

Resource limits response structure.

Name Description Schema

cpu
optional

Prometheus server CPU limit (default 1000m).

string

memory
optional

Prometheus server memory limit (default 2048M).

string

CommonRootVolume

Root volume structure.

Name Description Schema

size
optional

Root volume size.

integer (int64)

CommonSecretEncryption

Secret encryption request structure.

Name Description Schema

azure
optional

Azure secret encryption details.

AzureSecretEncryption

customerKmsKeyArn
optional

AWS KMS key ARN.

string

CommonSecretEncryptionResp

Secret Encryption response structure.

Name Description Schema

azure
optional

Azure secret encryption details.

AzureSecretEncryptionResp

customerKmsKeyArn
optional

AWS KMS key ARN.

string

CommonSecurity

Security request structure.

Name Description Schema

apiServer
optional

API server.

CommonApiServer

private
optional

Flag set to true for a private cluster with API Server having internal IP addressees.

boolean

secretEncryption
optional

Secret encryption.

CommonSecretEncryption

volumeEncryption
optional

Volume encryption.

CommonVolumeEncryption

CommonSecurityResp

Security response structure.

Name Description Schema

apiServer
optional

API server.

CommonApiServerResp

private
optional

Flag to indicate if this is a private cluster with API Server having internal IP addressees.

boolean

secretEncryption
optional

Secret encryption.

CommonSecretEncryptionResp

volumeEncryption
optional

Volume encryption.

CommonVolumeEncryptionResp

CommonStatusMessage

Cluster status structure.

Name Description Schema

message
optional

Message.

string

status
optional

Status.

string

CommonStorageSpec

Storage spec request structure.

Name Description Schema

csiEnabled
optional

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

boolean

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

CommonUpdateClusterDeployments

Update cluster deployments structure.

Name Description Schema

autoscaler
optional

Autoscaler.

CommonAutoscaler

CommonUpdateClusterMetadata

Update cluster metadata structure.

Name Description Schema

description
optional

Description of compute cluster update.

string

CommonUpdateClusterSpec

Compute cluster update spec.

Name Description Schema

deployments
optional

Update deployments on the compute cluster.

CommonUpdateClusterDeployments

helm
optional

Update Helm on compute the compute cluster.

CommonHelm

imageCatalog
optional

Update image catalog for the compute cluster.

CommonImageCatalog

refreshInstanceGroups
optional

Whether to refresh nodes of instance groups belonging to the compute cluster.

boolean

security
optional

Update security settings for the compute cluster.

CommonSecurity

storage
optional

Update storage settings for the compute cluster.

CommonStorageSpec

CommonVolumeEncryption

Volume encryption request structure.

Name Description Schema

azure
optional

Azure volume encryption details.

AzureVolumeEncryption

customerKmsKeyArn
optional

The KMS key ARN used.

string

CommonVolumeEncryptionResp

Volume encryption response structure.

Name Description Schema

azure
optional

Azure volume encryption details.

AzureVolumeEncryptionResp

customerKmsKeyArn
optional

AWS KMS key ARN.

string

CommonYuniKornResp

YuniKorn response structure.

Name Description Schema

appSortingPolicy
optional

The app sorting policy. Deprecated.

string

enabled
optional

Flag to indicate if yunikorn is enabled.

boolean

nodeSortingPolicy
optional

The node sorting policy. Deprecated.

string

version
optional

Version. Deprecated.

string

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. Shared - Value representing a shared compute cluster. DedicatedExternal - Value representing an external dedicated compute cluster. Dedicated - Value representing an embedded dedicated compute cluster.

Type : enum (Shared, DedicatedExternal, Dedicated)

ComputePlatform

Object representing Cloudera Compute Cluster Platform provider. OPENSHIFT - OpenShift Container Platform cluster as compute platform (Cloudera on-premises only). EKS - EKS cluster as compute platform AKS - AKS cluster as compute platform RKE - Rancher RKE as compute platform (Cloudera on-premises only). GKE - GKE cluster as compute platform OCP - OCP Container Platform cluster as compute platform (Cloudera on-premises only). KCLOUD - KCLOUD cluster as compute platform (Cloudera on-premises only). STANDARD - STANDARD cluster as compute platform (Cloudera on-premises only).

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

CreateClusterRequest

Request object for creating a cluster.

Name Description Schema

description
optional

Cluster description.

string

environment
required

Environment CRN. Required.

string

name
required

Cluster name. Required.

string

network
optional

Network.

CommonNetwork

skipValidation
optional

Skip validation.

boolean

tags
optional

Cluster level tags.

< string, string > map

CreateClusterResponse

Create cluster response.

Name Description Schema

clusterCrn
optional

Compute cluster CRN.

string

clusterId
optional

Compute cluster ID.

string

clusterStatus
optional

Cluster status.

CommonStatusMessage

uri
optional

Uniform Resource Identifier of cluster.

string

validationResponse
optional

Pre-flight validation check response. Only given on a validation failure.

ValidationResponse

DeleteClusterRequest

Request object for deleting a cluster.

Name Description Schema

clusterCrn
required

Compute cluster CRN.

string

force
optional

Forces the cluster into the DELETED state without cleaning up resources; only valid if cluster is in DELETE_FAILED state.

boolean

skipValidation
optional

Whether to skip validation.

boolean

skipWorkloadsValidation
optional

Whether to skip the running workloads validation for externalized clusters

boolean

DeleteClusterResponse

Delete cluster response.

Name Description Schema

clusterStatus
optional

Cluster Status.

CommonStatusMessage

validationResponse
optional

Pre-flight validation check response. Only given on a validation failure.

ValidationResponse

DeleteDeploymentRequest

Request structure for deleting 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

DeleteDeploymentResponse

Response structure for deleting a deployment.

Name Description Schema

message
optional

A message returned about the status of the delete operation.

string

DeleteUserRequest

Request object for deleting a user from a cluster.

Name Description Schema

clusterCrn
required

Compute cluster CRN.

string

id
required

User email address for GCP, IAM user ARN for AWS, or Azure AD user object ID for Azure.

string

DeleteUserResponse

Delete user response.

Name Description Schema

id
optional

User email address for GCP, IAM user ARN for AWS, or Azure AD user object ID for Azure.

string

status
optional

User Status.

string

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

DescribeClusterRequest

Request object for describing a cluster.

Name Description Schema

clusterCrn
required

Compute cluster CRN.

string

DescribeClusterResponse

Describe cluster response.

Name Description Schema

account
optional

CDP account ID.

string

aks
optional

AKS state.

AksState

apiEndPoint
optional

API endpoint.

string

availableUpgrades
optional

List of available kubernetes upgrades.

< string > array

bootstrapScript
optional

Bootstrap script used to setup this cluster.

string

clusterCrn
optional

Compute cluster CRN.

string

clusterId
optional

Compute cluster ID.

string

clusterName
optional

Compute cluster name.

string

clusterOwner
optional

Cluster owner.

ComputeClusterOwner

clusterShape
optional

The clusterShape represents the shape of the cluster, which can be "Embedded" or "Externalized".

string

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

dashboardUrl
optional

Compute cluster platform dashboard url.

string

deletionTime
optional

Compute cluster deletion time in ISO format.

string

description
optional

Description about the cluster.

string

eks
optional

EKS state.

EksState

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

isClouderaManaged
optional

Is compute cluster cloudera managed or not.

boolean

isDefault
optional

The cluster which is automatically created for every containerized environment.

boolean

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

nodeImageUpgradeAvailable
optional

Is a node image upgrade available.

boolean

nodeImageUpgrades
optional

Lists the currently used images and the new upgrades available.

< CommonNodeImageAvailableUpgrade > array

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

workloads
optional

Workloads.

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

DescribeUserRequest

Request object for describing a user of a cluster.

Name Description Schema

clusterCrn
required

Compute cluster CRN.

string

id
required

User email address for GCP, IAM user ARN for AWS, or Azure AD user object ID for Azure.

string

DescribeUserResponse

Describe user response.

Name Description Schema

user
optional

User details.

User

EksInstance

EKS instance response structure.

Name Description Schema

availabilityZone
optional

Availability zone.

string

instanceId
optional

Instance ID.

string

subnetId
optional

Subnet ID.

string

EksInstanceGroup

EKS instance group response structure.

Name Description Schema

ami
optional

AMI.

string

autoscalingEnabled
optional

Autoscaling enabled.

boolean

enableCfsQuota
optional

Enable cfs quota.

boolean

events
optional

Events.

< CommonEvent > array

imageParam
optional

Image param.

string

imdsVersions
optional

IMDS versions.

< string > array

instanceCount
optional

Instance count.

integer (int64)

instanceGroupId
optional

Instance group ID.

string

instanceGroupName
optional

Instance group name.

string

instanceGroupStatus
optional

Instance group status.

string

instanceProfile
optional

Instance profile name.

string

instanceRequirementswithMetadata
optional

Instance requirements.

CommonInstanceRequirementsWithMetadataResp

instanceStates
optional

Instance states

CommonInstanceStateCounts

instanceTier
optional

Instance tier.

string

instanceTypes
optional

Instance types.

< string > array

instances
optional

EKS Instance.

< EksInstance > array

kubeReservedCpu
optional

Kube reserved CPU.

integer (int64)

kubeReservedMemory
optional

Kube reserved memory.

integer (int64)

kubeReservedStorage
optional

Kube reserved storage.

integer (int64)

lTNameSuffix
optional

Launch Template name suffix.

string

labels
optional

Labels.

< string, string > map

maxInstance
optional

Max instances.

integer (int64)

minInstance
optional

Min instances.

integer (int64)

nodeInstanceRole
optional

Node instance role.

string

nodeVolumeSize
optional

Node volume size.

integer (int64)

singleZone
optional

Single zone.

boolean

systemReservedCpu
optional

System reserved CPU.

integer (int64)

systemReservedMemory
optional

System reserved memory.

integer (int64)

systemReservedStorage
optional

System reserved storage.

integer (int64)

tags
optional

Tags.

< string, string > map

taints
optional

Taints.

< string, string > map

EksState

EKS state response structure.

Name Description Schema

associateWorkerNodePublicIp
optional

Associate worker node public IP.

boolean

clusterDisplayName
optional

Cluster display name.

string

csiEnabled
optional

Whether CSI is enabled.

boolean

deployments
optional

Deployments.

CommonDeploymentsResp

existingVirtualNetwork
optional

Existing virtual network if used.

boolean

inboundProxyCidrs
optional

Array of inbound proxy CIDRs.

< string > array

instanceGroups
optional

Instance groups.

< string, EksInstanceGroup > map

kmsKeyArn
optional

KMS key ARN.

string

networkPlugin
optional

Network plugin.

string

provider
optional

Provider.

string

security
optional

Security.

CommonSecurityResp

securityGroups
optional

Security groups.

< string > array

serviceCidr
optional

Service CIDR.

string

serviceRole
optional

Service role.

string

sshKeyPairName
optional

SSH key pair name.

string

sshPublicKey
optional

SSH public key.

string

subnets
optional

Subnets.

< string > array

suspendedProcesses
optional

Suspended processes.

< string > array

tags
optional

Tags.

< string, string > map

telemetryEnabled
optional

Telemetry enabled.

boolean

telemetryKmsKeyArn
optional

Telemetry logging root dir.

string

telemetryLoggingBucket
optional

Telemetry logging bucket.

string

telemetryLoggingEnabled
optional

Telemetry logging enabled.

boolean

telemetryLoggingRootDir
optional

Telemetry logging root dir.

string

telemetryLoggingStorageLocation
optional

Telemetry logging storage location.

string

userData
optional

User data for this cluster.

string

virtualNetwork
optional

Virtual network details.

string

vpcCidr
optional

VPC CIDR.

string

workerEgressRules
optional

Egress rules for worker nodes.

< string > array

workerIngressRules
optional

Ingress rules for worker nodes.

< string > array

workerInstanceProfile
optional

Worker instance profile.

string

workerSecurityGroup
optional

Worker security group.

string

workerSubnets
optional

Worker subnets.

< string > array

EnvCloudProvider

Object representing cloud provider type for Cloudera environment. AWS - Cloudera environment installed in AWS. AZURE - Cloudera environment installed in Azure. OPENSHIFT - Cloudera environment installed as on-premises installation using OpenShift in the base cluster. GCP - Cloudera environment installed in GCP. REDHAT - Cloudera environment installed as an on-premises deployment using Red Hat infrastructure. KCLOUD - Cloudera environment installed as an on-premises deployment using KCLOUD infrastructure. STANDARD - Cloudera environment installed as a generic on-premises deployment using CDP Data services.

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

ExecutionStatus

Defines the execution status of an operation, workflow or activity. UNKNOWN - The execution status is unknown. RUNNING - The execution is currently running. COMPLETED - The execution has completed successfully. FAILED - The execution has failed. CANCELLED - The execution has been cancelled. TIMED_OUT - The execution has timed out.

Type : enum (UNKNOWN, RUNNING, COMPLETED, FAILED, CANCELLED, TIMED_OUT)

GetKubeConfigRequest

Request object for getting kube config of a cluster.

Name Description Schema

clusterCrn
required

Compute cluster CRN.

string

proxy
optional

Gets a kube config with a proxy as the kubernetes API server.

boolean

GetKubeConfigResponse

Get kube config response.

Name Description Schema

content
optional

Kube config in the content field.

string

GetOperationDetailsRequest

Represents a request to get the details of an operation.

Name Description Schema

operationId
optional

The unique ID of the operation to query.

string

runId
optional

Cadence run ID.

string

GetOperationDetailsResponse

Represents the response containing the details of an operation.

Name Description Schema

activities
optional

Activities

< Activity > array

clusterCrn
optional

The CRN of the cluster associated with the operation.

string

lastUpdateTime
optional

The last time the operation status was updated.

string (date-time)

message
optional

Additional details regarding operation status.

string

operationId
optional

The unique ID of the operation.

string

operationOwner
optional

Details of operation owner.

OperationOwner

operationStatus
optional

The current status of the operation.

ExecutionStatus

phaseWorkflowDetails
optional

Details of workflow phases.

< PhaseWorkflowDetail > array

retryCount
optional

Number of retires attempted. Its value is 0 for first operation.

integer (int32)

runId
optional

Cadence run ID.

string

startTime
optional

The start time of the operation.

string (date-time)

workflowId
optional

Cadence workflow ID.

string

workflowOperation
optional

The type of workflow for this operation.

WorkflowOperation

GetOperationStatusRequest

Represents a request to get the status of an operation.

Name Description Schema

operationId
required

The unique ID of the operation to query.

string

GetOperationStatusResponse

Represents the response containing the status of an operation.

Name Description Schema

clusterCrn
optional

The CRN of the cluster associated with the operation.

string

lastUpdateTime
optional

The last time the operation status was updated.

string (date-time)

message
optional

Additional details regarding operation status.

string

operationId
optional

The unique ID of the operation.

string

operationStatus
optional

The current status of the operation.

ExecutionStatus

phaseWorkflowStatuses
optional

Status of workflow phases.

< PhaseWorkflowStatus > array

runId
optional

Cadence run ID.

string

startTime
optional

The start time of the operation.

string (date-time)

workflowId
optional

Cadence workflow ID.

string

workflowOperation
optional

The type of workflow for this operation.

WorkflowOperation

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

InstallDeploymentRequest

Request structure for installing a deployment.

Name Description Schema

chartName
required

The name of the chart to install.

string

chartVersion
optional

The version of the chart to install. Defaults to latest version.

string

clusterCrn
required

Compute cluster CRN.

string

deploymentProfile
optional

Deployment profile to use. Currently supported are cml and cde.

string

forceChartVersion
optional

If true, will bypass validation for chart version and Kubernetes version.

boolean

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

timeout
optional

The amount of time, in seconds, to wait before returning a timeout.

integer (int32)

InstallDeploymentResponse

Response structure for installing a deployment.

Name Description Schema

chart
optional

Chart that the deployment was created from.

Chart

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

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

clusterShape
optional

The clusterShape represents the shape of the cluster, which can be "Embedded" or "Externalized".

string

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

isDefault
optional

The cluster which is automatically created for every containerized environment.

boolean

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

clusterShape
optional

Filter between Externalized and Embedded cluster shapes.

string

default
optional

Only show default clusters.

boolean

envNameOrCrn
optional

Environment name or crn.

string

includeDeleted
optional

Include deleted clusters in the response.

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)

ListDeploymentsRequest

Request structure to list deployments in the cluster.

Name Description Schema

clusterCrn
required

Compute cluster CRN.

string

namespace
optional

The namespace of the deployment. Lists deployments in all namespaces if not specified.

string

verbose
optional

Set true to get detailed chart response. Default is false.

boolean

ListDeploymentsResponse

Response structure to list deployments in the cluster.

Name Description Schema

availableCharts
optional

Array of available charts.

< Chart > array

installedDeployments
optional

Array of installed deployments.

< Deployment > array

unavailableCharts
optional

Array of unavailable charts.

< Chart > array

ListOperationsRequest

Represents a request to list the operations of a cluster.

Name Description Schema

clusterCrn
required

The CRN of the compute cluster.

string

operationStatuses
optional

A list of Operation Status.

< ExecutionStatus > array

pageSize
optional

Maximum number of operations to return. Default is 100.
Default : 100
Minimum value : 1
Maximum value : 500

integer (int32)

pageToken
optional

Token for fetching the next page of results. This is the nextToken from a previously truncated response. 1 or empty for first page.

string

workflowOperation
optional

The type of workflow for this operation.

WorkflowOperation

workflowPhase
optional

Workflow phase.

WorkflowPhase

ListOperationsResponse

Represents a response to list the operations of a cluster.

Name Description Schema

nextPageToken
optional

Token for fetching the next page of results. If not present, there are no additional results.

string

operationItems
optional

List of operations.

< OperationItem > array

ListUsersRequest

Request object to list users of a cluster.

Name Description Schema

clusterCrn
required

Compute cluster CRN.

string

onlyAdmins
optional

Set true to list only admin users.

boolean

ListUsersResponse

List users response.

Name Description Schema

users
optional

List of Users.

< User > array

OperationItem

Operation item structure.

Name Description Schema

clusterCrn
optional

The CRN of the cluster associated with the operation.

string

lastUpdateTime
optional

The last time the operation status was updated.

string (date-time)

message
optional

Additional details regarding operation status.

string

operationId
optional

The unique ID of the operation.

string

operationStatus
optional

The current status of the operation.

ExecutionStatus

retryCount
optional

Number of retires attempted. Its value is 0 for first operation.

integer (int32)

startTime
optional

The start time of the operation.

string (date-time)

workflowOperation
optional

The type of workflow for this operation.

WorkflowOperation

OperationOwner

Operation owner structure.

Name Description Schema

accountId
optional

Owner’s account ID.

string

crn
optional

Owner’s actor CRN.

string

userId
optional

Owner’s user ID.

string

PhaseWorkflowDetail

Details of phase workflow.

Name Description Schema

activities
optional

Activities

< Activity > array

appWorkflowDetails
optional

Details of application workflow.

< AppWorkflowDetail > array

lastUpdateTime
optional

The last time the workflow status was updated.

string (date-time)

message
optional

Additional details regarding workflow status.

string

runId
optional

Cadence run ID.

string

startTime
optional

The start time of the workflow.

string (date-time)

workflowId
optional

Cadence workflow ID.

string

workflowPhase
optional

Workflow phase.

WorkflowPhase

workflowStatus
optional

Workflow status.

ExecutionStatus

PhaseWorkflowStatus

Status of phase workflow.

Name Description Schema

appWorkflowStatuses
optional

Status of application workflow.

< AppWorkflowStatus > array

lastUpdateTime
optional

The last time the workflow status was updated.

string (date-time)

message
optional

Additional details regarding workflow status.

string

startTime
optional

The start time of the workflow.

string (date-time)

workflowPhase
optional

Workflow phase.

WorkflowPhase

workflowStatus
optional

Workflow status.

ExecutionStatus

ResumeClusterRequest

Request structure to resume the compute cluster

Name Description Schema

clusterCrn
required

Compute cluster CRN.

string

skipValidation
optional

Whether to skip validation.

boolean

ResumeClusterResponse

Response structure for resuming the compute cluster

Name Description Schema

clusterStatus
optional

Cluster status.

CommonStatusMessage

validationResponse
optional

Pre-flight validation check response. Only given on a validation failure and skipValidation is false.

ValidationResponse

RetryOperationRequest

Represents a request to structure of retry operation.

Name Description Schema

operationId
optional

The unique ID of the operation to retry.

string

RetryOperationResponse

Represents a response to structure of retry operation.

Name Description Schema

operationId
optional

The unique ID of the retried operation.

string

RollbackDeploymentRequest

Request structure to rollback 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

revision
optional

The revision of the deployment to rollback to. Defaults to previous revision.

integer (int32)

RollbackDeploymentResponse

Response structure to rollback a deployment.

Name Description Schema

message
optional

A message returned about the status of the rollback operation.

string

SuspendClusterRequest

Request structure to suspend the compute cluster

Name Description Schema

clusterCrn
required

Compute cluster CRN.

string

skipValidation
optional

Whether to skip validation.

boolean

skipWorkloadsValidation
optional

Whether to skip the running workloads validation for externalized clusters

boolean

SuspendClusterResponse

Response structure for suspending the compute cluster

Name Description Schema

clusterStatus
optional

Cluster status.

CommonStatusMessage

validationResponse
optional

Pre-flight validation check response. Only given on a validation failure and skipValidation is false.

ValidationResponse

UpdateClusterRequest

Update compute cluster request.

Name Description Schema

clusterCrn
required

Compute Cluster CRN.

string

clusterStateVersion
required

Current cluster state version of the compute cluster being updated.

integer (int64)

metadata
optional

Compute cluster update metadata.

CommonUpdateClusterMetadata

skipValidation
optional

Whether to skip validation.

boolean

spec
required

Spec for updating compute cluster.

CommonUpdateClusterSpec

UpdateClusterResponse

Update compute cluster response.

Name Description Schema

clusterCrn
optional

Compute cluster CRN.

string

clusterStatus
optional

Status of the compute cluster.

CommonStatusMessage

uri
optional

Uniform resource identifier of the compute cluster.

string

validationResponse
optional

Pre-flight validation check response. Only given on a validation failure and skipValidation is false.

ValidationResponse

UpdateInstanceGroupRequest

Request object for updating an instance group.

Name Description Schema

clusterCrn
required

Compute cluster CRN.

string

clusterStateVersion
required

Cluster state version.

integer (int64)

instanceGroup
required

Instance group to be updated in the cluster.

CommonInstanceGroup

skipValidation
optional

Whether to skip validation.

boolean

UpdateInstanceGroupResponse

Update instance group response.

Name Description Schema

clusterCrn
optional

Compute cluster CRN.

string

clusterStatus
optional

Cluster status.

CommonStatusMessage

uri
optional

Uniform resource identifier of cluster.

string

validationResponse
optional

Pre-flight validation check response. Only given on a validation failure and skipValidation is false.

ValidationResponse

UpgradeClusterRequest

Request structure to upgrade the cluster kubernetes version.

Name Description Schema

clusterCrn
required

Compute cluster CRN.

string

dryRun
optional

Flag to only run validations.

boolean

UpgradeClusterResponse

Response structure for upgrading the cluster kubernetes version.

Name Description Schema

operationId
optional

The unique ID of the initiated long running upgrade operation.

string

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

User

User details.

Name Description Schema

groups
optional

K8s RBAC cluster role bindings.

< string > array

id
optional

User email address for GCP, IAM user ARN for AWS, or Azure AD user object ID for Azure.

string

isAdmin
optional

True if added user is an admin.

boolean

isRole
optional

True if user ID is a role.

boolean

username
optional

Username.

string

ValidateClusterRequest

Request object for validating a cluster.

Name Description Schema

description
optional

Cluster description.

string

environment
required

Environment CRN. Required.

string

name
required

Cluster name. Required.

string

network
optional

Network.

CommonNetwork

tags
optional

Cluster level tags.

< string, string > map

ValidateClusterResponse

Validate cluster response.

Name Description Schema

message
optional

A message describing the end result of the validations.

string

result
optional

Validation result.

string

summary
optional

Numerical summary of the validations.

ValidationSummary

validations
optional

The list of detailed validation results.

< ValidationResult > array

ValidationResponse

Pre-flight validation check response structure.

Name Description Schema

message
optional

A message describing end result of the validations.

string

result
optional

Validation result.

string

summary
optional

Numerical summary of the validations.

ValidationSummary

validations
optional

The list of detailed validation result.

< ValidationResult > array

ValidationResult

Validation result structure.

Name Description Schema

category
optional

Validation check categories such as COMMON, ENTITLEMENTS, CONTROL_PLANE, NETWORK, or DEPLOYMENT. New values may be added in the future.

string

description
optional

Description.

string

detailedMessage
optional

A supporting message which contains additional details, such as subnet names, instance types, etc.

string

duration
optional

Time taken to get the end result of the validation in a human-readable time format.

string

message
optional

A short, human-readable message that describes the end result of the validation.

string

name
optional

Name.

string

status
optional

Validation check status such as PASSED, FAILED, or SKIPPED. New values may be added in the future.

string

ValidationSummary

Validation summary structure.

Name Description Schema

failed
optional

Total number of failed validations.

integer (int32)

passed
optional

Total number of passed validations.

integer (int32)

skipped
optional

Total number of skipped validations.

integer (int32)

total
optional

Total number of validations.

integer (int32)

warning
optional

Total number of validations that passed but have warnings associated with them.

integer (int32)

WorkflowOperation

Defines the type of workflow operation. UNKNOWN - The operation is unknown. UPGRADE - Represents an upgrade operation. SUSPEND - Represents a suspend operation. RESUME - Represents a resume operation. UPDATE - Represents an update operation.

Type : enum (UNKNOWN, UPGRADE, SUSPEND, RESUME, UPDATE)

WorkflowPhase

Defines the workflow phases of an operation. UNKNOWN - The workflow phase of operation is unknown. VALIDATE - The operation is in validation workflow phase. PREPARE - The operation is in preparation workflow phase. EXECUTE - The operation is in execution workflow phase. FINALIZE - The operation is in finalization workflow phase.

Type : enum (UNKNOWN, VALIDATE, PREPARE, EXECUTE, FINALIZE)


Copyright © 2026 Cloudera, Inc. All rights reserved.