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.
The health summary is still available, and reflects a service-wide summary.
name | data type | description |
---|---|---|
name | string | The name of the service. |
type | string | The type of the service, e.g. HDFS, MAPREDUCE, HBASE. |
clusterRef | ApiClusterRef | Readonly. A reference to the enclosing cluster. |
serviceState | ApiServiceState | Readonly. The configured run state of this service. Whether it's running, etc. |
healthSummary | ApiHealthSummary | Readonly. The high-level health status of this service. |
|
|
|
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 | 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 ApiHealthCheck | Readonly. The list of health checks of this service. |
serviceUrl | string | Readonly. Link into the Cloudera Manager web UI for this specific service. |
roleInstancesUrl | string | Readonly. Link into the Cloudera Manager web UI for role instances table for this specific service. Available since API v11. |
maintenanceMode | boolean | Readonly. Whether the service is in maintenance mode. Available since API v2. |
maintenanceOwners | array of ApiEntityType | Readonly. The list of objects that trigger this service to be in maintenance mode. Available since API v2. |
config | ApiServiceConfig | Configuration of the service being created. Optional. |
roles | array of ApiRole | The list of service roles. Optional. |
displayName | string | The display name for the service that is shown in the UI. Available since API v2. |
roleConfigGroups | array of ApiRoleConfigGroup | The list of role configuration groups in this service. Optional. Available since API v3. |
replicationSchedules | array of ApiReplicationSchedule | The list of replication schedules for this service. Optional. Available since API v6. |
snapshotPolicies | array of ApiSnapshotPolicy | The list of snapshot policies for this service. Optional. Available since API v6. |
entityStatus | ApiEntityStatus | Readonly. The entity status for this service. Available since API v11. |
tags | array of ApiEntityTag | Tags associated with the service. Available since V41. |
serviceVersion | string | Service version (optional) Available since V41. |
Example
{ "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "STARTING", "healthSummary" : "CONCERNING", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "CLUSTER" ], "config" : { "roleTypeConfigs" : [ { "roleType" : "...", "items" : [ { }, { } ] }, { "roleType" : "...", "items" : [ { }, { } ] } ], "items" : [ { "name" : "...", "value" : "...", "required" : true, "default" : "...", "displayName" : "...", "description" : "...", "relatedName" : "...", "sensitive" : true, "validationState" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true }, { "name" : "...", "value" : "...", "required" : true, "default" : "...", "displayName" : "...", "description" : "...", "relatedName" : "...", "sensitive" : true, "validationState" : "OK", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "STOPPED", "commissionState" : "COMMISSIONED", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "ROLE" ], "config" : { "items" : [ { }, { } ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_OBSERVER", "entityStatus" : "CONCERNING_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "STARTING", "commissionState" : "OFFLINING", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true } ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "CLUSTER" ], "config" : { "items" : [ { }, { } ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_OBSERVER", "entityStatus" : "STOPPED", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ], "displayName" : "...", "roleConfigGroups" : [ { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ { }, { } ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } }, { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ { }, { } ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } } ], "replicationSchedules" : [ { "hdfsArguments" : { "sourceService" : { }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "numFetchThreads" : 12345, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : { }, "tableFilters" : [ { }, { } ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : { }, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : { }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "numFetchThreads" : 12345, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "replicationType" : "INCREMENTAL_ONLY", "sourceService" : { }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "numFetchThreads" : 12345, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : { }, "ozoneResult" : { }, "hiveResult" : { }, "hiveOnTezResult" : { }, "hbaseInfo" : { }, "rangerResult" : { }, "icebergResult" : { }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { }, "serviceRef" : { }, "roleRef" : { }, "hostRef" : { }, "parent" : { }, "children" : { }, "canRetry" : true }, { "hdfsResult" : { }, "ozoneResult" : { }, "hiveResult" : { }, "hiveOnTezResult" : { }, "hbaseInfo" : { }, "rangerResult" : { }, "icebergResult" : { }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { }, "serviceRef" : { }, "roleRef" : { }, "hostRef" : { }, "parent" : { }, "children" : { }, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "METADATA_AND_DATA", "sourceService" : { }, "tableFilters" : [ { }, { } ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : { }, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : { }, "peerState" : "ENABLED", "hbasePeerId" : "...", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ { }, { } ], "database" : { }, "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : { }, "status" : "DISABLED", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : { }, "remoteDbParams" : "..." }, "rangerArguments" : { "sourceRangerService" : { }, "exportArgs" : { }, "transformArgs" : { }, "importArgs" : { }, "auditLogDistCpArgs" : { } }, "icebergArguments" : { "sourceIcebergReplicationService" : { }, "policyName" : "...", "includedTableFilters" : [ { }, { } ], "excludedTableFilters" : [ { }, { } ], "batchSize" : 12345, "exportYarnOptions" : { }, "xferYarnOptions" : { }, "syncYarnOptions" : { } }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "MINUTE", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : { "sourceService" : { }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "numFetchThreads" : 12345, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : { }, "tableFilters" : [ { }, { } ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : { }, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : { }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "numFetchThreads" : 12345, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "replicationType" : "INCREMENTAL_ONLY", "sourceService" : { }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "numFetchThreads" : 12345, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : { }, "ozoneResult" : { }, "hiveResult" : { }, "hiveOnTezResult" : { }, "hbaseInfo" : { }, "rangerResult" : { }, "icebergResult" : { }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { }, "serviceRef" : { }, "roleRef" : { }, "hostRef" : { }, "parent" : { }, "children" : { }, "canRetry" : true }, { "hdfsResult" : { }, "ozoneResult" : { }, "hiveResult" : { }, "hiveOnTezResult" : { }, "hbaseInfo" : { }, "rangerResult" : { }, "icebergResult" : { }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { }, "serviceRef" : { }, "roleRef" : { }, "hostRef" : { }, "parent" : { }, "children" : { }, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "METADATA_AND_DATA", "sourceService" : { }, "tableFilters" : [ { }, { } ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : { }, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : { }, "peerState" : "ENABLED", "hbasePeerId" : "...", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ { }, { } ], "database" : { }, "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : { }, "status" : "DISABLED", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : { }, "remoteDbParams" : "..." }, "rangerArguments" : { "sourceRangerService" : { }, "exportArgs" : { }, "transformArgs" : { }, "importArgs" : { }, "auditLogDistCpArgs" : { } }, "icebergArguments" : { "sourceIcebergReplicationService" : { }, "policyName" : "...", "includedTableFilters" : [ { }, { } ], "excludedTableFilters" : [ { }, { } ], "batchSize" : 12345, "exportYarnOptions" : { }, "xferYarnOptions" : { }, "syncYarnOptions" : { } }, "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" : { "tableRegExps" : [ "...", "..." ], "storage" : "LOCAL" }, "hdfsArguments" : { "pathPatterns" : [ "...", "..." ] }, "ozoneArguments" : { "buckets" : [ { }, { } ] }, "lastCommand" : { "hbaseResult" : { }, "hdfsResult" : { }, "ozoneResult" : { }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { }, "serviceRef" : { }, "roleRef" : { }, "hostRef" : { }, "parent" : { }, "children" : { }, "canRetry" : true }, "lastSuccessfulCommand" : { "hbaseResult" : { }, "hdfsResult" : { }, "ozoneResult" : { }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { }, "serviceRef" : { }, "roleRef" : { }, "hostRef" : { }, "parent" : { }, "children" : { }, "canRetry" : true }, "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" : { "tableRegExps" : [ "...", "..." ], "storage" : "LOCAL" }, "hdfsArguments" : { "pathPatterns" : [ "...", "..." ] }, "ozoneArguments" : { "buckets" : [ { }, { } ] }, "lastCommand" : { "hbaseResult" : { }, "hdfsResult" : { }, "ozoneResult" : { }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { }, "serviceRef" : { }, "roleRef" : { }, "hostRef" : { }, "parent" : { }, "children" : { }, "canRetry" : true }, "lastSuccessfulCommand" : { "hbaseResult" : { }, "hdfsResult" : { }, "ozoneResult" : { }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { }, "serviceRef" : { }, "roleRef" : { }, "hostRef" : { }, "parent" : { }, "children" : { }, "canRetry" : true }, "paused" : true } ], "entityStatus" : "BAD_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." }