Overview

OnPremises Service is a web service to manage the on-prem clusters and control planes.

Version information

Version : 0.9.165 (BETA)

License information

URI scheme

Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Paths

Check cluster connectivity.

POST /api/v1/onpremises/checkClusterConnectivity

Description

Checks the connection between CDP and Cloudera Manager.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Delete a cluster.

POST /api/v1/onpremises/deleteCluster

Description

Delete a cluster.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Delete partially registered cluster.

POST /api/v1/onpremises/deletePartiallyRegisteredCluster

Description

Delete the partially registered cluster.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Get cluster details.

POST /api/v1/onpremises/describeCluster

Description

Get details of a registered on-premise cluster.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Describe a registered Private Cloud control plane configuration.

POST /api/v1/onpremises/describeOnPremControlPlane

Description

Describe a registered Private Cloud control plane configuration.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Describes the partially registered cluster.

POST /api/v1/onpremises/describePartiallyRegisteredCluster

Description

Describes the partially registered cluster.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Extract certificate refresh script package.

POST /api/v1/onpremises/extractCertificateRefreshScript

Description

Extract certificate refresh script to get updated certificate.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Extract clusters

POST /api/v1/onpremises/extractClusters

Description

Extracts cluster information by using authenticated access to the cluster-manager.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Generate the cluster connectivity config.

POST /api/v1/onpremises/generateClusterConnectivityAgentConfig

Description

Generates a ZIP file containing all necessary files to set up cluster connectivity.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Produces

  • application/octet-stream

Get cluster connectivity agent package url.

POST /api/v1/onpremises/getClusterConnectivityAgentPackageUrl

Description

Provide suitable agent package url.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

List service details of a cluster.

POST /api/v1/onpremises/listClusterServices

Description

Gets the service details of a cluster.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Lists all registered clusters.

POST /api/v1/onpremises/listClusters

Description

Lists all registered on-premise clusters.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

List the locations and its details.

POST /api/v1/onpremises/listLocations

Description

List the locations and its details.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

List registered Private Cloud control plane configurations.

POST /api/v1/onpremises/listOnPremControlPlanes

Description

List registered Private Cloud control plane configurations.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

List partially registered clusters.

POST /api/v1/onpremises/listPartiallyRegisteredClusters

Description

API to list all the partially registered clusters.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Register an existing cluster

POST /api/v1/onpremises/registerCluster

Description

Register an existing cluster as an on-premise cluster.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Register a Private Cloud control plane.

POST /api/v1/onpremises/registerOnPremControlPlane

Description

Register a Private Cloud control plane in Public Cloud.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Rotates the agent credentials.

POST /api/v1/onpremises/rotateAgentCredentials

Description

Rotates the Jumpgate Agent’s credentials in PvC.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Syncs the remote cluster data with the latest cluster service details.

POST /api/v1/onpremises/syncClusterData

Description

Syncs the remote cluster data with the latest cluster service details.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Test the connectivity to the Private Cloud control plane.

POST /api/v1/onpremises/testOnPremControlPlaneConnectivity

Description

Test the connectivity from Public Cloud control plane to the registered Private Cloud control plane.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Unregister a Private Cloud control plane.

POST /api/v1/onpremises/unregisterOnPremControlPlane

Description

Unregister a Private Cloud control plane from the Public Cloud, and clean up the Public Cloud resources from Private Cloud control plane resulting complete termination of the connection.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Update an existing cluster

POST /api/v1/onpremises/updateCluster

Description

Update registration of an on-premise cluster.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Update the Private Cloud control plane registration.

POST /api/v1/onpremises/updateOnPremControlPlane

Description

Update the Private Cloud control plane registration in Public Cloud.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Validate cluster for datalake.

POST /api/v1/onpremises/validateClusterForDatalake

Description

Validate if a classic-cluster can be used as datalake.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Definitions

Application

Object containing the details of a service discovery application.

Name Description Schema

config
optional

Configuration key values for an application.

< string, string > map

name
optional

Name of the application.

string

services
optional

The services provided by the application.

< string, Service > map

CheckClusterConnectivityRequest

