Home

/reports/operational/clusterworkload?gte={timestamp}&lte={timestamp}&reportBy={interval}&appType={appType}&clusterUid={clusterUid}

Gets a summary of the cluster's workloads for specific intervals such as a month, day, hour, and hour/day.

Request
GET http://unravel-host:3000/api/v1/reports/operational/clusterworkload?gte={timestamp}&lte={timestamp}&reportBy={interval}&appType={appType}&clusterUid={clusterUid}
Path parameters

None.

Query parameters

Required parameters are highlighted.

Name

Type

Description

gte

string

Start time, in Unix epoch format.

lte

string

End time, in Unix epoch format.

reportBy

string

Report interval.

Valid values are month, day, hour, and hourday.

For month and day, the epoch date interval is 24 hours. For an hour and hour/day, it is 60 minutes.

For the time range other than view by month there is an option to aggregate by sum or average.

The data on the overlapping day/time is added and based on the selected option, it is aggregated by either sum or average and shown.

appType

string

Type of the app.

App types are Yarn and Impala. For Databricks the applicable app types are Cluster and Job runs.

clusterUid

string

The unique ID of the cluster.

Response body
{
  "appcount": {
    "<timestamp>": <appcount>,
    "<timestamp>": <appcount>,
  },
  "vcores": {
        "<timestamp>": <vcores count>,
        "<timestamp>": <vcores count>,
   },
  "memory": {
    "<timestamp>": <memory count>,
    "<timestamp>": <memory count>,

  },
}

Name

Description

app count

No of apps that are running in the selected report interval, along with the timestamp.

vcores count

VCores that are utilized in the selected report interval, along with the timestamp.

memory count

Memory utilized in the selected report interval, along with the timestamp.

Example

Request:

curl -X GET http://myserver.com:3000/api/v1/reports/operational/clusterworkload?reportBy=month&apptype=yarn&gte=2021-08-07T00:00:00%2B05:30&lt=2021-08-13T23:59:59%2B05:30&clusterUid=7dde6b1c-b5a1-11eb-af07-5254004d77d3

Response:

{
  "appcount": {
    "1628274600": 0,
    "1628361000": 0,
    "1628447400": 0,
    "1628533800": 95,
    "1628620200": 379,
    "1628706600": 908,
    "1628793000": 0
  },
  "vcores": {
    "1628274600": 0,
    "1628361000": 0,
    "1628447400": 0,
    "1628533800": 0,
    "1628620200": 64.906,
    "1628706600": 171.199,
    "1628793000": 0
  },
  "memory": {
    "1628274600": 0,
    "1628361000": 0,
    "1628447400": 0,
    "1628533800": 0,
    "1628620200": 76601.714,
    "1628706600": 229711.605,
    "1628793000": 0
  },
}
In this section: