ApiClusterList Data Model

A list of clusters.

Properties
name data type description
items array of ApiCluster

Example

{
  "items" : [ {
    "name" : "...",
    "displayName" : "...",
    "fullVersion" : "...",
    "maintenanceMode" : true,
    "maintenanceOwners" : [ "CLUSTER", "ROLE" ],
    "services" : [ {
      "name" : "...",
      "type" : "...",
      "clusterRef" : { },
      "serviceState" : "NA",
      "healthSummary" : "NOT_AVAILABLE",
      "configStalenessStatus" : "FRESH",
      "clientConfigStalenessStatus" : "STALE",
      "healthChecks" : [ { }, { } ],
      "serviceUrl" : "...",
      "roleInstancesUrl" : "...",
      "maintenanceMode" : true,
      "maintenanceOwners" : [ "HOST", "SERVICE" ],
      "config" : { },
      "roles" : [ { }, { } ],
      "displayName" : "...",
      "roleConfigGroups" : [ { }, { } ],
      "replicationSchedules" : [ { }, { } ],
      "snapshotPolicies" : [ { }, { } ],
      "entityStatus" : "STOPPED"
    }, {
      "name" : "...",
      "type" : "...",
      "clusterRef" : { },
      "serviceState" : "STOPPED",
      "healthSummary" : "DISABLED",
      "configStalenessStatus" : "STALE_REFRESHABLE",
      "clientConfigStalenessStatus" : "STALE_REFRESHABLE",
      "healthChecks" : [ { }, { } ],
      "serviceUrl" : "...",
      "roleInstancesUrl" : "...",
      "maintenanceMode" : true,
      "maintenanceOwners" : [ "SERVICE", "CLUSTER" ],
      "config" : { },
      "roles" : [ { }, { } ],
      "displayName" : "...",
      "roleConfigGroups" : [ { }, { } ],
      "replicationSchedules" : [ { }, { } ],
      "snapshotPolicies" : [ { }, { } ],
      "entityStatus" : "DOWN"
    } ],
    "parcels" : [ {
      "product" : "...",
      "version" : "...",
      "stage" : "...",
      "state" : { },
      "clusterRef" : { }
    }, {
      "product" : "...",
      "version" : "...",
      "stage" : "...",
      "state" : { },
      "clusterRef" : { }
    } ],
    "clusterUrl" : "...",
    "hostsUrl" : "...",
    "entityStatus" : "CONCERNING_HEALTH",
    "uuid" : "...",
    "dataContextRefs" : [ {
      "name" : "..."
    }, {
      "name" : "..."
    } ],
    "clusterType" : "..."
  }, {
    "name" : "...",
    "displayName" : "...",
    "fullVersion" : "...",
    "maintenanceMode" : true,
    "maintenanceOwners" : [ "CLUSTER", "HOST" ],
    "services" : [ {
      "name" : "...",
      "type" : "...",
      "clusterRef" : { },
      "serviceState" : "UNKNOWN",
      "healthSummary" : "CONCERNING",
      "configStalenessStatus" : "STALE",
      "clientConfigStalenessStatus" : "STALE_REFRESHABLE",
      "healthChecks" : [ { }, { } ],
      "serviceUrl" : "...",
      "roleInstancesUrl" : "...",
      "maintenanceMode" : true,
      "maintenanceOwners" : [ "CLUSTER", "CLUSTER" ],
      "config" : { },
      "roles" : [ { }, { } ],
      "displayName" : "...",
      "roleConfigGroups" : [ { }, { } ],
      "replicationSchedules" : [ { }, { } ],
      "snapshotPolicies" : [ { }, { } ],
      "entityStatus" : "UNKNOWN_HEALTH"
    }, {
      "name" : "...",
      "type" : "...",
      "clusterRef" : { },
      "serviceState" : "UNKNOWN",
      "healthSummary" : "CONCERNING",
      "configStalenessStatus" : "STALE",
      "clientConfigStalenessStatus" : "STALE",
      "healthChecks" : [ { }, { } ],
      "serviceUrl" : "...",
      "roleInstancesUrl" : "...",
      "maintenanceMode" : true,
      "maintenanceOwners" : [ "CLUSTER", "CLUSTER" ],
      "config" : { },
      "roles" : [ { }, { } ],
      "displayName" : "...",
      "roleConfigGroups" : [ { }, { } ],
      "replicationSchedules" : [ { }, { } ],
      "snapshotPolicies" : [ { }, { } ],
      "entityStatus" : "BAD_HEALTH"
    } ],
    "parcels" : [ {
      "product" : "...",
      "version" : "...",
      "stage" : "...",
      "state" : { },
      "clusterRef" : { }
    }, {
      "product" : "...",
      "version" : "...",
      "stage" : "...",
      "state" : { },
      "clusterRef" : { }
    } ],
    "clusterUrl" : "...",
    "hostsUrl" : "...",
    "entityStatus" : "UNKNOWN",
    "uuid" : "...",
    "dataContextRefs" : [ {
      "name" : "..."
    }, {
      "name" : "..."
    } ],
    "clusterType" : "..."
  } ]
}