Request object for extract setup script API.

Name Description Schema

clusterCrn
optional

The CRN of the cluster.

string

CheckClusterConnectivityResponse

Response object for extract setup script API.

Type : object

ClouderaManagerClusterType

The type of cluster. If unspecified, defaults to either BASE_CLUSTER (if no data contexts are provided) or COMPUTE_CLUSTER (if one or more data contexts are provided). BASE_CLUSTER - CDP Base cluster being managed by Cloudera Manager. COMPUTE_CLUSTER - OnPremises containerized compute cluster being managed by the Cloudera control plane.

Type : enum (BASE_CLUSTER, COMPUTE_CLUSTER)

Cluster

Object containing the cluster information.

Name Description Schema

allowUntrusted
optional

Indicates if the service should make untrusted connections (without verifying TLS) to the cluster.

boolean

clusterCrn
optional

The clusterCrn of the registered cluster.

string

clusterType
optional

The type of the registered cluster.

cmClusterUuid
optional

The UUID of the CM Base Cluster.

string

createdBy
optional

The owner of the registered cluster.

string

data
optional

Details of cluster read from cluster-manager.

datacenterName
optional

The data center name of the registered cluster.

string

description
optional

The description of the registered cluster.

string

environmentCrn
optional

The CRN of the Private Cloud environment.

string

id
optional

The clusterId of the registered cluster.

integer (int64)

ipAddress
optional

The IP address of the registered cluster.

string

lastCreateTime
optional

The time at which the cluster was registered.

string (date-time)

lastUpdatedTime
optional

The time at which the cluster was updated.

string (date-time)

location
optional

The location of the data center.

managerType
optional

The manager type of the registered cluster.

managerUri
optional

The manager URI of the registered cluster.

string

name
optional

The name of the registered cluster.

string

newKeyId
optional

The key ID of the registered cluster.

string

onPremEnvironmentDetails
optional

Cloudera on-premises environment details. Only returned when showOnPremiseEnvironmentDetails in DescribeClusterRequest is true.

password
optional

The password of the cluster.

string

properties
optional

The properties of the particular cluster as a JSON string.

string

pvcCrn
optional

CRN of the Private Cloud Control plane.

string

state
optional

The active status of the registered cluster.

updatedUtc
optional

The time at which the cluster was updated. Its value is in Coordinated Universal Time.

string (date-time)

username
optional

The user name of the cluster.

string

ClusterConnectivityAgentPackageKind

OS of Cloudera manager host. JUMPGATE_RPM_LEGACY_EL6 - Used for CentOS 6 / RHEL 6. JUMPGATE_RPM_STANDARD - Used for CentOS 7 / CentOS 8 / RHEL 7 / RHEL 8 / RHEL 9 / Suse 15.4. JUMPGATE_DEB_UBUNTU - Used for Ubuntu 20.04

Type : enum (JUMPGATE_RPM_LEGACY_EL6, JUMPGATE_RPM_STANDARD, JUMPGATE_DEB_UBUNTU)

ClusterData

Object containing the discovered cluster information.

Name Description Schema

clusterDetails
optional

Cluster details.

displayName
optional

The display name of the discovered cluster.

string

kerberosTicketLocation
optional

The Kerberos ticket location of the cluster.

string

kerberosUser
optional

The Kerberos user of the cluster.

string

name
optional

The name of the cluster.

string

secured
optional

Indicates if the cluster is secured or not.

boolean

stats
optional

The stats of the discovered cluster.

string

url
optional

The cluster URL of the discovered cluster.

string

version
optional

The version of the cluster.

string

ClusterDetails

Object containing cluster details.

Name Description Schema

clouderaManagerClusterType
optional

The type of cluster. Possible values are BASE_CLUSTER or COMPUTE_CLUSTER.

clusterUrl
optional

URL of the cluster.

string

displayName
optional

Display name of the cluster.

string

entityStatus
optional

The entity status for the cluster.

fullVersion
optional

Full version of the cluster.

string

hostsUrl
optional

The URL to access hosts of this cluster.

string

name
optional

Name of the cluster.

string

uuid
optional

