ApiRoleList Data Model

A list of roles.

Properties
name data type description
items array of ApiRole

Example

{
  "items" : [ {
    "name" : "...",
    "type" : "...",
    "hostRef" : {
      "hostId" : "..."
    },
    "serviceRef" : {
      "peerName" : "...",
      "clusterName" : "...",
      "serviceName" : "..."
    },
    "roleState" : "STOPPING",
    "commissionState" : "DECOMMISSIONED",
    "healthSummary" : "NOT_AVAILABLE",
    "configStalenessStatus" : "FRESH",
    "healthChecks" : [ {
      "name" : "...",
      "summary" : "CONCERNING",
      "explanation" : "...",
      "suppressed" : true
    }, {
      "name" : "...",
      "summary" : "CONCERNING",
      "explanation" : "...",
      "suppressed" : true
    } ],
    "haStatus" : "UNKNOWN",
    "roleUrl" : "...",
    "maintenanceMode" : true,
    "maintenanceOwners" : [ "CLUSTER", "CLUSTER" ],
    "config" : {
      "items" : [ { }, { } ]
    },
    "roleConfigGroupRef" : {
      "roleConfigGroupName" : "..."
    },
    "zooKeeperServerMode" : "REPLICATED_OBSERVER",
    "entityStatus" : "BAD_HEALTH"
  }, {
    "name" : "...",
    "type" : "...",
    "hostRef" : {
      "hostId" : "..."
    },
    "serviceRef" : {
      "peerName" : "...",
      "clusterName" : "...",
      "serviceName" : "..."
    },
    "roleState" : "STARTING",
    "commissionState" : "UNKNOWN",
    "healthSummary" : "CONCERNING",
    "configStalenessStatus" : "STALE_REFRESHABLE",
    "healthChecks" : [ {
      "name" : "...",
      "summary" : "HISTORY_NOT_AVAILABLE",
      "explanation" : "...",
      "suppressed" : true
    }, {
      "name" : "...",
      "summary" : "HISTORY_NOT_AVAILABLE",
      "explanation" : "...",
      "suppressed" : true
    } ],
    "haStatus" : "ACTIVE",
    "roleUrl" : "...",
    "maintenanceMode" : true,
    "maintenanceOwners" : [ "ROLE", "HOST" ],
    "config" : {
      "items" : [ { }, { } ]
    },
    "roleConfigGroupRef" : {
      "roleConfigGroupName" : "..."
    },
    "zooKeeperServerMode" : "REPLICATED_OBSERVER",
    "entityStatus" : "DOWN"
  } ]
}