212 lines
3.8 KiB
YAML
212 lines
3.8 KiB
YAML
# variables in header
|
|
|
|
# variables in path
|
|
|
|
# variables in query
|
|
end_time:
|
|
description: |
|
|
the end timestamp of time frame.
|
|
in: query
|
|
required: false
|
|
type: int
|
|
group_name:
|
|
description: |
|
|
group name
|
|
in: query
|
|
required: true
|
|
type: string
|
|
host_name:
|
|
description: |
|
|
host name
|
|
in: query
|
|
required: false
|
|
type: string
|
|
index_type:
|
|
description: |
|
|
the type of elasticsearch index, flog(default):Openstack log, slog:host OS log
|
|
in: query
|
|
required: false
|
|
type: string
|
|
level:
|
|
description: |
|
|
the level of log, such as error, info.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
module_name:
|
|
description: |
|
|
the module name.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
page_num:
|
|
description: |
|
|
the page num, first and default is 1.
|
|
in: query
|
|
required: false
|
|
type: int
|
|
page_size:
|
|
description: |
|
|
the size of page, default is 10.
|
|
in: query
|
|
required: false
|
|
type: int
|
|
param_type:
|
|
description: |
|
|
the type of parameter, such as host_name, level, program_name, module_name
|
|
in: query
|
|
required: true
|
|
type: string
|
|
program_name:
|
|
description: |
|
|
the program name.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
project_id:
|
|
description: |
|
|
the project id.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
query:
|
|
description: |
|
|
the search query for elasticsearch.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
record_id:
|
|
description: |
|
|
anomaly record id
|
|
in: query
|
|
required: true
|
|
type: string
|
|
request_id:
|
|
description: |
|
|
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.
|
|
in: query
|
|
required: false
|
|
type: int
|
|
typical_log_type:
|
|
description: |
|
|
the typical log type, such as error_stats, rabbitmq_error_stats, mysql_error_stats
|
|
in: query
|
|
required: true
|
|
type: string
|
|
user_id:
|
|
description: |
|
|
the user id.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
uuid:
|
|
description: |
|
|
uuid.
|
|
in: query
|
|
required: true
|
|
type: string
|
|
|
|
# variables in body
|
|
add_rule_desc:
|
|
description: |
|
|
the description of anomaly rule.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
add_rule_keyword:
|
|
description: |
|
|
keyword, only support exact-match at present.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
add_rule_log_type:
|
|
description: |
|
|
the type of log, ``flog`` is platform log, and ``slog`` is operate system log.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
add_rule_module:
|
|
description: |
|
|
application module or service.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
add_rule_title:
|
|
description: |
|
|
the title of anomaly rule.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
anomaly_log_type:
|
|
description: |
|
|
the log type of anomaly log, such as flog, slog
|
|
in: body
|
|
required: false
|
|
type: string
|
|
id:
|
|
description: |
|
|
custom config id
|
|
in: body
|
|
required: true
|
|
type: string
|
|
rule_desc:
|
|
description: |
|
|
the description of anomaly rule.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
rule_flag:
|
|
description: |
|
|
whether enable flag, ``0``: disable, ``1``: enable.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
rule_keyword:
|
|
description: |
|
|
keyword, only support exact-match at present.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
rule_log_type:
|
|
description: |
|
|
the type of log, ``flog`` is platform log, and ``slog`` is operate system log.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
rule_module:
|
|
description: |
|
|
application module or service.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
rule_title:
|
|
description: |
|
|
the title of anomaly rule.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
title:
|
|
description: |
|
|
the title of anomaly record.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
value:
|
|
description: |
|
|
custom config value
|
|
in: body
|
|
required: true
|
|
type: string
|