Uuid of the cluster.

string

version
optional

Cluster version.

string

ClusterDiscovered

Details of attached cluster.

Name Description Schema

name
optional

Name of cluster as returned from the cluster-manager.

string

ClusterHostSummary

Host summary details collected from Cloudera Manager during sync.

Name Description Schema

distribution
optional

The OS distribution details for the host.

hostId
optional

The Cloudera Manager host ID.

string

hostname
optional

The hostname (FQDN) of the cluster host.

string

ipAddress
optional

The IP address of the cluster host.

string

status
optional

The commission state of the host in Cloudera Manager.

string

ClusterManagerType

Manager type of the cluster. AMBARI - Ambari as manager type. CLOUDERA_MANAGER - Cloudera Manager as manager type.

Type : enum (AMBARI, CLOUDERA_MANAGER)

ClusterQueryOperator

The type of operator. AND - AND operator. OR - OR operator.

Type : enum (AND, OR)

ClusterService

Object containing the service information.

Name Description Schema

name
optional

Name of the service.

string

serviceUrl
optional

URL of the service in Cloudera Manager.

string

state
optional

State of the service.

string

version
optional

Version of the service.

string

ClusterState

State of the on-premise cluster. TO_SYNC - Cluster yet to be synced. SYNC_IN_PROGRESS - Cluster sync in-progress. SYNCED - Cluster sync successful. SYNC_ERROR - Cluster sync error.

Type : enum (TO_SYNC, SYNC_IN_PROGRESS, SYNCED, SYNC_ERROR)

ClusterType

The type of on-premise cluster. CDH - Legacy CDH Cluster. CDPDC - CDPDC Cluster.

Type : enum (CDH, CDPDC)

ControlPlaneType

The type of a remote cluster. CDP_PVC - CDP Private Cloud control plane.

Type : enum (CDP_PVC)

DatalakeStatus

Status of the on-premises Data Lake. AVAILABLE - Data Lake is available. NOT_AVAILABLE - Data Lake is unavailable.

Type : enum (AVAILABLE, NOT_AVAILABLE)

DatalakeValidation

Datalake validation result.

Name Description Schema

message
optional

Human-readable message (typically empty for passed validations; includes reason for failures).

string

passed
optional

Whether this validation passed.

boolean

type
optional

Validation type.

DatalakeValidationType

The type of datalake validation. CLUSTER_TYPE_CDPDC - Cluster type is CDPDC. CLOUDERA_RUNTIME_VERSION_AT_LEAST_7_1_9 - Cloudera Runtime is 7.1.9 or newer. KERBERIZED - Whether kerberized or not. NOT_COMPUTE_CLUSTER - The clusterType should not be "COMPUTE" for virtual private cluster.

Type : enum (CLUSTER_TYPE_CDPDC, CLOUDERA_RUNTIME_VERSION_AT_LEAST_7_1_9, KERBERIZED, NOT_COMPUTE_CLUSTER)

DeleteClusterRequest

Request for delete remote cluster.

Name Description Schema

dcName
optional

The remote cluster data center name.

string

name
optional

The remote cluster name.

string

DeleteClusterResponse

Response for delete remote cluster.

Type : object

DeletePartiallyRegisteredClusterRequest

Request object for deleting the partially registered cluster API.

Name Description Schema

clusterCrn
optional

The cluster CRN of the on-premise cluster.

string

DeletePartiallyRegisteredClusterResponse

Response object for deleting the partially registered cluster API.

Type : object

DescribeClusterRequest

Request object for the DescribeCluster method.

Name Description Schema

clusterCrn
optional

The CRN of the cluster.

string

showOnPremiseEnvironmentDetails
optional

Whether to show On Premise environment details.

boolean

DescribeClusterResponse

Response object for the DescribeCluster method.

Name Description Schema

cluster
optional

Object containing cluster details.

hosts
optional

Host summary details collected from Cloudera Manager during sync.

< ClusterHostSummary > array

DescribeOnPremControlPlaneRequest

Request object for the DescribeOnPremControlPlaneRequest method.

Name Description Schema

pvc
required

