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).
| name | data type | description |
|---|---|---|
| name | string | The name of the cluster.
Immutable since API v6. Prior to API v6, will contain the display name of the cluster. |
| displayName | string | The display name of the cluster that is shown in the UI.
Available since API v6. |
| |
|
|
| 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 | boolean | Readonly. Whether the cluster is in maintenance mode. Available since API v2. |
| maintenanceOwners | array of ApiEntityType | Readonly. The list of objects that trigger this cluster to be in maintenance mode. Available since API v2. |
| services | array of ApiService | Optional. Used during import/export of settings. |
| parcels | array of ApiParcel | Optional. Used during import/export of settings. Available since API v4. |
| clusterUrl | string | Readonly. Link into the Cloudera Manager web UI for this specific cluster.
Available since API v10. |
| hostsUrl | string | Readonly. Link into the Cloudera Manager web UI for host table for this cluster.
Available since API v11. |
| entityStatus | ApiEntityStatus | Readonly. The entity status for this cluster. Available since API v11. |
| uuid | string | Readonly. The UUID of the cluster.
Available since API v15. |
| dataContextRefs | array of ApiDataContextRef | |
| clusterType | string | 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). Available since APIv32. |
| tags | array of ApiEntityTag | Tags associated with the cluster. Available since V41. |
Example
{
"name" : "...",
"displayName" : "...",
"fullVersion" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "HOST", "CONTROL_PLANE" ],
"services" : [ {
"name" : "...",
"type" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceState" : "STARTING",
"healthSummary" : "DISABLED",
"configStalenessStatus" : "STALE_REFRESHABLE",
"clientConfigStalenessStatus" : "FRESH",
"healthChecks" : [ {
"name" : "...",
"summary" : "GOOD",
"explanation" : "...",
"suppressed" : true
}, {
"name" : "...",
"summary" : "NOT_AVAILABLE",
"explanation" : "...",
"suppressed" : true
} ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CLUSTER", "ROLE" ],
"config" : {
"roleTypeConfigs" : [ { }, { } ],
"items" : [ { }, { } ]
},
"roles" : [ {
"name" : "...",
"type" : "...",
"hostRef" : { },
"serviceRef" : { },
"roleState" : "UNKNOWN",
"commissionState" : "UNKNOWN",
"healthSummary" : "HISTORY_NOT_AVAILABLE",
"configStalenessStatus" : "STALE",
"healthChecks" : [ { }, { } ],
"haStatus" : "ACTIVE",
"roleUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "HOST", "SERVICE" ],
"config" : { },
"roleConfigGroupRef" : { },
"zooKeeperServerMode" : "REPLICATED_LEADER",
"entityStatus" : "UNKNOWN_HEALTH",
"tags" : [ { }, { } ]
}, {
"name" : "...",
"type" : "...",
"hostRef" : { },
"serviceRef" : { },
"roleState" : "BUSY",
"commissionState" : "DECOMMISSIONING",
"healthSummary" : "BAD",
"configStalenessStatus" : "FRESH",
"healthChecks" : [ { }, { } ],
"haStatus" : "UNKNOWN",
"roleUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "HOST", "ROLE" ],
"config" : { },
"roleConfigGroupRef" : { },
"zooKeeperServerMode" : "REPLICATED_LEADER",
"entityStatus" : "UNKNOWN",
"tags" : [ { }, { } ]
} ],
"displayName" : "...",
"roleConfigGroups" : [ {
"name" : "...",
"roleType" : "...",
"base" : true,
"config" : { },
"displayName" : "...",
"serviceRef" : { }
}, {
"name" : "...",
"roleType" : "...",
"base" : true,
"config" : { },
"displayName" : "...",
"serviceRef" : { }
} ],
"replicationSchedules" : [ {
"hdfsArguments" : { },
"hiveArguments" : { },
"hdfsCloudArguments" : { },
"ozoneReplicationArguments" : { },
"history" : [ { }, { } ],
"active" : true,
"hiveCloudArguments" : { },
"hbaseArguments" : { },
"hive3Arguments" : { },
"rangerArguments" : { },
"icebergArguments" : { },
"id" : 12345,
"displayName" : "...",
"description" : "...",
"startTime" : "...",
"endTime" : "...",
"interval" : 12345,
"intervalUnit" : "MINUTE",
"nextRun" : "...",
"paused" : true,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true
}, {
"hdfsArguments" : { },
"hiveArguments" : { },
"hdfsCloudArguments" : { },
"ozoneReplicationArguments" : { },
"history" : [ { }, { } ],
"active" : true,
"hiveCloudArguments" : { },
"hbaseArguments" : { },
"hive3Arguments" : { },
"rangerArguments" : { },
"icebergArguments" : { },
"id" : 12345,
"displayName" : "...",
"description" : "...",
"startTime" : "...",
"endTime" : "...",
"interval" : 12345,
"intervalUnit" : "MONTH",
"nextRun" : "...",
"paused" : true,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true
} ],
"snapshotPolicies" : [ {
"name" : "...",
"description" : "...",
"hourlySnapshots" : 12345,
"dailySnapshots" : 12345,
"weeklySnapshots" : 12345,
"monthlySnapshots" : 12345,
"yearlySnapshots" : 12345,
"minuteOfHour" : 12345,
"hoursForHourlySnapshots" : [ 12345, 12345 ],
"hourOfDay" : 12345,
"dayOfWeek" : 12345,
"dayOfMonth" : 12345,
"monthOfYear" : 12345,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true,
"hbaseArguments" : { },
"hdfsArguments" : { },
"ozoneArguments" : { },
"lastCommand" : { },
"lastSuccessfulCommand" : { },
"paused" : true
}, {
"name" : "...",
"description" : "...",
"hourlySnapshots" : 12345,
"dailySnapshots" : 12345,
"weeklySnapshots" : 12345,
"monthlySnapshots" : 12345,
"yearlySnapshots" : 12345,
"minuteOfHour" : 12345,
"hoursForHourlySnapshots" : [ 12345, 12345 ],
"hourOfDay" : 12345,
"dayOfWeek" : 12345,
"dayOfMonth" : 12345,
"monthOfYear" : 12345,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true,
"hbaseArguments" : { },
"hdfsArguments" : { },
"ozoneArguments" : { },
"lastCommand" : { },
"lastSuccessfulCommand" : { },
"paused" : true
} ],
"entityStatus" : "GOOD_HEALTH",
"tags" : [ {
"name" : "...",
"value" : "..."
}, {
"name" : "...",
"value" : "..."
} ],
"serviceVersion" : "..."
}, {
"name" : "...",
"type" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceState" : "UNKNOWN",
"healthSummary" : "BAD",
"configStalenessStatus" : "STALE",
"clientConfigStalenessStatus" : "STALE",
"healthChecks" : [ {
"name" : "...",
"summary" : "CONCERNING",
"explanation" : "...",
"suppressed" : true
}, {
"name" : "...",
"summary" : "NOT_AVAILABLE",
"explanation" : "...",
"suppressed" : true
} ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CLUSTER", "HOST" ],
"config" : {
"roleTypeConfigs" : [ { }, { } ],
"items" : [ { }, { } ]
},
"roles" : [ {
"name" : "...",
"type" : "...",
"hostRef" : { },
"serviceRef" : { },
"roleState" : "STARTING",
"commissionState" : "DECOMMISSIONED",
"healthSummary" : "GOOD",
"configStalenessStatus" : "STALE",
"healthChecks" : [ { }, { } ],
"haStatus" : "UNKNOWN",
"roleUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "ROLE", "CLUSTER" ],
"config" : { },
"roleConfigGroupRef" : { },
"zooKeeperServerMode" : "REPLICATED_LEADER",
"entityStatus" : "HISTORY_NOT_AVAILABLE",
"tags" : [ { }, { } ]
}, {
"name" : "...",
"type" : "...",
"hostRef" : { },
"serviceRef" : { },
"roleState" : "STOPPED",
"commissionState" : "OFFLINING",
"healthSummary" : "BAD",
"configStalenessStatus" : "FRESH",
"healthChecks" : [ { }, { } ],
"haStatus" : "STANDBY",
"roleUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CONTROL_PLANE", "CLUSTER" ],
"config" : { },
"roleConfigGroupRef" : { },
"zooKeeperServerMode" : "STANDALONE",
"entityStatus" : "UNKNOWN",
"tags" : [ { }, { } ]
} ],
"displayName" : "...",
"roleConfigGroups" : [ {
"name" : "...",
"roleType" : "...",
"base" : true,
"config" : { },
"displayName" : "...",
"serviceRef" : { }
}, {
"name" : "...",
"roleType" : "...",
"base" : true,
"config" : { },
"displayName" : "...",
"serviceRef" : { }
} ],
"replicationSchedules" : [ {
"hdfsArguments" : { },
"hiveArguments" : { },
"hdfsCloudArguments" : { },
"ozoneReplicationArguments" : { },
"history" : [ { }, { } ],
"active" : true,
"hiveCloudArguments" : { },
"hbaseArguments" : { },
"hive3Arguments" : { },
"rangerArguments" : { },
"icebergArguments" : { },
"id" : 12345,
"displayName" : "...",
"description" : "...",
"startTime" : "...",
"endTime" : "...",
"interval" : 12345,
"intervalUnit" : "HOUR",
"nextRun" : "...",
"paused" : true,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true
}, {
"hdfsArguments" : { },
"hiveArguments" : { },
"hdfsCloudArguments" : { },
"ozoneReplicationArguments" : { },
"history" : [ { }, { } ],
"active" : true,
"hiveCloudArguments" : { },
"hbaseArguments" : { },
"hive3Arguments" : { },
"rangerArguments" : { },
"icebergArguments" : { },
"id" : 12345,
"displayName" : "...",
"description" : "...",
"startTime" : "...",
"endTime" : "...",
"interval" : 12345,
"intervalUnit" : "YEAR",
"nextRun" : "...",
"paused" : true,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true
} ],
"snapshotPolicies" : [ {
"name" : "...",
"description" : "...",
"hourlySnapshots" : 12345,
"dailySnapshots" : 12345,
"weeklySnapshots" : 12345,
"monthlySnapshots" : 12345,
"yearlySnapshots" : 12345,
"minuteOfHour" : 12345,
"hoursForHourlySnapshots" : [ 12345, 12345 ],
"hourOfDay" : 12345,
"dayOfWeek" : 12345,
"dayOfMonth" : 12345,
"monthOfYear" : 12345,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true,
"hbaseArguments" : { },
"hdfsArguments" : { },
"ozoneArguments" : { },
"lastCommand" : { },
"lastSuccessfulCommand" : { },
"paused" : true
}, {
"name" : "...",
"description" : "...",
"hourlySnapshots" : 12345,
"dailySnapshots" : 12345,
"weeklySnapshots" : 12345,
"monthlySnapshots" : 12345,
"yearlySnapshots" : 12345,
"minuteOfHour" : 12345,
"hoursForHourlySnapshots" : [ 12345, 12345 ],
"hourOfDay" : 12345,
"dayOfWeek" : 12345,
"dayOfMonth" : 12345,
"monthOfYear" : 12345,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true,
"hbaseArguments" : { },
"hdfsArguments" : { },
"ozoneArguments" : { },
"lastCommand" : { },
"lastSuccessfulCommand" : { },
"paused" : true
} ],
"entityStatus" : "UNKNOWN_HEALTH",
"tags" : [ {
"name" : "...",
"value" : "..."
}, {
"name" : "...",
"value" : "..."
} ],
"serviceVersion" : "..."
} ],
"parcels" : [ {
"product" : "...",
"version" : "...",
"stage" : "...",
"state" : {
"progress" : 12345,
"totalProgress" : 12345,
"count" : 12345,
"totalCount" : 12345,
"errors" : [ "...", "..." ],
"warnings" : [ "...", "..." ]
},
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"displayName" : "...",
"description" : "..."
}, {
"product" : "...",
"version" : "...",
"stage" : "...",
"state" : {
"progress" : 12345,
"totalProgress" : 12345,
"count" : 12345,
"totalCount" : 12345,
"errors" : [ "...", "..." ],
"warnings" : [ "...", "..." ]
},
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"displayName" : "...",
"description" : "..."
} ],
"clusterUrl" : "...",
"hostsUrl" : "...",
"entityStatus" : "STARTING",
"uuid" : "...",
"dataContextRefs" : [ {
"name" : "..."
}, {
"name" : "..."
} ],
"clusterType" : "...",
"tags" : [ {
"name" : "...",
"value" : "..."
}, {
"name" : "...",
"value" : "..."
} ]
}