# ApiRoleList Data Model

A list of roles.

Properties
name | data type | description
--- | --- | ---
items | array of ApiRole |

Example

    {
      "items" : [ {
        "name" : "...",
        "type" : "...",
        "hostRef" : {
          "hostId" : "...",
          "hostname" : "..."
        },
        "serviceRef" : {
          "peerName" : "...",
          "clusterName" : "...",
          "clusterDisplayName" : "...",
          "serviceName" : "...",
          "serviceDisplayName" : "...",
          "serviceType" : "..."
        },
        "roleState" : "STOPPED",
        "commissionState" : "OFFLINED",
        "healthSummary" : "NOT_AVAILABLE",
        "configStalenessStatus" : "STALE",
        "healthChecks" : [ {
          "name" : "...",
          "summary" : "HISTORY_NOT_AVAILABLE",
          "explanation" : "...",
          "suppressed" : true
        }, {
          "name" : "...",
          "summary" : "NOT_AVAILABLE",
          "explanation" : "...",
          "suppressed" : true
        } ],
        "haStatus" : "ACTIVE",
        "roleUrl" : "...",
        "maintenanceMode" : true,
        "maintenanceOwners" : [ "CLUSTER", "SERVICE" ],
        "config" : {
          "items" : [ { }, { } ]
        },
        "roleConfigGroupRef" : {
          "roleConfigGroupName" : "..."
        },
        "zooKeeperServerMode" : "STANDALONE",
        "entityStatus" : "STOPPING",
        "tags" : [ {
          "name" : "...",
          "value" : "..."
        }, {
          "name" : "...",
          "value" : "..."
        } ]
      }, {
        "name" : "...",
        "type" : "...",
        "hostRef" : {
          "hostId" : "...",
          "hostname" : "..."
        },
        "serviceRef" : {
          "peerName" : "...",
          "clusterName" : "...",
          "clusterDisplayName" : "...",
          "serviceName" : "...",
          "serviceDisplayName" : "...",
          "serviceType" : "..."
        },
        "roleState" : "STARTED",
        "commissionState" : "OFFLINING",
        "healthSummary" : "CONCERNING",
        "configStalenessStatus" : "STALE",
        "healthChecks" : [ {
          "name" : "...",
          "summary" : "GOOD",
          "explanation" : "...",
          "suppressed" : true
        }, {
          "name" : "...",
          "summary" : "HISTORY_NOT_AVAILABLE",
          "explanation" : "...",
          "suppressed" : true
        } ],
        "haStatus" : "UNKNOWN",
        "roleUrl" : "...",
        "maintenanceMode" : true,
        "maintenanceOwners" : [ "CLUSTER", "CLUSTER" ],
        "config" : {
          "items" : [ { }, { } ]
        },
        "roleConfigGroupRef" : {
          "roleConfigGroupName" : "..."
        },
        "zooKeeperServerMode" : "UNKNOWN",
        "entityStatus" : "STOPPING",
        "tags" : [ {
          "name" : "...",
          "value" : "..."
        }, {
          "name" : "...",
          "value" : "..."
        } ]
      } ]
    }