ApiServiceList Data Model

A list of services.

Properties
name data type description
items array of ApiService

Example

{
  "items" : [ {
    "name" : "...",
    "type" : "...",
    "clusterRef" : {
      "clusterName" : "...",
      "displayName" : "..."
    },
    "serviceState" : "NA",
    "healthSummary" : "GOOD",
    "configStalenessStatus" : "STALE",
    "clientConfigStalenessStatus" : "FRESH",
    "healthChecks" : [ {
      "name" : "...",
      "summary" : "NOT_AVAILABLE",
      "explanation" : "...",
      "suppressed" : true
    }, {
      "name" : "...",
      "summary" : "HISTORY_NOT_AVAILABLE",
      "explanation" : "...",
      "suppressed" : true
    } ],
    "serviceUrl" : "...",
    "roleInstancesUrl" : "...",
    "maintenanceMode" : true,
    "maintenanceOwners" : [ "CONTROL_PLANE", "CLUSTER" ],
    "config" : {
      "roleTypeConfigs" : [ { }, { } ],
      "items" : [ { }, { } ]
    },
    "roles" : [ {
      "name" : "...",
      "type" : "...",
      "hostRef" : { },
      "serviceRef" : { },
      "roleState" : "STOPPED",
      "commissionState" : "DECOMMISSIONING",
      "healthSummary" : "BAD",
      "configStalenessStatus" : "STALE",
      "healthChecks" : [ { }, { } ],
      "haStatus" : "ACTIVE",
      "roleUrl" : "...",
      "maintenanceMode" : true,
      "maintenanceOwners" : [ "CLUSTER", "CONTROL_PLANE" ],
      "config" : { },
      "roleConfigGroupRef" : { },
      "zooKeeperServerMode" : "REPLICATED_LEADER",
      "entityStatus" : "HISTORY_NOT_AVAILABLE",
      "tags" : [ { }, { } ]
    }, {
      "name" : "...",
      "type" : "...",
      "hostRef" : { },
      "serviceRef" : { },
      "roleState" : "STARTING",
      "commissionState" : "DECOMMISSIONED",
      "healthSummary" : "CONCERNING",
      "configStalenessStatus" : "STALE",
      "healthChecks" : [ { }, { } ],
      "haStatus" : "STANDBY",
      "roleUrl" : "...",
      "maintenanceMode" : true,
      "maintenanceOwners" : [ "HOST", "HOST" ],
      "config" : { },
      "roleConfigGroupRef" : { },
      "zooKeeperServerMode" : "UNKNOWN",
      "entityStatus" : "HISTORY_NOT_AVAILABLE",
      "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" : "DAY",
      "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" : "YEAR",
      "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" : "STARTED",
    "healthSummary" : "DISABLED",
    "configStalenessStatus" : "FRESH",
    "clientConfigStalenessStatus" : "FRESH",
    "healthChecks" : [ {
      "name" : "...",
      "summary" : "BAD",
      "explanation" : "...",
      "suppressed" : true
    }, {
      "name" : "...",
      "summary" : "HISTORY_NOT_AVAILABLE",
      "explanation" : "...",
      "suppressed" : true
    } ],
    "serviceUrl" : "...",
    "roleInstancesUrl" : "...",
    "maintenanceMode" : true,
    "maintenanceOwners" : [ "CONTROL_PLANE", "SERVICE" ],
    "config" : {
      "roleTypeConfigs" : [ { }, { } ],
      "items" : [ { }, { } ]
    },
    "roles" : [ {
      "name" : "...",
      "type" : "...",
      "hostRef" : { },
      "serviceRef" : { },
      "roleState" : "STARTING",
      "commissionState" : "COMMISSIONED",
      "healthSummary" : "HISTORY_NOT_AVAILABLE",
      "configStalenessStatus" : "STALE",
      "healthChecks" : [ { }, { } ],
      "haStatus" : "STANDBY",
      "roleUrl" : "...",
      "maintenanceMode" : true,
      "maintenanceOwners" : [ "SERVICE", "HOST" ],
      "config" : { },
      "roleConfigGroupRef" : { },
      "zooKeeperServerMode" : "REPLICATED_FOLLOWER",
      "entityStatus" : "STARTING",
      "tags" : [ { }, { } ]
    }, {
      "name" : "...",
      "type" : "...",
      "hostRef" : { },
      "serviceRef" : { },
      "roleState" : "HISTORY_NOT_AVAILABLE",
      "commissionState" : "UNKNOWN",
      "healthSummary" : "DISABLED",
      "configStalenessStatus" : "STALE_REFRESHABLE",
      "healthChecks" : [ { }, { } ],
      "haStatus" : "UNKNOWN",
      "roleUrl" : "...",
      "maintenanceMode" : true,
      "maintenanceOwners" : [ "SERVICE", "HOST" ],
      "config" : { },
      "roleConfigGroupRef" : { },
      "zooKeeperServerMode" : "REPLICATED_LEADER_ELECTION",
      "entityStatus" : "UNKNOWN",
      "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" : "MONTH",
      "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" : "MINUTE",
      "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" : "UNKNOWN_HEALTH",
    "tags" : [ {
      "name" : "...",
      "value" : "..."
    }, {
      "name" : "...",
      "value" : "..."
    } ],
    "serviceVersion" : "..."
  } ]
}