# ApiClusterUtilization Data Model

Utilization report information of a Cluster.

Properties
name | data type | description
--- | --- | ---
totalCpuCores | number | Average number of CPU cores available in the cluster during the report window.
avgCpuUtilization | number | Average CPU consumption for the entire cluster during the report window. This includes consumption by user workloads in YARN and Impala, as well as consumption by all services running in the cluster.
maxCpuUtilization | number | Maximum CPU consumption for the entire cluster during the report window. This includes consumption by user workloads in YARN and Impala, as well as consumption by all services running in the cluster.
avgCpuDailyPeak | number | Average daily peak CPU consumption for the entire cluster during the report window. This includes consumption by user workloads in YARN and Impala, as well as consumption by all services running in the cluster.
avgWorkloadCpu | number | Average CPU consumption by workloads that ran on the cluster during the report window. This includes consumption by user workloads in YARN and Impala.
maxWorkloadCpu | number | Maximum CPU consumption by workloads that ran on the cluster during the report window. This includes consumption by user workloads in YARN and Impala.
avgWorkloadCpuDailyPeak | number | Average daily peak CPU consumption by workloads that ran on the cluster during the report window. This includes consumption by user workloads in YARN and Impala.
totalMemory | number | Average physical memory (in bytes) available in the cluster during the report window. This includes consumption by user workloads in YARN and Impala, as well as consumption by all services running in the cluster.
avgMemoryUtilization | number | Average memory consumption (as percentage of total memory) for the entire cluster during the report window. This includes consumption by user workloads in YARN and Impala, as well as consumption by all services running in the cluster.
maxMemoryUtilization | number | Maximum memory consumption (as percentage of total memory) for the entire cluster during the report window. This includes consumption by user workloads in YARN and Impala, as well as consumption by all services running in the cluster.
avgMemoryDailyPeak | number | Average daily peak memory consumption (as percentage of total memory) for the entire cluster during the report window. This includes consumption by user workloads in YARN and Impala, as well as consumption by all services running in the cluster.
avgWorkloadMemory | number | Average memory consumption (as percentage of total memory) by workloads that ran on the cluster during the report window. This includes consumption by user workloads in YARN and Impala.
maxWorkloadMemory | number | Maximum memory consumption (as percentage of total memory) by workloads that ran on the cluster. This includes consumption by user workloads in YARN and Impala
avgWorkloadMemoryDailyPeak | number | Average daily peak memory consumption (as percentage of total memory) by workloads that ran on the cluster during the report window. This includes consumption by user workloads in YARN and Impala.
tenantUtilizations | ApiTenantUtilizationList | A list of tenant utilization reports.
maxCpuUtilizationTimestampMs | number | Timestamp corresponding to maximum CPU utilization for the entire cluster during the report window.
maxMemoryUtilizationTimestampMs | number | Timestamp corresponding to maximum memory utilization for the entire cluster during the report window.
maxWorkloadCpuTimestampMs | number | Timestamp corresponds to maximum CPU consumption by workloads that ran on the cluster during the report window.
maxWorkloadMemoryTimestampMs | number | Timestamp corresponds to maximum memory resource consumption by workloads that ran on the cluster during the report window.
errorMessage | string | Error message while generating utilization report.

Example

    {
      "totalCpuCores" : 12345.0,
      "avgCpuUtilization" : 12345.0,
      "maxCpuUtilization" : 12345.0,
      "avgCpuDailyPeak" : 12345.0,
      "avgWorkloadCpu" : 12345.0,
      "maxWorkloadCpu" : 12345.0,
      "avgWorkloadCpuDailyPeak" : 12345.0,
      "totalMemory" : 12345.0,
      "avgMemoryUtilization" : 12345.0,
      "maxMemoryUtilization" : 12345.0,
      "avgMemoryDailyPeak" : 12345.0,
      "avgWorkloadMemory" : 12345.0,
      "maxWorkloadMemory" : 12345.0,
      "avgWorkloadMemoryDailyPeak" : 12345.0,
      "tenantUtilizations" : {
        "items" : [ {
          "tenantName" : "...",
          "cpuUtilizationPercentage" : 12345.0,
          "memoryUtilizationPercentage" : 12345.0
        }, {
          "tenantName" : "...",
          "cpuUtilizationPercentage" : 12345.0,
          "memoryUtilizationPercentage" : 12345.0
        } ]
      },
      "maxCpuUtilizationTimestampMs" : 12345,
      "maxMemoryUtilizationTimestampMs" : 12345,
      "maxWorkloadCpuTimestampMs" : 12345,
      "maxWorkloadMemoryTimestampMs" : 12345,
      "errorMessage" : "..."
    }