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
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
Check cluster connectivity.
POST /api/v1/onpremises/checkClusterConnectivity
Description
Checks the connection between CDP and Cloudera Manager.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Configuration key values for an application. |
< string, string > map |
name |
Name of the application. |
string |
services |
The services provided by the application. |
< string, Service > map |
CheckClusterConnectivityRequest
Request object for extract setup script API.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
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 |
Indicates if the service should make untrusted connections (without verifying TLS) to the cluster. |
boolean |
clusterCrn |
The clusterCrn of the registered cluster. |
string |
clusterType |
The type of the registered cluster. |
|
cmClusterUuid |
The UUID of the CM Base Cluster. |
string |
createdBy |
The owner of the registered cluster. |
string |
data |
Details of cluster read from cluster-manager. |
|
datacenterName |
The data center name of the registered cluster. |
string |
description |
The description of the registered cluster. |
string |
environmentCrn |
The CRN of the Private Cloud environment. |
string |
id |
The clusterId of the registered cluster. |
integer (int64) |
ipAddress |
The IP address of the registered cluster. |
string |
lastCreateTime |
The time at which the cluster was registered. |
string (date-time) |
lastUpdatedTime |
The time at which the cluster was updated. |
string (date-time) |
location |
The location of the data center. |
|
managerType |
The manager type of the registered cluster. |
|
managerUri |
The manager URI of the registered cluster. |
string |
name |
The name of the registered cluster. |
string |
newKeyId |
The key ID of the registered cluster. |
string |
onPremEnvironmentDetails |
Cloudera on-premises environment details. Only returned when showOnPremiseEnvironmentDetails in DescribeClusterRequest is true. |
|
password |
The password of the cluster. |
string |
properties |
The properties of the particular cluster as a JSON string. |
string |
pvcCrn |
CRN of the Private Cloud Control plane. |
string |
state |
The active status of the registered cluster. |
|
updatedUtc |
The time at which the cluster was updated. Its value is in Coordinated Universal Time. |
string (date-time) |
username |
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 |
Cluster details. |
|
displayName |
The display name of the discovered cluster. |
string |
kerberosTicketLocation |
The Kerberos ticket location of the cluster. |
string |
kerberosUser |
The Kerberos user of the cluster. |
string |
name |
The name of the cluster. |
string |
secured |
Indicates if the cluster is secured or not. |
boolean |
stats |
The stats of the discovered cluster. |
string |
url |
The cluster URL of the discovered cluster. |
string |
version |
The version of the cluster. |
string |
ClusterDetails
Object containing cluster details.
| Name | Description | Schema |
|---|---|---|
clouderaManagerClusterType |
The type of cluster. Possible values are BASE_CLUSTER or COMPUTE_CLUSTER. |
|
clusterUrl |
URL of the cluster. |
string |
displayName |
Display name of the cluster. |
string |
entityStatus |
The entity status for the cluster. |
|
fullVersion |
Full version of the cluster. |
string |
hostsUrl |
The URL to access hosts of this cluster. |
string |
name |
Name of the cluster. |
string |
uuid |
Uuid of the cluster. |
string |
version |
Cluster version. |
string |
ClusterDiscovered
Details of attached cluster.
| Name | Description | Schema |
|---|---|---|
name |
Name of cluster as returned from the cluster-manager. |
string |
ClusterHostSummary
Host summary details collected from Cloudera Manager during sync.
| Name | Description | Schema |
|---|---|---|
distribution |
The OS distribution details for the host. |
|
hostId |
The Cloudera Manager host ID. |
string |
hostname |
The hostname (FQDN) of the cluster host. |
string |
ipAddress |
The IP address of the cluster host. |
string |
status |
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 |
Name of the service. |
string |
serviceUrl |
URL of the service in Cloudera Manager. |
string |
state |
State of the service. |
string |
version |
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 |
Human-readable message (typically empty for passed validations; includes reason for failures). |
string |
passed |
Whether this validation passed. |
boolean |
type |
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 |
The remote cluster data center name. |
string |
name |
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 |
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 |
The CRN of the cluster. |
string |
showOnPremiseEnvironmentDetails |
Whether to show On Premise environment details. |
boolean |
DescribeClusterResponse
Response object for the DescribeCluster method.
| Name | Description | Schema |
|---|---|---|
cluster |
Object containing cluster details. |
|
hosts |
Host summary details collected from Cloudera Manager during sync. |
< ClusterHostSummary > array |
DescribeOnPremControlPlaneRequest
Request object for the DescribeOnPremControlPlaneRequest method.
| Name | Description | Schema |
|---|---|---|
pvc |
The account ID or CRN of the Private Cloud control plane. |
string |
DescribeOnPremControlPlaneResponse
Response object for the DescribeOnPremControlPlaneResponse method.
| Name | Description | Schema |
|---|---|---|
controlPlaneConfiguration |
The Private Cloud control plane configuration. |
DescribePartiallyRegisteredClusterRequest
Request body for the partially registered cluster.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
Cluster CRN of the partially registered cluster. Should be used alone. |
string |
datacenterName |
Datacenter name of the partially registered cluster. Should be used alone. |
string |
DescribePartiallyRegisteredClusterResponse
Response body for the partially registered cluster.
| Name | Description | Schema |
|---|---|---|
partiallyRegisteredClusterData |
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 |
The error code. |
string |
message |
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 |
Package filename |
string |
refreshPackage |
Raw zip file bytes containing the refresh script and certificate |
string (byte) |
ExtractClustersRequest
Request object for the ExtractClusters method.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of the cluster. |
string |
managerUri |
The manager URI of the on-premise cluster. |
string |
password |
The password for the cluster. |
string |
username |
The user name for the cluster. |
string |
ExtractClustersResponse
Response object for the ExtractClusters method.
| Name | Description | Schema |
|---|---|---|
clusters |
List of clusters attached to the provided cluster-manager. |
< ClusterDiscovered > array |
GenerateClusterConnectivityAgentConfigRequest
Request for GenerateClusterConnectivityAgentConfig call.
| Name | Description | Schema |
|---|---|---|
clusterType |
The type of the cluster. |
|
cmUrl |
URL of the cloudera manager |
string |
datacenterName |
Datacenter name of the cluster. |
string |
GenerateClusterConnectivityAgentConfigResponse
Response for GenerateClusterConnectivityAgentConfig call.
| Name | Description | Schema |
|---|---|---|
setupPackage |
Raw zip file bytes containing the script and keys. |
string (byte) |
GetClusterConnectivityAgentPackageUrlRequest
Request for GetClusterConnectivityAgentPackageUrl
| Name | Description | Schema |
|---|---|---|
kind |
Use suitable kind based on OS. |
GetClusterConnectivityAgentPackageUrlResponse
Response for GetClusterConnectivityAgentPackageUrl
| Name | Description | Schema |
|---|---|---|
agentUrl |
Cluster connectivity agent package url. |
string |
HostDistribution
OS distribution details for a cluster host collected from Cloudera Manager during sync.
| Name | Description | Schema |
|---|---|---|
distributionType |
The OS distribution type reported by Cloudera Manager (for example, RHEL9). |
string |
name |
The OS distribution name reported by Cloudera Manager (for example, redhat). |
string |
version |
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 |
The fully qualified domain name of the instance in the cluster. |
string |
id |
The ID of the instance. |
string |
privateIp |
The private IP of the instance. |
string |
KerberosInfo
The kerberos information for on premises Data Lake cluster.
| Name | Description | Schema |
|---|---|---|
kdcHost |
Key Distribution Center host. |
string |
kdcType |
The type of Key Distribution Center. |
string |
kerberized |
Denotes whether kerberized or not. |
boolean |
kerberosRealm |
Kerberos realm. |
string |
ListClusterServicesRequest
Request object for the ListClusterServices method.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the registered on-premise cluster. |
string |
clusterName |
Name of the cluster in the cloudera-manager. |
string |
managerUri |
CRN of the registered on-premise cluster. |
string |
password |
Password of the cloudera-manager. |
string |
username |
Username of the cloudera-manager. |
string |
ListClusterServicesResponse
Response object for the ListClusterServices method.
| Name | Description | Schema |
|---|---|---|
services |
List of service detail information. |
< ClusterService > array |
ListClustersRequest
Request object for the ListClusters method.
| Name | Description | Schema |
|---|---|---|
clusterState |
State of the cluster. |
|
clusterType |
Type of the cluster. |
|
managerType |
Manager type of the cluster. |
|
operator |
Operator on which the filters should be applied. |
|
pageSize |
The page size. |
integer (int32) |
pageToken |
A token to specify where to start paginating. This is the nextToken from a previously truncated response. |
string |
services |
Services in the cluster. |
< string > array |
ListClustersResponse
Response object for the ListClusters method.
| Name | Description | Schema |
|---|---|---|
clusters |
List of clusters. |
< Cluster > array |
nextPageToken |
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 |
The page size. |
integer (int32) |
pageToken |
A token to specify where to start paginating. This is the nextToken from a previously truncated response. |
string |
query |
Regex pattern for location. |
string |
ListLocationsResponse
Location response object containing the location details.
| Name | Description | Schema |
|---|---|---|
locations |
Location response message. |
< Location > array |
pageToken |
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 |
The page size. |
integer (int32) |
pageToken |
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 |
The Private Cloud control plane configurations. |
< OnPremControlPlaneConfiguration > array |
nextPageToken |
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 |
The page size. |
integer (int32) |
pageToken |
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 |
The token to use when requesting the next set of results. If not present, there are no additional results. |
string |
partiallyRegisteredClusterData |
Details of the partially registered cluster data |
< PartiallyRegisteredClusterData > array |
Location
Object containing the location of the data center.
| Name | Description | Schema |
|---|---|---|
city |
City in which the data center is located. |
string |
country |
Country in which the data center is located. |
string |
id |
ID of the location. |
integer (int64) |
iso2 |
ISO2 of the location. |
string |
latitude |
Latitude of the location. |
string |
longitude |
Longitude of the location. |
string |
province |
Province in which the data center is located. |
string |
OnPremControlPlaneConfiguration
Private Cloud control plane configuration.
| Name | Description | Schema |
|---|---|---|
agentSecretRotationStatus |
The status of the Jumpgate Agent Secret Rotation in the Private Cloud control plane. |
string |
baseUrl |
The base URL of the Private Cloud control plane. |
string |
description |
The description of the Private Cloud control plane. |
string |
idpCrn |
The IDP CRN of the user. |
string |
lastUpdatedTime |
The date/time for the last updated time. |
string (date-time) |
name |
The name of the Private Cloud control plane. |
string |
pvcCrn |
The CRN of the Private Cloud control plane. |
string |
pvcEnvironmentCount |
The total number of environments in the Private Cloud control plane. |
integer (int32) |
pvcId |
The account ID of the Private Cloud control plane. |
string |
pvcStatus |
The status of the Private Cloud control plane. |
string |
type |
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 |
The Cloudera Manager FQDN. |
string |
cmIp |
The Cloudera Manager IP. |
string |
cmServerId |
The Cloudera Manager server ID. |
string |
creationTimeEpochMillis |
The timestamp in Unix epoch when the Data Lake was created. |
integer (int64) |
datalakeName |
Name of the Data Lake. |
string |
enableRangerRaz |
Inidicates whether Ranger RAZ is enabled for the Data Lake. |
boolean |
instances |
The list of instances within the on premises Data Lake cluster. |
< Instance > array |
kerberosInfo |
Contains the kerberos related informations. |
|
status |
Status of the Data Lake. |
OnPremEnvironmentDetails
Object containing the on-premises Environment details.
| Name | Description | Schema |
|---|---|---|
applications |
A map of applications that provide services for the Service Discovery. |
< string, Application > map |
clouderaRuntimeVersion |
Cloudera Runtime Version. |
string |
cmHost |
Cloudera Manager Host. |
string |
cmVersion |
Cloudera Manager Version. |
string |
onPremDatalakeDetails |
On-premises Data Lake details. |
PartiallyRegisteredClusterData
Object holding the partially registered on-premise cluster data
| Name | Description | Schema |
|---|---|---|
agentCrn |
CRN of the jumpgate agent. |
string |
clusterConnectivityState |
State of the cluster connectivity of the partially registered cluster. It will be either FAILED, IN-PROGRESS, READY. |
string |
clusterCrn |
The cluster CRN of the on-premise cluster. |
string |
clusterType |
The type of the partially registered cluster. It will be either CDPDC or CDH. |
string |
createdAt |
The time at which the registration was triggered. |
string (date-time) |
createdBy |
The CRN of the user who triggered the registration request. |
string |
datacenterName |
The datacenter name of the on-premise cluster. |
string |
id |
The ID of the partially registered on-premise cluster. |
integer (int64) |
ipAddress |
The IP Address of the on-premise cluster (same as Cloudera Manager IP address). |
string |
isSecure |
Boolean value to determine if the cluster is secure. |
boolean |
port |
The port at which the cloudera manager is accessible. |
integer (int32) |
pvcCrn |
CRN of the Private Cloud Control plane. |
string |
registrationStatus |
Registration Status of the partially registered on-premises cluster. |
string |
updatedAt |
The time at which the registration was updated. |
string (date-time) |
RegisterClusterRequest
Request object for the RegisterCluster method.
| Name | Description | Schema |
|---|---|---|
datacenterName |
The data center name of the registered on-premise cluster. |
string |
description |
Description of the onpremises cluster |
string |
environmentCrn |
The CRN of the Private Cloud environment. |
string |
locationId |
The location of the cluster. |
integer (int64) |
managerUri |
The manager URI of the on-premise cluster. |
string |
name |
Name of the cluster. Should match the name it uses in Cloudera Manager (or Ambari). |
string |
password |
The password for the cluster. |
string |
tags |
Tags associated with the registration |
< string > array |
username |
The user name for the cluster. |
string |
RegisterClusterResponse
Response object for the RegisterCluster method.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of registered on-premise cluster. |
string |
RegisterOnPremControlPlaneRequest
Request object for the RegisterOnPremControlPlaneRequest method.
| Name | Description | Schema |
|---|---|---|
baseUrl |
The base URL of the Private Cloud control plane. |
string |
description |
The description of the Private Cloud control plane. |
string |
name |
The name of the Private Cloud control plane. |
string |
pvcId |
The account ID of the Private Cloud control plane. |
string |
samlIdentityProvider |
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 |
The connectivity configuration to be used by the Private Cloud control plane. |
string |
controlPlaneConfiguration |
The Private Cloud control plane configuration. |
RotateAgentCredentialsRequest
Request object for the RotateAgentCredentialsRequest method.
| Name | Description | Schema |
|---|---|---|
pvc |
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 |
Configuration key values for a service. |
< string, string > map |
endpoints |
List of endpoints that the service presents. |
< ServiceEndpoint > array |
type |
Type of service. |
string |
ServiceEndpoint
Object containing the details of endpoint of a Service Discovery Service.
| Name | Description | Schema |
|---|---|---|
host |
Endpoint hostname or IP address. |
string |
port |
Endpoint port. |
integer (int32) |
uri |
Connection URI of the endpoint. |
string |
SyncClusterDataRequest
Request object for the SyncClusterData method.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
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 |
Boolean object returning the status of the sync operation. |
boolean |
TestOnPremControlPlaneConnectivityRequest
Request object for the TestOnPremControlPlaneConnectivity method.
| Name | Description | Schema |
|---|---|---|
pvc |
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 |
Set to |
boolean |
pvc |
The account ID or CRN of the Private Cloud control plane. |
string |
unregisterOnPremClusters |
Set to |
boolean |
UnregisterOnPremControlPlaneResponse
Response object for the UnregisterOnPremControlPlaneResponse method.
Type : object
UpdateClusterRequest
Request object for the UpdateCluster method.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
The CRN of registered on-premise cluster. |
string |
locationId |
The location of the cluster. |
integer (int64) |
password |
The password for the cluster. |
string |
tags |
Tags associated with the registration |
< string > array |
username |
The user name for the cluster. |
string |
UpdateClusterResponse
Response object for the UpdateCluster method.
| Name | Description | Schema |
|---|---|---|
clusterCrn |
CRN of the registered on-premise cluster. |
string |
UpdateOnPremControlPlaneRequest
Request object for the UpdateOnPremControlPlane method.
| Name | Description | Schema |
|---|---|---|
description |
The description of the Private Cloud control plane. |
string |
pvc |
The account ID or CRN of the Private Cloud control plane. |
string |
samlIdentityProvider |
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 |
The CRN of the cluster. |
string |
ValidateClusterForDatalakeResponse
Response object for the ValidateClusterForDatalake method.
| Name | Description | Schema |
|---|---|---|
isValidForDatalake |
Indicates whether the cluster can be used as a Data Lake. |
boolean |
validations |
Validation results (passed/failed) with optional messages. |
< DatalakeValidation > array |