The account ID or CRN of the Private Cloud control plane.

string

DescribeOnPremControlPlaneResponse

Response object for the DescribeOnPremControlPlaneResponse method.

Name Description Schema

controlPlaneConfiguration
optional

The Private Cloud control plane configuration.

DescribePartiallyRegisteredClusterRequest

Request body for the partially registered cluster.

Name Description Schema

clusterCrn
optional

Cluster CRN of the partially registered cluster. Should be used alone.

string

datacenterName
optional

Datacenter name of the partially registered cluster. Should be used alone.

string

DescribePartiallyRegisteredClusterResponse

Response body for the partially registered cluster.

Name Description Schema

partiallyRegisteredClusterData
optional

Details of the partially registered cluster.

EntityStatus

The single value used by the Cloudera Manager to represent the status of the entity. UNKNOWN - Unknown. NONE - None. STOPPED - Stopped. DOWN - Down. UNKNOWN_HEALTH - Unknown health. DISABLED_HEALTH - Disabled health. CONCERNING_HEALTH - Concerning health. BAD_HEALTH - Bad health. GOOD_HEALTH - Good health. STARTING - Starting. STOPPING - Stopping. HISTORY_NOT_AVAILABLE - History not available.

Type : enum (UNKNOWN, NONE, STOPPED, DOWN, UNKNOWN_HEALTH, DISABLED_HEALTH, CONCERNING_HEALTH, BAD_HEALTH, GOOD_HEALTH, STARTING, STOPPING, HISTORY_NOT_AVAILABLE)

Error

An object returned on an error.

Name Description Schema

code
optional

The error code.

string

message
optional

The error message.

string

ExtractCertificateRefreshScriptRequest

Request object for extract certificate refresh script

Type : object

ExtractCertificateRefreshScriptResponse

Response object for extract certificate refresh script

Name Description Schema

filename
optional

Package filename

string

refreshPackage
optional

Raw zip file bytes containing the refresh script and certificate
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"

string (byte)

ExtractClustersRequest

Request object for the ExtractClusters method.

Name Description Schema

clusterCrn
optional

The CRN of the cluster.

string

managerUri
required

The manager URI of the on-premise cluster.

string

password
required

The password for the cluster.

string

username
required

The user name for the cluster.

string

ExtractClustersResponse

Response object for the ExtractClusters method.

Name Description Schema

clusters
optional

List of clusters attached to the provided cluster-manager.

< ClusterDiscovered > array

GenerateClusterConnectivityAgentConfigRequest

Request for GenerateClusterConnectivityAgentConfig call.

Name Description Schema

clusterType
required

The type of the cluster.

cmUrl
required

URL of the cloudera manager

string

datacenterName
required

Datacenter name of the cluster.
Maximal length : 32

string

GenerateClusterConnectivityAgentConfigResponse

Response for GenerateClusterConnectivityAgentConfig call.

Name Description Schema

setupPackage
optional

Raw zip file bytes containing the script and keys.
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"

string (byte)

GetClusterConnectivityAgentPackageUrlRequest

Request for GetClusterConnectivityAgentPackageUrl

Name Description Schema

kind
optional

Use suitable kind based on OS.

GetClusterConnectivityAgentPackageUrlResponse

Response for GetClusterConnectivityAgentPackageUrl

Name Description Schema

agentUrl
optional

Cluster connectivity agent package url.

string

HostDistribution

OS distribution details for a cluster host collected from Cloudera Manager during sync.

Name Description Schema

distributionType
optional

The OS distribution type reported by Cloudera Manager (for example, RHEL9).

string

name
optional

The OS distribution name reported by Cloudera Manager (for example, redhat).

string

version
optional

The OS distribution version reported by Cloudera Manager (for example, 9.4).

string

Instance

Information for instance within the on premises Data Lake cluster.

Name Description Schema

fqdn
optional

The fully qualified domain name of the instance in the cluster.

string

id
optional

The ID of the instance.

string

privateIp
optional

The private IP of the instance.

string

KerberosInfo

The kerberos information for on premises Data Lake cluster.

Name Description Schema

kdcHost
optional

