Endpoint

/v1/analytics/capacity-history/

GET

Returns capacity history data for the cluster. Does not return entries for timeslots without capacity data. Returned history data will be sorted by ascending time.

Parameters

Name Description Required
begin-time Lower bound on history returned, in RFC 3339 format or epoch seconds. Yes
end-time Upper bound on history returned, in RFC 3339 format or epoch seconds. If not specified, defaults to the current system time. No
interval Sampling interval. If not specified, defaults to 'hourly'.: * `daily` - daily, * `hourly` - hourly, * `weekly` - weekly No

Response

Codes

Code Description
200 Return value on success

Schema

{
  "type": "array",
  "items": {
    "description": "overall_historical_capacity",
    "type": "object",
    "properties": {
      "period_start_time": {
        "description": "period_start_time",
        "type": "number"
      },
      "capacity_used": {
        "description": "capacity_used",
        "type": "string"
      },
      "data_used": {
        "description": "data_used",
        "type": "string"
      },
      "metadata_used": {
        "description": "metadata_used",
        "type": "string"
      },
      "snapshot_used": {
        "description": "snapshot_used",
        "type": "string"
      },
      "total_usable": {
        "description": "total_usable",
        "type": "string"
      },
      "details_status": {
        "type": "string",
        "enum": [
          "AVAILABLE",
          "UNAVAILABLE",
          "PENDING"
        ],
        "description": "details_status:\n * `AVAILABLE` - DETAILED_PATH_CAPACITY_AVAILABLE,\n * `PENDING` - DETAILED_PATH_CAPACITY_PENDING,\n * `UNAVAILABLE` - DETAILED_PATH_CAPACITY_UNAVAILABLE"
      }
    }
  }
}