A service (such as HDFS, MapReduce, HBase) runs in a cluster. It has roles, which are the actual entities (NameNode, DataNodes, etc.) that perform the service's functions.

HDFS services and health checks

In CDH4, HDFS services may not present any health checks. This will happen if the service has more than one nameservice configured. In those cases, the health information will be available by fetching information about the nameservices instead.

The health summary is still available, and reflects a service-wide summary.


property type description
name name (string) The name of the service.
type type (string) The type of the service, e.g. HDFS, MAPREDUCE, HBASE.
clusterRef clusterRef (apiClusterRef) Readonly. A reference to the enclosing cluster.
serviceState serviceState (apiServiceState) Readonly. The configured run state of this service. Whether it's running, etc.
healthSummary healthSummary (apiHealthSummary) Readonly. The high-level health status of this service.
configStale configStale (boolean) Readonly. Expresses whether the service configuration is stale.
configStalenessStatus configStalenessStatus (apiConfigStalenessStatus) Readonly. Expresses the service's configuration staleness status which is based on the staleness status of its roles. Available since API v6.
clientConfigStalenessStatus clientConfigStalenessStatus (apiConfigStalenessStatus) Readonly. Expresses the service's client configuration staleness status which is marked as stale if any of the service's hosts have missing client configurations or if any of the deployed client configurations are stale. Available since API v6.
healthChecks array of healthChecks/healthChecks (apiHealthCheck) Readonly. The list of health checks of this service.
serviceUrl serviceUrl (string) Readonly. Link into the Cloudera Manager web UI for this specific service.
maintenanceMode maintenanceMode (boolean) Readonly. Whether the service is in maintenance mode. Available since API v2.
maintenanceOwners array of maintenanceOwners/maintenanceOwners (apiEntityType) Readonly. The list of objects that trigger this service to be in maintenance mode. Available since API v2.
config config (apiServiceConfig) Configuration of the service being created. Optional.
roles array of roles/roles (apiRole) The list of service roles. Optional.
displayName displayName (string) The display name for the service that is shown in the UI. Available since API v2.
roleConfigGroups array of roleConfigGroups/roleConfigGroups (apiRoleConfigGroup) The list of role configuration groups in this service. Optional. Available since API v3.
replicationSchedules array of replicationSchedules/replicationSchedules (apiReplicationSchedule) The list of replication schedules for this service. Optional. Available since API v6.
snapshotPolicies array of snapshotPolicies/snapshotPolicies (apiSnapshotPolicy) The list of snapshot policies for this service. Optional. Available since API v6.