From 1b4bb20d7b15357ac4a9d514c293f4ced889d6d5 Mon Sep 17 00:00:00 2001 From: Alexey Velikiy Date: Thu, 28 May 2020 11:29:56 +0200 Subject: [PATCH] rm rest.md (#904) Co-authored-by: Alexey Velikiy --- REST.md | 213 -------------------------------------------------------- 1 file changed, 213 deletions(-) delete mode 100644 REST.md diff --git a/REST.md b/REST.md deleted file mode 100644 index 428acdd..0000000 --- a/REST.md +++ /dev/null @@ -1,213 +0,0 @@ -# -----------OUTDATED------------- -# ------------------------------------- - -# Hastic server REST API - -## /anomalies - -### Get anomalies -`GET /anomalies?id=[&name=]` - -NOTE: `name` param is deprecated, use `id` instead - -Return data format: - -``` -{ - "name": "", - "metric": "", - "status": "" -} -``` - -status field can be one of: - -- `learning` -- `ready` -- `failed` - -### Get anomaly status -`GET /anomalies/status?id=[&name=]` - -NOTE: `name` param is deprecated, use `id` instead - -Return data format: - -``` -{ - "status": , - "errorMessage": -} -``` - -status field can be one of: - -- `learning` -- `ready` -- `failed` - -### Add anomaly - -`POST /anomalies` - -Data format: - -``` -{ - "name": "cpu_utilization_supervised", - "metric": { - "datasource": "influx accelerometer", - "targets": [ - - ] - }, - "panelUrl": "http://grafana.example.com/d/oNZ35bWiz/new-dashboard-copy?panelId=2&fullscreen", - "datasource": { - "data": null, - "type": "influxdb", - "method": "GET", - "params": { - "db": "collectd", - "q": "SELECT mean("value") FROM "cpu_value" WHERE ("type_instance" = 'user') AND time >= 1525603866633ms and time <= 1526986266633ms GROUP BY time(10s)", - "epoch": "ms" - } - "url": "api/datasources/proxy/8/query" - } -} -``` - -`targets` example: - -``` -{ - "alias": "command", - "groupBy": [], - "measurement": "data", - "orderByTime": "ASC", - "policy": "default", - "refId": "A", - "resultFormat": "time_series", - "select": [ - [ - { - "params": [ - "command" - ], - "type": "field" - } - ] - ], - "tags": [] -} -``` - -Return data format: - -``` -{ - "predictor_id": "" -} -``` - -### Delete anpmalies -`DELETE /anomalies` - -Data format: - -``` -{ - "id": "", - "name": "" // deprecated, use id instead -} -``` - -Return data format: - -``` -Success -``` - -## /segments - -### Get segments -`GET /segments?predictor_id=[&last_segment=][&from=][&to=]` - -Return data format: - -``` -{ - "segments": [ - { - "id": 0, - "start": 1392765184318, - "finish": 1397243699000, - "labeled": true - }, - ... - ] -} -``` - -### Update segments - -`PATCH /segments` - -Data format: - -``` -{ - "predictor_id": "", - "name": "", // deprecated, use id instead - "added_segments": [ - { - "start": 1397164656000, - "finish": 1397243699000 - }, - ... - ], - "removed_segments": [3, 9] -} -``` - -Return data format: - -``` -{ - "added_ids": [12, ...] -} -``` - -## /alerts - -### Check if alert is enabled for anomaly - -`GET /alerts?predictor_id=` - -Return data format: - -``` -{ - "enable": true -} -``` - -### Enable / disable alert for anomaly - -`POST /alerts` - -Data format: - -``` -{ - "predictor_id": "", - "enable": true -} -``` - -Return data format: - -``` -{ - "status": "Ok" -} -```