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" : "...",
      "serviceName" : "...",
      "serviceDisplayName" : "...",
      "serviceType" : "..."
    },
    "roleState" : "BUSY",
    "commissionState" : "UNKNOWN",
    "healthSummary" : "DISABLED",
    "configStalenessStatus" : "STALE_REFRESHABLE",
    "healthChecks" : [ {
      "name" : "...",
      "summary" : "BAD",
      "explanation" : "...",
      "suppressed" : true
    }, {
      "name" : "...",
      "summary" : "BAD",
      "explanation" : "...",
      "suppressed" : true
    } ],
    "haStatus" : "ACTIVE",
    "roleUrl" : "...",
    "maintenanceMode" : true,
    "maintenanceOwners" : [ "SERVICE", "SERVICE" ],
    "config" : {
      "items" : [ { }, { } ]
    },
    "roleConfigGroupRef" : {
      "roleConfigGroupName" : "..."
    },
    "zooKeeperServerMode" : "UNKNOWN",
    "entityStatus" : "DOWN",
    "tags" : [ {
      "name" : "...",
      "value" : "..."
    }, {
      "name" : "...",
      "value" : "..."
    } ]
  }, {
    "name" : "...",
    "type" : "...",
    "hostRef" : {
      "hostId" : "...",
      "hostname" : "..."
    },
    "serviceRef" : {
      "peerName" : "...",
      "clusterName" : "...",
      "serviceName" : "...",
      "serviceDisplayName" : "...",
      "serviceType" : "..."
    },
    "roleState" : "NA",
    "commissionState" : "OFFLINED",
    "healthSummary" : "NOT_AVAILABLE",
    "configStalenessStatus" : "STALE_REFRESHABLE",
    "healthChecks" : [ {
      "name" : "...",
      "summary" : "CONCERNING",
      "explanation" : "...",
      "suppressed" : true
    }, {
      "name" : "...",
      "summary" : "HISTORY_NOT_AVAILABLE",
      "explanation" : "...",
      "suppressed" : true
    } ],
    "haStatus" : "ACTIVE",
    "roleUrl" : "...",
    "maintenanceMode" : true,
    "maintenanceOwners" : [ "CONTROL_PLANE", "CLUSTER" ],
    "config" : {
      "items" : [ { }, { } ]
    },
    "roleConfigGroupRef" : {
      "roleConfigGroupName" : "..."
    },
    "zooKeeperServerMode" : "STANDALONE",
    "entityStatus" : "CONCERNING_HEALTH",
    "tags" : [ {
      "name" : "...",
      "value" : "..."
    }, {
      "name" : "...",
      "value" : "..."
    } ]
  } ]
}