diff --git a/api-ref/source/v1/anomaly-detect.inc b/api-ref/source/v1/anomaly-detect.inc index 80fb322..778710d 100644 --- a/api-ref/source/v1/anomaly-detect.inc +++ b/api-ref/source/v1/anomaly-detect.inc @@ -5,6 +5,33 @@ Anomaly Detect Users can add, delete, modify and query anomaly rules, query and delete anomaly records. + +Get Anomaly Rule +~~~~~~~~~~~~~~~~~~~ + +.. rest_method:: GET /v1/anomaly/rule/{id} + +Get information of an anomaly rule. + +Request +------- + +.. rest_parameters:: parameters.yaml + + - id: rule_id + +Response codes +-------------- + +.. rest_status_code:: success ../status.yaml + + - 1 + +.. rest_status_code:: error ../status.yaml + + - -1 + + Get anomaly record ~~~~~~~~~~~~~~~~~~ diff --git a/api-ref/source/v1/parameters.yaml b/api-ref/source/v1/parameters.yaml index fa1646a..5752357 100644 --- a/api-ref/source/v1/parameters.yaml +++ b/api-ref/source/v1/parameters.yaml @@ -81,6 +81,12 @@ request_id: in: query required: true type: string +rule_id: + description: | + The id of an anomaly rule. + in: query + required: true + type: string start_time: description: | the start timestamp of time frame.