Key Distribution Center host.

string

kdcType
optional

The type of Key Distribution Center.

string

kerberized
optional

Denotes whether kerberized or not.

boolean

kerberosRealm
optional

Kerberos realm.

string

ListClusterServicesRequest

Request object for the ListClusterServices method.

Name Description Schema

clusterCrn
required

CRN of the registered on-premise cluster.

string

clusterName
optional

Name of the cluster in the cloudera-manager.

string

managerUri
optional

CRN of the registered on-premise cluster.

string

password
optional

Password of the cloudera-manager.

string

username
optional

Username of the cloudera-manager.

string

ListClusterServicesResponse

Response object for the ListClusterServices method.

Name Description Schema

services
optional

List of service detail information.

< ClusterService > array

ListClustersRequest

Request object for the ListClusters method.

Name Description Schema

clusterState
optional

State of the cluster.

clusterType
optional

Type of the cluster.

managerType
optional

Manager type of the cluster.

operator
optional

Operator on which the filters should be applied.

pageSize
optional

The page size.
Minimum value : 1
Maximum value : 500

integer (int32)

pageToken
optional

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

string

services
optional

Services in the cluster.

< string > array

ListClustersResponse

Response object for the ListClusters method.

Name Description Schema

clusters
optional

List of clusters.

< Cluster > array

nextPageToken
optional

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

string

ListLocationsRequest

Location request object containing the regex pattern.

Name Description Schema

pageSize
optional

The page size.
Minimum value : 1
Maximum value : 500

integer (int32)

pageToken
optional

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

string

query
optional

Regex pattern for location.

string

ListLocationsResponse

Location response object containing the location details.

Name Description Schema

locations
optional

Location response message.

< Location > array

pageToken
optional

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

string

ListOnPremControlPlanesRequest

Request object for the ListOnPremControlPlanesRequest method.

Name Description Schema

pageSize
optional

The page size.
Minimum value : 1
Maximum value : 100

integer (int32)

pageToken
optional

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

string

ListOnPremControlPlanesResponse

Response object for the ListOnPremControlPlanesResponse method.

Name Description Schema

controlPlaneConfigurations
optional

The Private Cloud control plane configurations.

nextPageToken
optional

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

string

ListPartiallyRegisteredClustersRequest

Request object for listing the partially registered clusters.

Name Description Schema

pageSize
optional

The page size.
Minimum value : 1
Maximum value : 500

integer (int32)

pageToken
optional

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

string

ListPartiallyRegisteredClustersResponse

Response object for listing the partially registered clusters.

Name Description Schema

nextPageToken
optional

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

string

partiallyRegisteredClusterData
optional

Details of the partially registered cluster data

Location

Object containing the location of the data center.

Name Description Schema

city
optional

City in which the data center is located.

string

country
optional

Country in which the data center is located.

string

id
optional

ID of the location.

integer (int64)

iso2
optional

ISO2 of the location.

string

latitude
optional

Latitude of the location.

string

longitude
optional

Longitude of the location.

string

province
optional

Province in which the data center is located.

string

OnPremControlPlaneConfiguration

Private Cloud control plane configuration.

Name Description Schema

agentSecretRotationStatus
optional

The status of the Jumpgate Agent Secret Rotation in the Private Cloud control plane.

string

baseUrl
optional

The base URL of the Private Cloud control plane.

string

description
optional

The description of the Private Cloud control plane.

string

idpCrn
optional

The IDP CRN of the user.

string

lastUpdatedTime
optional

The date/time for the last updated time.

string (date-time)

name
optional

The name of the Private Cloud control plane.

string

pvcCrn
optional

The CRN of the Private Cloud control plane.

string

pvcEnvironmentCount
optional

The total number of environments in the Private Cloud control plane.

integer (int32)

pvcId
optional

The account ID of the Private Cloud control plane.

string

pvcStatus
optional

The status of the Private Cloud control plane.

string

type
optional

The type for the Private Cloud control plane, this is always be CDP_PVC.

OnPremDatalakeDetails

Object containing on-premises Data Lake details.

Name Description Schema

