ApiService Data Model

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.

Properties
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.
configStale boolean Readonly. Expresses whether the service configuration is stale.
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" : "NA",
  "healthSummary" : "CONCERNING",
  "configStalenessStatus" : "STALE_REFRESHABLE",
  "clientConfigStalenessStatus" : "STALE",
  "healthChecks" : [ {
    "name" : "...",
    "summary" : "BAD",
    "explanation" : "...",
    "suppressed" : true
  }, {
    "name" : "...",
    "summary" : "BAD",
    "explanation" : "...",
    "suppressed" : true
  } ],
  "serviceUrl" : "...",
  "roleInstancesUrl" : "...",
  "maintenanceMode" : true,
  "maintenanceOwners" : [ "ROLE", "ROLE" ],
  "config" : {
    "roleTypeConfigs" : [ {
      "roleType" : "...",
      "items" : [ { }, { } ]
    }, {
      "roleType" : "...",
      "items" : [ { }, { } ]
    } ],
    "items" : [ {
      "name" : "...",
      "value" : "...",
      "required" : true,
      "default" : "...",
      "displayName" : "...",
      "description" : "...",
      "relatedName" : "...",
      "sensitive" : true,
      "validationState" : "OK",
      "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" : "HISTORY_NOT_AVAILABLE",
    "commissionState" : "OFFLINED",
    "healthSummary" : "BAD",
    "configStalenessStatus" : "STALE_REFRESHABLE",
    "healthChecks" : [ {
      "name" : "...",
      "summary" : "HISTORY_NOT_AVAILABLE",
      "explanation" : "...",
      "suppressed" : true
    }, {
      "name" : "...",
      "summary" : "DISABLED",
      "explanation" : "...",
      "suppressed" : true
    } ],
    "haStatus" : "ACTIVE",
    "roleUrl" : "...",
    "maintenanceMode" : true,
    "maintenanceOwners" : [ "HOST", "HOST" ],
    "config" : {
      "items" : [ { }, { } ]
    },
    "roleConfigGroupRef" : {
      "roleConfigGroupName" : "..."
    },
    "zooKeeperServerMode" : "STANDALONE",
    "entityStatus" : "UNKNOWN_HEALTH",
    "tags" : [ {
      "name" : "...",
      "value" : "..."
    }, {
      "name" : "...",
      "value" : "..."
    } ]
  }, {
    "name" : "...",
    "type" : "...",
    "hostRef" : {
      "hostId" : "...",
      "hostname" : "..."
    },
    "serviceRef" : {
      "peerName" : "...",
      "clusterName" : "...",
      "serviceName" : "...",
      "serviceDisplayName" : "...",
      "serviceType" : "..."
    },
    "roleState" : "STARTED",
    "commissionState" : "DECOMMISSIONED",
    "healthSummary" : "HISTORY_NOT_AVAILABLE",
    "configStalenessStatus" : "FRESH",
    "healthChecks" : [ {
      "name" : "...",
      "summary" : "CONCERNING",
      "explanation" : "...",
      "suppressed" : true
    }, {
      "name" : "...",
      "summary" : "GOOD",
      "explanation" : "...",
      "suppressed" : true
    } ],
    "haStatus" : "STANDBY",
    "roleUrl" : "...",
    "maintenanceMode" : true,
    "maintenanceOwners" : [ "ROLE", "CLUSTER" ],
    "config" : {
      "items" : [ { }, { } ]
    },
    "roleConfigGroupRef" : {
      "roleConfigGroupName" : "..."
    },
    "zooKeeperServerMode" : "REPLICATED_LEADER_ELECTION",
    "entityStatus" : "CONCERNING_HEALTH",
    "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" : "DYNAMIC",
      "preserveXAttrs" : true,
      "exclusionFilters" : [ "...", "..." ],
      "raiseSnapshotDiffFailures" : true,
      "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,
      "destinationCloudAccount" : "..."
    },
    "history" : [ {
      "hdfsResult" : { },
      "hiveResult" : { },
      "hiveOnTezResult" : { },
      "id" : 12345,
      "name" : "...",
      "startTime" : "...",
      "endTime" : "...",
      "active" : true,
      "success" : true,
      "resultMessage" : "...",
      "resultDataUrl" : "...",
      "clusterRef" : { },
      "serviceRef" : { },
      "roleRef" : { },
      "hostRef" : { },
      "parent" : { },
      "children" : { },
      "canRetry" : true
    }, {
      "hdfsResult" : { },
      "hiveResult" : { },
      "hiveOnTezResult" : { },
      "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" : "KEEP_DATA_IN_CLOUD",
      "sourceService" : { },
      "tableFilters" : [ { }, { } ],
      "exportDir" : "...",
      "force" : true,
      "replicateData" : true,
      "hdfsArguments" : { },
      "replicateImpalaMetadata" : true,
      "runInvalidateMetadata" : true,
      "dryRun" : true,
      "numThreads" : 12345,
      "sentryMigration" : true,
      "skipUrlPermissions" : true
    },
    "hbaseArguments" : {
      "sourceHBaseService" : { },
      "targetPeerId" : 12345,
      "peerState" : "DISABLED",
      "targetClusterKey" : "...",
      "endPointClassName" : "...",
      "namespaces" : [ "...", "..." ],
      "tables" : [ "...", "..." ],
      "replicationProperties" : {
        "property1" : "...",
        "property2" : "..."
      }
    },
    "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
    },
    "id" : 12345,
    "displayName" : "...",
    "description" : "...",
    "startTime" : "...",
    "endTime" : "...",
    "interval" : 12345,
    "intervalUnit" : "MONTH",
    "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" : "STATIC",
      "preserveXAttrs" : true,
      "exclusionFilters" : [ "...", "..." ],
      "raiseSnapshotDiffFailures" : true,
      "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,
      "destinationCloudAccount" : "..."
    },
    "history" : [ {
      "hdfsResult" : { },
      "hiveResult" : { },
      "hiveOnTezResult" : { },
      "id" : 12345,
      "name" : "...",
      "startTime" : "...",
      "endTime" : "...",
      "active" : true,
      "success" : true,
      "resultMessage" : "...",
      "resultDataUrl" : "...",
      "clusterRef" : { },
      "serviceRef" : { },
      "roleRef" : { },
      "hostRef" : { },
      "parent" : { },
      "children" : { },
      "canRetry" : true
    }, {
      "hdfsResult" : { },
      "hiveResult" : { },
      "hiveOnTezResult" : { },
      "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" : { },
      "targetPeerId" : 12345,
      "peerState" : "DISABLED",
      "targetClusterKey" : "...",
      "endPointClassName" : "...",
      "namespaces" : [ "...", "..." ],
      "tables" : [ "...", "..." ],
      "replicationProperties" : {
        "property1" : "...",
        "property2" : "..."
      }
    },
    "hive3Arguments" : {
      "sourceHiveService" : { },
      "status" : "FAILED_ADMIN",
      "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
    },
    "id" : 12345,
    "displayName" : "...",
    "description" : "...",
    "startTime" : "...",
    "endTime" : "...",
    "interval" : 12345,
    "intervalUnit" : "WEEK",
    "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" : "REMOTE_S3"
    },
    "hdfsArguments" : {
      "pathPatterns" : [ "...", "..." ]
    },
    "lastCommand" : {
      "hbaseResult" : { },
      "hdfsResult" : { },
      "id" : 12345,
      "name" : "...",
      "startTime" : "...",
      "endTime" : "...",
      "active" : true,
      "success" : true,
      "resultMessage" : "...",
      "resultDataUrl" : "...",
      "clusterRef" : { },
      "serviceRef" : { },
      "roleRef" : { },
      "hostRef" : { },
      "parent" : { },
      "children" : { },
      "canRetry" : true
    },
    "lastSuccessfulCommand" : {
      "hbaseResult" : { },
      "hdfsResult" : { },
      "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" : [ "...", "..." ]
    },
    "lastCommand" : {
      "hbaseResult" : { },
      "hdfsResult" : { },
      "id" : 12345,
      "name" : "...",
      "startTime" : "...",
      "endTime" : "...",
      "active" : true,
      "success" : true,
      "resultMessage" : "...",
      "resultDataUrl" : "...",
      "clusterRef" : { },
      "serviceRef" : { },
      "roleRef" : { },
      "hostRef" : { },
      "parent" : { },
      "children" : { },
      "canRetry" : true
    },
    "lastSuccessfulCommand" : {
      "hbaseResult" : { },
      "hdfsResult" : { },
      "id" : 12345,
      "name" : "...",
      "startTime" : "...",
      "endTime" : "...",
      "active" : true,
      "success" : true,
      "resultMessage" : "...",
      "resultDataUrl" : "...",
      "clusterRef" : { },
      "serviceRef" : { },
      "roleRef" : { },
      "hostRef" : { },
      "parent" : { },
      "children" : { },
      "canRetry" : true
    },
    "paused" : true
  } ],
  "entityStatus" : "CONCERNING_HEALTH",
  "tags" : [ {
    "name" : "...",
    "value" : "..."
  }, {
    "name" : "...",
    "value" : "..."
  } ],
  "serviceVersion" : "..."
}