ApiHostList Data Model

A list of ApiHost objects

Properties
name data type description
items array of ApiHost

Example

{
  "items" : [ {
    "hostId" : "...",
    "ipAddress" : "...",
    "hostname" : "...",
    "rackId" : "...",
    "lastHeartbeat" : "...",
    "roleRefs" : [ {
      "clusterName" : "...",
      "serviceName" : "...",
      "roleName" : "..."
    }, {
      "clusterName" : "...",
      "serviceName" : "...",
      "roleName" : "..."
    } ],
    "healthSummary" : "NOT_AVAILABLE",
    "healthChecks" : [ {
      "name" : "...",
      "summary" : "HISTORY_NOT_AVAILABLE",
      "explanation" : "...",
      "suppressed" : true
    }, {
      "name" : "...",
      "summary" : "DISABLED",
      "explanation" : "...",
      "suppressed" : true
    } ],
    "hostUrl" : "...",
    "maintenanceMode" : true,
    "commissionState" : "DECOMMISSIONING",
    "maintenanceOwners" : [ "HOST", "SERVICE" ],
    "config" : {
      "items" : [ { }, { } ]
    },
    "numCores" : 12345,
    "numPhysicalCores" : 12345,
    "totalPhysMemBytes" : 12345,
    "entityStatus" : "UNKNOWN_HEALTH",
    "clusterRef" : {
      "clusterName" : "...",
      "displayName" : "..."
    }
  }, {
    "hostId" : "...",
    "ipAddress" : "...",
    "hostname" : "...",
    "rackId" : "...",
    "lastHeartbeat" : "...",
    "roleRefs" : [ {
      "clusterName" : "...",
      "serviceName" : "...",
      "roleName" : "..."
    }, {
      "clusterName" : "...",
      "serviceName" : "...",
      "roleName" : "..."
    } ],
    "healthSummary" : "DISABLED",
    "healthChecks" : [ {
      "name" : "...",
      "summary" : "HISTORY_NOT_AVAILABLE",
      "explanation" : "...",
      "suppressed" : true
    }, {
      "name" : "...",
      "summary" : "GOOD",
      "explanation" : "...",
      "suppressed" : true
    } ],
    "hostUrl" : "...",
    "maintenanceMode" : true,
    "commissionState" : "COMMISSIONED",
    "maintenanceOwners" : [ "CLUSTER", "ROLE" ],
    "config" : {
      "items" : [ { }, { } ]
    },
    "numCores" : 12345,
    "numPhysicalCores" : 12345,
    "totalPhysMemBytes" : 12345,
    "entityStatus" : "NONE",
    "clusterRef" : {
      "clusterName" : "...",
      "displayName" : "..."
    }
  } ]
}