# ApiNameservice Data Model

Provides information about an HDFS nameservice.

Nameservices can be either a stand-alone NameNode, a NameNode paired with a SecondaryNameNode, or a high-availability pair formed by an active and a stand-by NameNode.

The following fields are only available in the object's full view:

- healthSummary
- healthChecks

Properties
name | data type | description
--- | --- | ---
name | string | Name of the nameservice.
active | ApiRoleRef | Reference to the active NameNode.
activeFailoverController | ApiRoleRef | Reference to the active NameNode's failover controller, if configured.
standBy | ApiRoleRef | Reference to the stand-by NameNode.
standByFailoverController | ApiRoleRef | Reference to the stand-by NameNode's failover controller, if configured.
secondary | ApiRoleRef | Reference to the SecondaryNameNode.
mountPoints | array of string | Mount points assigned to this nameservice in a federation.
healthSummary | ApiHealthSummary | Requires "full" view. The high-level health status of this nameservice.
healthChecks | array of ApiHealthCheck | Requires "full" view. List of health checks performed on the nameservice.

Example

    {
      "name" : "...",
      "active" : {
        "clusterName" : "...",
        "serviceName" : "...",
        "roleName" : "...",
        "healthSummary" : "HISTORY_NOT_AVAILABLE",
        "roleStatus" : "STARTED"
      },
      "activeFailoverController" : {
        "clusterName" : "...",
        "serviceName" : "...",
        "roleName" : "...",
        "healthSummary" : "DISABLED",
        "roleStatus" : "HISTORY_NOT_AVAILABLE"
      },
      "standBy" : {
        "clusterName" : "...",
        "serviceName" : "...",
        "roleName" : "...",
        "healthSummary" : "DISABLED",
        "roleStatus" : "HISTORY_NOT_AVAILABLE"
      },
      "standByFailoverController" : {
        "clusterName" : "...",
        "serviceName" : "...",
        "roleName" : "...",
        "healthSummary" : "HISTORY_NOT_AVAILABLE",
        "roleStatus" : "BUSY"
      },
      "secondary" : {
        "clusterName" : "...",
        "serviceName" : "...",
        "roleName" : "...",
        "healthSummary" : "CONCERNING",
        "roleStatus" : "UNKNOWN"
      },
      "mountPoints" : [ "...", "..." ],
      "healthSummary" : "NOT_AVAILABLE",
      "healthChecks" : [ {
        "name" : "...",
        "summary" : "CONCERNING",
        "explanation" : "...",
        "suppressed" : true
      }, {
        "name" : "...",
        "summary" : "CONCERNING",
        "explanation" : "...",
        "suppressed" : true
      } ]
    }