From 52627c6543396d7c9812601047af371730cd0b8d Mon Sep 17 00:00:00 2001 From: Natzcheng Date: Thu, 10 Aug 2023 10:27:58 +0800 Subject: [PATCH] add request parameters of get anomaly rule list Change-Id: I2adc857f028112e25e2462f82c8bd765fd30602d --- api-ref/source/v1/anomaly-detect.inc | 42 ++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/api-ref/source/v1/anomaly-detect.inc b/api-ref/source/v1/anomaly-detect.inc index 32f83aa..1473d08 100644 --- a/api-ref/source/v1/anomaly-detect.inc +++ b/api-ref/source/v1/anomaly-detect.inc @@ -73,6 +73,48 @@ Response codes - -1 +Get anomaly rule list +~~~~~~~~~~~~~~~~~~~~~ + +.. rest_method:: GET /v1/anomaly/rule/list + +Get all anomaly rules. + +Response codes +-------------- + +.. rest_status_code:: success ../status.yaml + + - 0 + +.. rest_status_code:: error ../status.yaml + + - -1 + +Request +------- + +.. rest_parameters:: parameters.yaml + + - title: rule_title + - desc: rule_desc + - keyword: rule_keyword + - log_type: rule_log_type + - module: rule_module + - flag: rule_flag + - page_num: page_num + - page_size: page_size + +Response +-------- + +**Example: JSON response** + + +.. literalinclude:: ./samples/anomaly-detect/get-anomaly-rule-show-response.json + :language: javascript + + Delete anomaly rule ~~~~~~~~~~~~~~~~~~~~~