apiCluster

A cluster represents a set of interdependent services running on a set of hosts. All services on a given cluster are of the same software version (e.g. CDH4 or CDH5).

JSON

property type description
name name (string) The name of the cluster.

Immutable since API v6.

Prior to API v6, will contain the display name of the cluster.

displayName displayName (string) The display name of the cluster that is shown in the UI.

Available since API v6.

version version (apiClusterVersion) The CDH version of the cluster.
fullVersion fullVersion (string) The full CDH version of the cluster. The expected format is three dot separated version numbers, e.g. "4.2.1" or "5.0.0". The full version takes precedence over the version field during cluster creation.

Available since API v6.

maintenanceMode maintenanceMode (boolean) Readonly. Whether the cluster is in maintenance mode. Available since API v2.
maintenanceOwners array of maintenanceOwners/maintenanceOwners (apiEntityType) Readonly. The list of objects that trigger this cluster to be in maintenance mode. Available since API v2.
services array of services/services (apiService) Optional. Used during import/export of settings.
parcels array of parcels/parcels (apiParcel) Optional. Used during import/export of settings. Available since API v4.
clusterUrl clusterUrl (string) Readonly. Link into the Cloudera Manager web UI for this specific cluster.

Available since API v10.

hostsUrl hostsUrl (string) Readonly. Link into the Cloudera Manager web UI for host table for this cluster.

Available since API v11.

entityStatus entityStatus (apiEntityStatus) Readonly. The entity status for this cluster. Available since API v11.