cmFqdn
optional

The Cloudera Manager FQDN.

string

cmIp
optional

The Cloudera Manager IP.

string

cmServerId
optional

The Cloudera Manager server ID.

string

creationTimeEpochMillis
optional

The timestamp in Unix epoch when the Data Lake was created.

integer (int64)

datalakeName
optional

Name of the Data Lake.

string

enableRangerRaz
optional

Inidicates whether Ranger RAZ is enabled for the Data Lake.

boolean

instances
optional

The list of instances within the on premises Data Lake cluster.

< Instance > array

kerberosInfo
optional

Contains the kerberos related informations.

status
optional

Status of the Data Lake.

OnPremEnvironmentDetails

Object containing the on-premises Environment details.

Name Description Schema

applications
optional

A map of applications that provide services for the Service Discovery.

< string, Application > map

clouderaRuntimeVersion
optional

Cloudera Runtime Version.

string

cmHost
optional

Cloudera Manager Host.

string

cmVersion
optional

Cloudera Manager Version.

string

onPremDatalakeDetails
optional

On-premises Data Lake details.

PartiallyRegisteredClusterData

Object holding the partially registered on-premise cluster data

Name Description Schema

agentCrn
optional

CRN of the jumpgate agent.

string

clusterConnectivityState
optional

State of the cluster connectivity of the partially registered cluster. It will be either FAILED, IN-PROGRESS, READY.

string

clusterCrn
optional

The cluster CRN of the on-premise cluster.

string

clusterType
optional

The type of the partially registered cluster. It will be either CDPDC or CDH.

string

createdAt
optional

The time at which the registration was triggered.

string (date-time)

createdBy
optional

The CRN of the user who triggered the registration request.

string

datacenterName
optional

The datacenter name of the on-premise cluster.

string

id
optional

The ID of the partially registered on-premise cluster.

integer (int64)

ipAddress
optional

The IP Address of the on-premise cluster (same as Cloudera Manager IP address).

string

isSecure
optional

Boolean value to determine if the cluster is secure.

boolean

port
optional

The port at which the cloudera manager is accessible.

integer (int32)

pvcCrn
optional

CRN of the Private Cloud Control plane.

string

registrationStatus
optional

Registration Status of the partially registered on-premises cluster.

string

updatedAt
optional

The time at which the registration was updated.

string (date-time)

RegisterClusterRequest

Request object for the RegisterCluster method.

Name Description Schema

datacenterName
required

The data center name of the registered on-premise cluster.
Maximal length : 32

string

description
optional

Description of the onpremises cluster
Maximal length : 1000

string

environmentCrn
optional

The CRN of the Private Cloud environment.

string

locationId
optional

The location of the cluster.

integer (int64)

managerUri
required

The manager URI of the on-premise cluster.

string

name
optional

Name of the cluster. Should match the name it uses in Cloudera Manager (or Ambari).

string

password
optional

The password for the cluster.

string

tags
optional

Tags associated with the registration

< string > array

username
optional

The user name for the cluster.

string

RegisterClusterResponse

Response object for the RegisterCluster method.

Name Description Schema

clusterCrn
required

The CRN of registered on-premise cluster.

string

RegisterOnPremControlPlaneRequest

Request object for the RegisterOnPremControlPlaneRequest method.

Name Description Schema

baseUrl
required

The base URL of the Private Cloud control plane.

string

description
optional

The description of the Private Cloud control plane.
Maximal length : 1000

string

name
required

The name of the Private Cloud control plane.
Maximal length : 128

string

pvcId
required

The account ID of the Private Cloud control plane.

string

samlIdentityProvider
required

The name or ID or CRN of the SAML identity provider from Public Cloud control plane in which users are allowed to operate on the Private Cloud control plane. The same or equivalent SAML IDP should be used by the Public Cloud control plane and the Private Cloud control plane, in order for the user to be mapped by SAML user ID.

string

RegisterOnPremControlPlaneResponse

Response object for the RegisterOnPremControlPlaneResponse method.

Name Description Schema

connectivityConfiguration
optional

The connectivity configuration to be used by the Private Cloud control plane.

