# ApiServiceList Data Model

A list of services.

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

Example

    {
      "items" : [ {
        "name" : "...",
        "type" : "...",
        "clusterRef" : {
          "clusterName" : "...",
          "displayName" : "..."
        },
        "serviceState" : "STOPPING",
        "healthSummary" : "GOOD",
        "configStalenessStatus" : "FRESH",
        "clientConfigStalenessStatus" : "STALE_REFRESHABLE",
        "healthChecks" : [ {
          "name" : "...",
          "summary" : "HISTORY_NOT_AVAILABLE",
          "explanation" : "...",
          "suppressed" : true
        }, {
          "name" : "...",
          "summary" : "NOT_AVAILABLE",
          "explanation" : "...",
          "suppressed" : true
        } ],
        "serviceUrl" : "...",
        "roleInstancesUrl" : "...",
        "maintenanceMode" : true,
        "maintenanceOwners" : [ "CONTROL_PLANE", "SERVICE" ],
        "config" : {
          "roleTypeConfigs" : [ { }, { } ],
          "items" : [ { }, { } ]
        },
        "roles" : [ {
          "name" : "...",
          "type" : "...",
          "hostRef" : { },
          "serviceRef" : { },
          "roleState" : "STARTED",
          "commissionState" : "OFFLINING",
          "healthSummary" : "HISTORY_NOT_AVAILABLE",
          "configStalenessStatus" : "STALE_REFRESHABLE",
          "healthChecks" : [ { }, { } ],
          "haStatus" : "UNKNOWN",
          "roleUrl" : "...",
          "maintenanceMode" : true,
          "maintenanceOwners" : [ "ROLE", "SERVICE" ],
          "config" : { },
          "roleConfigGroupRef" : { },
          "zooKeeperServerMode" : "REPLICATED_OBSERVER",
          "entityStatus" : "UNKNOWN",
          "tags" : [ { }, { } ]
        }, {
          "name" : "...",
          "type" : "...",
          "hostRef" : { },
          "serviceRef" : { },
          "roleState" : "NA",
          "commissionState" : "OFFLINING",
          "healthSummary" : "DISABLED",
          "configStalenessStatus" : "FRESH",
          "healthChecks" : [ { }, { } ],
          "haStatus" : "ACTIVE",
          "roleUrl" : "...",
          "maintenanceMode" : true,
          "maintenanceOwners" : [ "ROLE", "CONTROL_PLANE" ],
          "config" : { },
          "roleConfigGroupRef" : { },
          "zooKeeperServerMode" : "REPLICATED_LEADER",
          "entityStatus" : "DOWN",
          "tags" : [ { }, { } ]
        } ],
        "displayName" : "...",
        "roleConfigGroups" : [ {
          "name" : "...",
          "roleType" : "...",
          "base" : true,
          "config" : { },
          "displayName" : "...",
          "serviceRef" : { }
        }, {
          "name" : "...",
          "roleType" : "...",
          "base" : true,
          "config" : { },
          "displayName" : "...",
          "serviceRef" : { }
        } ],
        "replicationSchedules" : [ {
          "hdfsArguments" : { },
          "hiveArguments" : { },
          "hdfsCloudArguments" : { },
          "ozoneReplicationArguments" : { },
          "history" : [ { }, { } ],
          "active" : true,
          "hiveCloudArguments" : { },
          "hbaseArguments" : { },
          "hive3Arguments" : { },
          "rangerArguments" : { },
          "icebergArguments" : { },
          "atlasReplicationArguments" : { },
          "id" : 12345,
          "displayName" : "...",
          "description" : "...",
          "startTime" : "...",
          "endTime" : "...",
          "interval" : 12345,
          "intervalUnit" : "HOUR",
          "nextRun" : "...",
          "paused" : true,
          "alertOnStart" : true,
          "alertOnSuccess" : true,
          "alertOnFail" : true,
          "alertOnAbort" : true
        }, {
          "hdfsArguments" : { },
          "hiveArguments" : { },
          "hdfsCloudArguments" : { },
          "ozoneReplicationArguments" : { },
          "history" : [ { }, { } ],
          "active" : true,
          "hiveCloudArguments" : { },
          "hbaseArguments" : { },
          "hive3Arguments" : { },
          "rangerArguments" : { },
          "icebergArguments" : { },
          "atlasReplicationArguments" : { },
          "id" : 12345,
          "displayName" : "...",
          "description" : "...",
          "startTime" : "...",
          "endTime" : "...",
          "interval" : 12345,
          "intervalUnit" : "DAY",
          "nextRun" : "...",
          "paused" : true,
          "alertOnStart" : true,
          "alertOnSuccess" : true,
          "alertOnFail" : true,
          "alertOnAbort" : true
        } ],
        "snapshotPolicies" : [ {
          "name" : "...",
          "description" : "...",
          "hourlySnapshots" : 12345,
          "dailySnapshots" : 12345,
          "weeklySnapshots" : 12345,
          "monthlySnapshots" : 12345,
          "yearlySnapshots" : 12345,
          "minuteOfHour" : 12345,
          "hoursForHourlySnapshots" : [ 12345, 12345 ],
          "hourOfDay" : 12345,
          "dayOfWeek" : 12345,
          "dayOfMonth" : 12345,
          "monthOfYear" : 12345,
          "alertOnStart" : true,
          "alertOnSuccess" : true,
          "alertOnFail" : true,
          "alertOnAbort" : true,
          "hbaseArguments" : { },
          "hdfsArguments" : { },
          "ozoneArguments" : { },
          "lastCommand" : { },
          "lastSuccessfulCommand" : { },
          "paused" : true
        }, {
          "name" : "...",
          "description" : "...",
          "hourlySnapshots" : 12345,
          "dailySnapshots" : 12345,
          "weeklySnapshots" : 12345,
          "monthlySnapshots" : 12345,
          "yearlySnapshots" : 12345,
          "minuteOfHour" : 12345,
          "hoursForHourlySnapshots" : [ 12345, 12345 ],
          "hourOfDay" : 12345,
          "dayOfWeek" : 12345,
          "dayOfMonth" : 12345,
          "monthOfYear" : 12345,
          "alertOnStart" : true,
          "alertOnSuccess" : true,
          "alertOnFail" : true,
          "alertOnAbort" : true,
          "hbaseArguments" : { },
          "hdfsArguments" : { },
          "ozoneArguments" : { },
          "lastCommand" : { },
          "lastSuccessfulCommand" : { },
          "paused" : true
        } ],
        "entityStatus" : "DOWN",
        "tags" : [ {
          "name" : "...",
          "value" : "..."
        }, {
          "name" : "...",
          "value" : "..."
        } ],
        "serviceVersion" : "..."
      }, {
        "name" : "...",
        "type" : "...",
        "clusterRef" : {
          "clusterName" : "...",
          "displayName" : "..."
        },
        "serviceState" : "STARTING",
        "healthSummary" : "BAD",
        "configStalenessStatus" : "STALE_REFRESHABLE",
        "clientConfigStalenessStatus" : "FRESH",
        "healthChecks" : [ {
          "name" : "...",
          "summary" : "GOOD",
          "explanation" : "...",
          "suppressed" : true
        }, {
          "name" : "...",
          "summary" : "CONCERNING",
          "explanation" : "...",
          "suppressed" : true
        } ],
        "serviceUrl" : "...",
        "roleInstancesUrl" : "...",
        "maintenanceMode" : true,
        "maintenanceOwners" : [ "CONTROL_PLANE", "ROLE" ],
        "config" : {
          "roleTypeConfigs" : [ { }, { } ],
          "items" : [ { }, { } ]
        },
        "roles" : [ {
          "name" : "...",
          "type" : "...",
          "hostRef" : { },
          "serviceRef" : { },
          "roleState" : "BUSY",
          "commissionState" : "OFFLINING",
          "healthSummary" : "BAD",
          "configStalenessStatus" : "FRESH",
          "healthChecks" : [ { }, { } ],
          "haStatus" : "ACTIVE",
          "roleUrl" : "...",
          "maintenanceMode" : true,
          "maintenanceOwners" : [ "ROLE", "HOST" ],
          "config" : { },
          "roleConfigGroupRef" : { },
          "zooKeeperServerMode" : "REPLICATED_OBSERVER",
          "entityStatus" : "NONE",
          "tags" : [ { }, { } ]
        }, {
          "name" : "...",
          "type" : "...",
          "hostRef" : { },
          "serviceRef" : { },
          "roleState" : "STOPPING",
          "commissionState" : "DECOMMISSIONING",
          "healthSummary" : "GOOD",
          "configStalenessStatus" : "FRESH",
          "healthChecks" : [ { }, { } ],
          "haStatus" : "UNKNOWN",
          "roleUrl" : "...",
          "maintenanceMode" : true,
          "maintenanceOwners" : [ "CONTROL_PLANE", "CLUSTER" ],
          "config" : { },
          "roleConfigGroupRef" : { },
          "zooKeeperServerMode" : "REPLICATED_LEADER",
          "entityStatus" : "STOPPED",
          "tags" : [ { }, { } ]
        } ],
        "displayName" : "...",
        "roleConfigGroups" : [ {
          "name" : "...",
          "roleType" : "...",
          "base" : true,
          "config" : { },
          "displayName" : "...",
          "serviceRef" : { }
        }, {
          "name" : "...",
          "roleType" : "...",
          "base" : true,
          "config" : { },
          "displayName" : "...",
          "serviceRef" : { }
        } ],
        "replicationSchedules" : [ {
          "hdfsArguments" : { },
          "hiveArguments" : { },
          "hdfsCloudArguments" : { },
          "ozoneReplicationArguments" : { },
          "history" : [ { }, { } ],
          "active" : true,
          "hiveCloudArguments" : { },
          "hbaseArguments" : { },
          "hive3Arguments" : { },
          "rangerArguments" : { },
          "icebergArguments" : { },
          "atlasReplicationArguments" : { },
          "id" : 12345,
          "displayName" : "...",
          "description" : "...",
          "startTime" : "...",
          "endTime" : "...",
          "interval" : 12345,
          "intervalUnit" : "HOUR",
          "nextRun" : "...",
          "paused" : true,
          "alertOnStart" : true,
          "alertOnSuccess" : true,
          "alertOnFail" : true,
          "alertOnAbort" : true
        }, {
          "hdfsArguments" : { },
          "hiveArguments" : { },
          "hdfsCloudArguments" : { },
          "ozoneReplicationArguments" : { },
          "history" : [ { }, { } ],
          "active" : true,
          "hiveCloudArguments" : { },
          "hbaseArguments" : { },
          "hive3Arguments" : { },
          "rangerArguments" : { },
          "icebergArguments" : { },
          "atlasReplicationArguments" : { },
          "id" : 12345,
          "displayName" : "...",
          "description" : "...",
          "startTime" : "...",
          "endTime" : "...",
          "interval" : 12345,
          "intervalUnit" : "HOUR",
          "nextRun" : "...",
          "paused" : true,
          "alertOnStart" : true,
          "alertOnSuccess" : true,
          "alertOnFail" : true,
          "alertOnAbort" : true
        } ],
        "snapshotPolicies" : [ {
          "name" : "...",
          "description" : "...",
          "hourlySnapshots" : 12345,
          "dailySnapshots" : 12345,
          "weeklySnapshots" : 12345,
          "monthlySnapshots" : 12345,
          "yearlySnapshots" : 12345,
          "minuteOfHour" : 12345,
          "hoursForHourlySnapshots" : [ 12345, 12345 ],
          "hourOfDay" : 12345,
          "dayOfWeek" : 12345,
          "dayOfMonth" : 12345,
          "monthOfYear" : 12345,
          "alertOnStart" : true,
          "alertOnSuccess" : true,
          "alertOnFail" : true,
          "alertOnAbort" : true,
          "hbaseArguments" : { },
          "hdfsArguments" : { },
          "ozoneArguments" : { },
          "lastCommand" : { },
          "lastSuccessfulCommand" : { },
          "paused" : true
        }, {
          "name" : "...",
          "description" : "...",
          "hourlySnapshots" : 12345,
          "dailySnapshots" : 12345,
          "weeklySnapshots" : 12345,
          "monthlySnapshots" : 12345,
          "yearlySnapshots" : 12345,
          "minuteOfHour" : 12345,
          "hoursForHourlySnapshots" : [ 12345, 12345 ],
          "hourOfDay" : 12345,
          "dayOfWeek" : 12345,
          "dayOfMonth" : 12345,
          "monthOfYear" : 12345,
          "alertOnStart" : true,
          "alertOnSuccess" : true,
          "alertOnFail" : true,
          "alertOnAbort" : true,
          "hbaseArguments" : { },
          "hdfsArguments" : { },
          "ozoneArguments" : { },
          "lastCommand" : { },
          "lastSuccessfulCommand" : { },
          "paused" : true
        } ],
        "entityStatus" : "DISABLED_HEALTH",
        "tags" : [ {
          "name" : "...",
          "value" : "..."
        }, {
          "name" : "...",
          "value" : "..."
        } ],
        "serviceVersion" : "..."
      } ]
    }