Overview

Applications is a web service for managing application lifecycle.

Version information

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

Create Application

POST /api/v1/applications/createApplication

Description

Creates an application.

Parameters

Type Name Schema

Body

input
required

CreateApplicationRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

CreateApplicationResponse

default

The default response on an error.

Error

Delete Application

POST /api/v1/applications/deleteApplication

Description

Deletes an application.

Parameters

Type Name Schema

Body

input
required

DeleteApplicationRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DeleteApplicationResponse

default

The default response on an error.

Error

Describe Application

POST /api/v1/applications/describeApplication

Description

Describes an application.

Parameters

Type Name Schema

Body

input
required

DescribeApplicationRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeApplicationResponse

default

The default response on an error.

Error

List of Applications

POST /api/v1/applications/listApplications

Description

Provides a list of applications.

Parameters

Type Name Schema

Body

input
required

ListApplicationsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListApplicationsResponse

default

The default response on an error.

Error

Definitions

ApplicationHealthStatus

Health status of an Application. HEALTHY - Application is in a Healthy status. UNHEALTHY - Application is in an Unhealthy status. UNKNOWN - Application is in an Unknown status

Type : enum (HEALTHY, UNHEALTHY, UNKNOWN)

ApplicationInfo

Details of an application.

Name Description Schema

actualState
optional

The actual state of the application.

ApplicationState

applicationCrn
optional

The CRN of application.

string

applicationSpotPolicy
optional

Spot instance policy of an application.

ApplicationSpotPolicy

applicationVersion
optional

The version of the installed application.

string

clusterCrn
optional

The compute cluster used by the application.

string

desiredState
optional

The desired state of the application.

ApplicationState

environmentCrn
optional

The Environment CRN for the application.

string

environmentName
optional

The Environment name for the application.

string

name
optional

The name of application.

string

size
optional

The size of the application refers to the specific amount of resources, such as CPU, memory, GPU and storage, that are allocated and guaranteed for that instance. Example Values: TINY,SMALL, LARGE, XLARGE, etc

string

status
optional

The health status of the application.

ApplicationHealthStatus

tags
optional

Tags to added to the cloud provider resources created.

< string, string > map

type
optional

The type of application.

ApplicationType

ApplicationSpotPolicy

Application policy for using spot tier in public cloud DEFAULT - By default application infra services and workload master would run on on-demand instances and the application workload executor will run on spot instances. WORKLOAD - WORKLOAD will run all application workloads including workload master (driver) on spot instamces. NONE - NONE will run all application services on on-demand instances. ALL - ALL will run all application services on spot instances.

Type : enum (DEFAULT, WORKLOAD, NONE)

ApplicationState

Health state of an Application. INFRA_PROVISIONING - Application is provisioning and configuring required infra. INFRA_PROVISIONED - Underlying infra has been provisioned and configured. INFRA_PROVISIONING_FAILED - Underlying infra has been provisioned and configured. STARTING - Application is starting. STARTED - Application has started. STARTING_FAILED - Application starting failed. STOPPING - Application is stopping. STOPPED - Application is stopped. STOPPING_FAILED - Application stopping failed. DELETING - Application is being deleted. DELETED - Application is deleted. DELETING_FAILED - Application deleting failed.

Type : enum (INFRA_PROVISIONING, INFRA_PROVISIONED, INFRA_PROVISIONING_FAILED, STARTING, STARTED, STARTING_FAILED, STOPPING, STOPPED, STOPPING_FAILED, DELETING, DELETED, DELETING_FAILED)

ApplicationType

CDP Application Type. AIRFLOW - Airflow CSS - Cloudera Semantic Search NOTEBOOK - Standalone Notebook Service RAY - Standalone Ray Service

Type : enum (CSS)

CreateApplicationRequest

Request object for the CreateApplication method.

Name Description Schema

applicationSpotPolicy
optional

By default application infra services would run on on-demand instances and the application workloads on spot instances. Setting this config to ALL will run all application services on spot instances. Setting it to NONE will run all application services on on-demand instances.

ApplicationSpotPolicy

applicationVersion
optional

The version of the application to be installed. If not specified, latest supported version for the application will be used.

string

clusterCrn
optional

The CRN of the cluster in which application should be created. If not specified, default environment cluster wil be used.

string

environment
required

The name or CRN of the environment in which application should be created.

string

name
required

The application name.

string

size
optional

The size of the application refers to the specific amount of resources, such as CPU, memory, GPU and storage, that are allocated and guaranteed for that instance. Example Values: TINY,SMALL, LARGE, XLARGE, etc

string

skipValidation
optional

Skip pre-flight validations if requested.
Default : false

boolean

tags
optional

Tags to add to the cloud provider resources created.

< string, string > map

type
required

The type of application.

ApplicationType

CreateApplicationResponse

Response object for the CreateApplication method.

Name Description Schema

application
optional

The details of the application.

ApplicationInfo

requestId
optional

The request id to track the progress of the create operation.

integer (int64)

DeleteApplicationRequest

Request object for the DeleteApplication method.

Name Description Schema

application
required

The name or CRN of the application.

string

environment
required

The name or CRN of the environment.

string

DeleteApplicationResponse

Response object for the DeleteApplication method.

Name Description Schema

application
optional

The details of the application.

ApplicationInfo

requestId
optional

The request id to track the progress of the delete operation.

integer (int64)

DescribeApplicationRequest

Request object for the DescribeApplication method.

Name Description Schema

application
required

The name or CRN of the pplication.

string

environment
required

The name or CRN of the environment.

string

DescribeApplicationResponse

Response object for the DescribeApplication method.

Name Description Schema

application
optional

The details of the application.

ApplicationInfo

Error

An object returned on an error.

Name Description Schema

code
optional

The error code.

string

message
optional

The error message.

string

ListApplicationsRequest

Request object for the ListApplications method.

Name Description Schema

environment
optional

The name or CRN of the environment.

string

pageSize
optional

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

integer (int32)

pageToken
optional

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

string

ListApplicationsResponse

Response object for the ListApplications method.

Name Description Schema

applications
optional

A detailed list of applications within the environment.

< ApplicationInfo > array

nextPageToken
optional

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

string

Copyright © 2025 Cloudera, Inc. All rights reserved.