string

controlPlaneConfiguration
optional

The Private Cloud control plane configuration.

RotateAgentCredentialsRequest

Request object for the RotateAgentCredentialsRequest method.

Name Description Schema

pvc
required

The account ID or CRN of the Private Cloud control plane.

string

RotateAgentCredentialsResponse

Response object for the RotateAgentCredentialsResponse method.

Type : object

Service

Object containing the details of a service discovery service.

Name Description Schema

config
optional

Configuration key values for a service.

< string, string > map

endpoints
optional

List of endpoints that the service presents.

< ServiceEndpoint > array

type
optional

Type of service.

string

ServiceEndpoint

Object containing the details of endpoint of a Service Discovery Service.

Name Description Schema

host
optional

Endpoint hostname or IP address.

string

port
optional

Endpoint port.

integer (int32)

uri
optional

Connection URI of the endpoint.

string

SyncClusterDataRequest

Request object for the SyncClusterData method.

Name Description Schema

clusterCrn
optional

The CRN of the cluster on which the sync operation should be performed.

string

SyncClusterDataResponse

Response object for the SyncClusterData method.

Name Description Schema

syncSuccessful
optional

Boolean object returning the status of the sync operation.

boolean

TestOnPremControlPlaneConnectivityRequest

Request object for the TestOnPremControlPlaneConnectivity method.

Name Description Schema

pvc
required

The account ID or CRN of the Private Cloud control plane.

string

TestOnPremControlPlaneConnectivityResponse

Response object for the TestOnPremControlPlaneConnectivity method.

Type : object

UnregisterOnPremControlPlaneRequest

Request object for the UnregisterOnPremControlPlaneRequest method.

Name Description Schema

force
optional

Set to true to enable force unregister, This option may be used when on premises control plane connection has failed or the delete operation is failing. This option only guarantees to remove this instance from cloud control plane, and may leave hybrid connection lingering on on premises control plane. You may have to delete the connection from on premises control plane manually for complete cleanup. Defaults to false if not set.

boolean

pvc
required

The account ID or CRN of the Private Cloud control plane.

string

unregisterOnPremClusters
optional

Set to true to unregister on premises clusters. Defaults to false if not set. if false on premises clusters will not be unregistered.

boolean

UnregisterOnPremControlPlaneResponse

Response object for the UnregisterOnPremControlPlaneResponse method.

Type : object

UpdateClusterRequest

Request object for the UpdateCluster method.

Name Description Schema

clusterCrn
required

The CRN of registered on-premise cluster.

string

locationId
optional

The location of the cluster.

integer (int64)

password
optional

The password for the cluster.

string

tags
optional

Tags associated with the registration

< string > array

username
optional

The user name for the cluster.

string

UpdateClusterResponse

Response object for the UpdateCluster method.

Name Description Schema

clusterCrn
required

CRN of the registered on-premise cluster.

string

UpdateOnPremControlPlaneRequest

Request object for the UpdateOnPremControlPlane method.

Name Description Schema

description
optional

The description of the Private Cloud control plane.
Maximal length : 1000

string

pvc
required

The account ID or CRN of the Private Cloud control plane.

string

samlIdentityProvider
required

The name or ID or CRN of the SAML identity provider from Public Cloud control plane in which users are allowed to operate on the Private Cloud control plane. The same or equivalent SAML IDP should be used by the Public Cloud control plane and the Private Cloud control plane, in order for the user to be mapped by SAML user ID.

string

UpdateOnPremControlPlaneResponse

Response object for the UpdateOnPremControlPlane method.

Type : object

ValidateClusterForDatalakeRequest

Request object for the ValidateClusterForDatalake method.

Name Description Schema

clusterCrn
required

The CRN of the cluster.

string

ValidateClusterForDatalakeResponse

Response object for the ValidateClusterForDatalake method.

Name Description Schema

isValidForDatalake
required

Indicates whether the cluster can be used as a Data Lake.

boolean

validations
optional

Validation results (passed/failed) with optional messages.

< DatalakeValidation > array


Copyright © 2026 Cloudera, Inc. All rights reserved.