Auto-generated swagger documentation
The API uses JSON to communicate with clients.
You should add the following accept header to your requests:
Accept: application/json
When you send JSON data with a POST or PUT request, you must add the following content type header:
POST
PUT
Content-Type: application/json
Hawkular Metrics is a multi-tenant time-series data store. Your requests to tenant-dependent resources must include a tenant header:
Hawkular-Tenant: my-tenant
The API understands all timestamps as milliseconds since January 1, 1970, 00:00:00 UTC.
/hawkular/datamining/
Change forecaster configuration.
Predict future values of given metric.
Learn model based on inserted values.
Endpoint PUT /metrics/{metricId}/forecaster
/metrics/{metricId}/forecaster
Path parameters
metricId
Yes
-
string
Body
Update
Response
Status codes
201
Success, prediction successfully enabled
400
Missing or invalid payload
ApiError
404
Subscription of given metric not found
500
Server error
Endpoint GET /metrics/{metricId}/forecaster/forecast
/metrics/{metricId}/forecaster/forecast
Query parameters
ahead
No
integer
int32
200
Success, predictions returned
Endpoint POST /metrics/{metricId}/forecaster/learn
/metrics/{metricId}/forecaster/learn
Success, learning successfully processed
Returns complete list of REST endpoints.
Endpoint GET /
/
default
successful operation
Get all subscriptions of tenant.
Subscribe metric for prediction.
Deletes subscription of given metric.
Modify metric metadata.
Get a concrete subscription.
Endpoint GET /metrics
/metrics
Success
Subscription for given metric not found
Endpoint POST /metrics
RestBlueprint
409
Subscription for given metric already enabled
Endpoint DELETE /metrics/{id}
/metrics/{id}
id
204
Success, Model successfully disabled
Model for given metric not found
Endpoint PUT /metrics/{id}
Endpoint GET /metrics/{metricId}
/metrics/{metricId}
errorMsg
collectionInterval
int64
conceptDriftStrategy
null
ic
AIC, AICc, BIC
modelToUse
SimpleExponentialSmoothing, DoubleExponentialSmoothing, TripleExponentialSmoothing
period
windowSize
© 2016 | Hawkular is released under Apache License v2.0 Follow @hawkular_org