From 7d41a6306d42aff7ec0fb8a77d625b2da88aa44c Mon Sep 17 00:00:00 2001 From: alex-smile <443677891@qq.com> Date: Tue, 5 Jul 2022 15:26:16 +0800 Subject: [PATCH] esb update data/monitor_v3 confapis --- paas2/VERSION | 2 +- .../components/confapis/data/dataflow.yaml | 1 + .../components/confapis/data/v3_access.yaml | 9 + .../components/confapis/data/v3_aiops.yaml | 18 + .../esb/components/confapis/data/v3_meta.yaml | 33 +- .../apidocs/zh_hans/delete_action_config.md | 44 + .../apidocs/zh_hans/delete_calendar.md | 44 + .../monitor_v3/apidocs/zh_hans/delete_item.md | 169 +++ .../apidocs/zh_hans/edit_action_config.md | 270 +++++ .../apidocs/zh_hans/edit_calendar.md | 71 ++ .../monitor_v3/apidocs/zh_hans/edit_item.md | 360 ++++++ .../zh_hans/export_uptime_check_task.md | 4 +- .../apidocs/zh_hans/get_action_config.md | 167 +++ .../apidocs/zh_hans/get_calendar.md | 72 ++ .../monitor_v3/apidocs/zh_hans/get_ts_data.md | 17 +- .../zh_hans/import_uptime_check_task.md | 3 +- .../monitor_v3/apidocs/zh_hans/item_detail.md | 206 ++++ .../monitor_v3/apidocs/zh_hans/item_list.md | 246 ++++ .../apidocs/zh_hans/list_calendar.md | 74 ++ .../monitor_v3/apidocs/zh_hans/list_shield.md | 14 +- .../metadata_create_time_series_group.md | 8 +- .../apidocs/zh_hans/metadata_get_data_id.md | 4 +- .../apidocs/zh_hans/save_action_config.md | 150 +++ .../apidocs/zh_hans/save_alarm_strategy.md | 6 +- .../apidocs/zh_hans/save_alarm_strategy_v3.md | 561 +++++++++ .../apidocs/zh_hans/save_calendar.md | 50 + .../monitor_v3/apidocs/zh_hans/save_item.md | 181 +++ .../apidocs/zh_hans/search_action.md | 460 ++++++++ .../apidocs/zh_hans/search_action_config.md | 180 +++ .../zh_hans/search_alarm_strategy_v3.md | 580 ++++++++++ .../search_alarm_strategy_without_biz.md | 1030 +++++++++++++++++ .../apidocs/zh_hans/search_alert.md | 395 +++++++ .../apidocs/zh_hans/search_event.md | 14 +- .../zh_hans/update_partial_strategy_v3.md | 134 +++ .../confapis/monitor_v3/monitor_v3.yaml | 12 + paas2/release.md | 3 + 36 files changed, 5551 insertions(+), 41 deletions(-) create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/delete_action_config.md create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/delete_calendar.md create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/delete_item.md create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/edit_action_config.md create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/edit_calendar.md create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/edit_item.md create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/get_action_config.md create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/get_calendar.md create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/item_detail.md create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/item_list.md create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/list_calendar.md create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_action_config.md create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_alarm_strategy_v3.md create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_calendar.md create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_item.md create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_action.md create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_action_config.md create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_alarm_strategy_v3.md create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_alarm_strategy_without_biz.md create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_alert.md create mode 100644 paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/update_partial_strategy_v3.md diff --git a/paas2/VERSION b/paas2/VERSION index ecbbf8207..19788f776 100644 --- a/paas2/VERSION +++ b/paas2/VERSION @@ -1 +1 @@ -2.14.15 +2.14.16 diff --git a/paas2/esb/components/confapis/data/dataflow.yaml b/paas2/esb/components/confapis/data/dataflow.yaml index 28715b0fa..44ad76c2c 100644 --- a/paas2/esb/components/confapis/data/dataflow.yaml +++ b/paas2/esb/components/confapis/data/dataflow.yaml @@ -392,3 +392,4 @@ dest_path: /v3/dataflow/flow/get_latest_msg/ dest_http_method: GET is_hidden: true + diff --git a/paas2/esb/components/confapis/data/v3_access.yaml b/paas2/esb/components/confapis/data/v3_access.yaml index 258ef4cf5..37427c412 100644 --- a/paas2/esb/components/confapis/data/v3_access.yaml +++ b/paas2/esb/components/confapis/data/v3_access.yaml @@ -330,3 +330,12 @@ dest_path: /v3/access/rawdata/query_by_name/ dest_http_method: GET is_hidden: true + +- path: /data/v3/access/rawdata/{data_id}/tags/ + name: v3_access_rawdata_raw_data_id_tags_post + label: 目标rawdata打标签接口 + method: POST + comp_codename: generic.data.datav3_component + dest_path: /v3/access/rawdata/{data_id}/tags/ + dest_http_method: POST + is_hidden: true diff --git a/paas2/esb/components/confapis/data/v3_aiops.yaml b/paas2/esb/components/confapis/data/v3_aiops.yaml index 7ca1ba584..41e7cd66d 100644 --- a/paas2/esb/components/confapis/data/v3_aiops.yaml +++ b/paas2/esb/components/confapis/data/v3_aiops.yaml @@ -1383,3 +1383,21 @@ method: POST name: v3_aiops_get_AIOps_Experiment_Node_execute_groups path: /data/v3/aiops/models/{model_id}/experiments/{model_experiment_id}/node/execute/groups/ + +- path: /data/v3/aiops/envs/ + name: v3_aiops_envs + label: 获取依赖的aiops部分环境变量 + method: GET + comp_codename: generic.data.datav3_component + dest_path: /v3/aiops/envs/ + dest_http_method: GET + is_hidden: true + +- path: /data/v3/aiops/serving/processing/{result_table_name}/execute/ + name: v3_aiops_api_serving_execute + label: 执行api_serving + method: POST + comp_codename: generic.data.datav3_component + dest_path: /v3/aiops/serving/processing/{result_table_name}/execute/ + dest_http_method: POST + is_hidden: true diff --git a/paas2/esb/components/confapis/data/v3_meta.yaml b/paas2/esb/components/confapis/data/v3_meta.yaml index 2754db509..5bd967073 100644 --- a/paas2/esb/components/confapis/data/v3_meta.yaml +++ b/paas2/esb/components/confapis/data/v3_meta.yaml @@ -397,6 +397,7 @@ dest_http_method: GET is_hidden: true + - path: /data/v3/meta/result_tables/{result_table_id}/geog_area/ name: v3_meta_result_tables__result_table_id__geog_area_get label: 获取结果表所属地域 @@ -404,4 +405,34 @@ comp_codename: generic.data.datav3_component dest_path: /v3/meta/result_tables/{result_table_id}/geog_area/ dest_http_method: GET - is_hidden: true \ No newline at end of file + is_hidden: true + + +- path: /data/v3/meta/tag/recommends/ + name: v3_meta_tag_recommends_get + label: 标签推荐列表接口 + method: GET + comp_codename: generic.data.datav3_component + dest_path: /v3/meta/tag/recommends/ + dest_http_method: GET + is_hidden: true + + +- path: /data/v3/meta/tag/tags/ + name: v3_meta_tag_tags_code_list + label: 标签列表接口 + method: GET + comp_codename: generic.data.datav3_component + dest_path: /v3/meta/tag/tags/ + dest_http_method: GET + is_hidden: true + + +- path: /data/v3/meta/result_tables/{result_table_id}/tags/ + name: v3_meta_result_tables_post_tags + label: 目标rt打标签接口 + method: POST + comp_codename: generic.data.datav3_component + dest_path: /v3/meta/result_tables/{result_table_id}/tags/ + dest_http_method: POST + is_hidden: true diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/delete_action_config.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/delete_action_config.md new file mode 100644 index 000000000..4492682ff --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/delete_action_config.md @@ -0,0 +1,44 @@ +### 功能描述 + +删除处理套餐 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段 | 类型 | 必选 | 描述 | +| ---- | ---- | ---- | ---------- | +| id | Int | 是 | 处理套餐ID | + +#### 示例数据 + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx", + "id": 1 +} +``` + +#### 响应参数 + +| 字段 | 类型 | 描述 | +| ------- | ------ | ------------ | +| result | Bool | 请求是否成功 | +| code | Int | 返回的状态码 | +| message | String | 描述信息 | +| data | null | 空 | + +#### 示例数据 + +```json +{ + "message": "OK", + "code": 200, + "result": true, + "data": null +} +``` \ No newline at end of file diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/delete_calendar.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/delete_calendar.md new file mode 100644 index 000000000..724863a80 --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/delete_calendar.md @@ -0,0 +1,44 @@ +### 功能描述 + +删除日历 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段名 | 类型 | 必选 | 描述 | +| ------ | ---- | ---- | ------ | +| int | Int | 是 | 日历ID | + +#### 示例数据 + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx", + "id": 1 +} +``` + +### 响应参数 + +| 字段名 | 类型 | 描述 | +| ------- | ------ | ------------ | +| result | Bool | 请求是否成功 | +| code | Int | 返回的状态码 | +| message | String | 描述信息 | +| data | Null | 空 | + +#### 示例数据 + +```json +{ + "message": "OK", + "code": 200, + "data": null, + "result": true +} +``` \ No newline at end of file diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/delete_item.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/delete_item.md new file mode 100644 index 000000000..38bad0af9 --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/delete_item.md @@ -0,0 +1,169 @@ +### 功能描述 + +删除日历事项 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段名 | 类型 | 必选 | 描述 | +| ----------- | ---- | ---- | ------------------------------------------------------------ | +| id | Int | 是 | 日历事项ID | +| start_time | Int | 是 | 事项开始时间（传入时间戳） | +| end_time | Int | 是 | 事项结束时间（传入时间戳） | +| repeat | Dict | 是 | 重复事项配置信息（默认为{},表示不重复） | +| delete_type | Int | 是 | 删除类型（删除整个事项：0；删除当前事项：1；删除当前事项及未来所有事项：2） | + +#### 重复事项配置信息（repeat） + +| 字段名 | 类型 | 必选 | 说明 | +| ------------ | ----------- | ---- | ------------------------------------------------------------ | +| freq | String | 是 | 重复频率（天："day"，周："week"，月："month"，年："year"） | +| interval | Int | 是 | 重复间隔 | +| until | Int | 是 | 重复结束时间（传入时间戳） | +| every | List（int） | 是 | 重复区间，当`label`为`week`时这里是0-6(0为周天)的数字，当`label`为`month`的时候，这里是1-31的数字，当`label`为`year`的时候这里的数字是1-12(注：如果传入的start_time对应的标志不在重复区间内，则会自动将其加入） | +| exclude_date | List(int) | 是 | 排除事项日期(这里记录排除在重复范围内的日期) | + +- 不重复（默认）=>`repeat={}` + +- 每天 + + ```python + { + "freq": "day", + "interval": 1, # 间隔 + "until": 1648569600, # 结束日期 + "every": [], # 区间 + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每个工作日 + + ```python + { + "freq": "week", + "interval": 1, + "until": null, # 永不结束 + "every": [1,2,3,4,5], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每周 + + ```python + { + "freq": "week", + "interval": 1, + "until": null, + "every": [], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每月 + + ```python + { + "freq": "month", + "interval": 1, + "until": null, + "every": [], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每年 + + ```python + { + "freq": "year", + "interval": 1, + "until": null, + "every": [], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 自定义 + + 自定义这里，根据用户选择的重复结束日期和重复间隔在对应的位置进行处理 + + ```python + # 每三天并且永不结束 + { + "freq": "day", + "interval": 3, # 间隔 + "until": null, # 结束日期 + "every": [], # 区间 + "exclude_date": [] # 排除事项日期 + } + # 每四周并且10.1日结束 + { + "freq": "week", + "interval": 4, # 间隔 + "until": 1664553600, # 结束日期 + "every": [], # 区间 + "exclude_date": [] # 排除事项日期 + } + # 每周四和六并且两周一次，永不结束 + { + "freq": "week", + "interval": 2, # 间隔 + "until": null, # 结束日期 + "every": [4,6], # 区间 + "exclude_date": [] # 排除事项日期 + } + # 每月1号和15号重复，并且间隔3个月，永不重复 + { + "freq": "month", + "interval": 3, # 间隔 + "until": null, # 结束日期 + "every": [1, 15], # 区间 + "exclude_date": [] # 排除事项日期 + } + ``` + +#### 排除日期（repeat.exclude_date） + +当用户对一个重复的事项进行单个编辑或者删除的时候，对应的日期就会存入`exclude_date` + +例如：当有一从`2022-03-10至2022-03-20`的每天重复的事项，如果将15号的事项删除，则可以将3.15存入`exclude_date`，使之变成`[1647273600]` + +#### 示例数据 + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx", + "id": 1, + "start_time": 1647043200, + "end_time": 1647052200, + "repeat": {}, + "delete_type": 0 +} +``` + +### 响应参数 + +| 字段名 | 类型 | 描述 | +| ------- | ------ | ------------ | +| result | Bool | 请求是否成功 | +| code | Int | 返回的状态码 | +| message | String | 描述信息 | +| data | Null | 空 | + +#### 示例数据 + +```json +{ + "message": "OK", + "code": 200, + "data": null, + "result": true +} +``` \ No newline at end of file diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/edit_action_config.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/edit_action_config.md new file mode 100644 index 000000000..5dd440278 --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/edit_action_config.md @@ -0,0 +1,270 @@ +### 功能描述 + +编辑处理套餐 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段 | 类型 | 必选 | 描述 | +| -------------- | ------ | ---- | ------------------------------------------------------------ | +| name | String | 是 | 名称 | +| plugin_id | Int | 是 | 插件ID，可选项：2（HTTP回调），3（作业平台），4（标准运维），5（流程服务），6（标准运维公共流程） | +| desc | String | 否 | 描述 | +| execute_config | Dict | 是 | 执行参数（根据plug_in对应的 plugin_type不同，所需参数也不同） | +| id | Int | 是 | 处理套餐ID | +| bk_biz_id | Int | 是 | 业务ID | + +#### 执行参数（plugin_id为2时） + +| 字段 | 类型 | 必选 | 描述 | +| -------------------- | ------ | ---- | -------------------------------------------------------- | +| method | String | 否 | 请求方法，可选（"POST","GET","PUT"）默认"GET" | +| url | String | 是 | 回调地址 | +| headers | List | 否 | 请求头 | +| authorize | Dict | 否 | 认证信息 | +| body | Dict | 否 | 请求体 | +| query_params | List | 否 | 请求参数 | +| failed_retry | Dict | 否 | 失败重试机制 | +| need_poll | Bool | 否 | 是否需要告警（默认是） | +| notify_interval | Int | 否 | 告警周期（按s为单位，最小1分支，默认1h） | +| interval_notify_mode | String | 否 | 告警方法（可选"increasing", "standard"，默认"standard"） | + +##### execute_config.template_detail.headers + +| 字段 | 类型 | 必选 | 描述 | +| ---------- | ------ | ---- | -------- | +| key | String | 是 | 字段名 | +| value | String | 否 | 字段值 | +| desc | String | 否 | 描述 | +| is_builtin | Bool | 否 | 是否内嵌 | +| is_enabled | Bool | 否 | 是否启用 | + +##### execute_config.template_detail.authorize + +| 字段 | 类型 | 必选 | 描述 | +| ----------- | ------ | ---- | ------------------------------------------------- | +| auth_type | String | 是 | 类型（可选"none", "basic_auth", "bearer_token" ） | +| auth_config | Dict | 否 | 配置信息 | + +##### execute_config.template_detail.body + +| 字段 | 类型 | 必选 | 描述 | +| ------------ | ------ | ---- | ------------------------------------------------------------ | +| data_type | String | 否 | 类型（可选"default", "raw", "form_data", "x_www_form_urlencoded"） | +| params | List | 否 | 与execute_config.headers参数配置一样 | +| content | String | 否 | 当type为raw时这里配置相关内容 | +| content_type | String | 否 | 内容类型（可选"text","json", "html","xml"默认"text"） | + +##### execute_config.template_detail.query_params + +| 字段 | 类型 | 必选 | 描述 | +| ---------- | ------ | ---- | -------- | +| key | String | 是 | 字段名 | +| value | String | 否 | 字段值 | +| desc | String | 否 | 描述 | +| is_builtin | Bool | 否 | 是否内嵌 | +| is_enabled | Bool | 否 | 是否启用 | + +##### execute_config.template_detail.failed_retry + +| 字段 | 类型 | 必选 | 描述 | +| --------------- | ---- | ---- | --------------------- | +| is_enabled | Bool | 否 | 是否启用 | +| value | Int | 否 | 处理时间 | +| max_retry_times | Int | 是 | 最大重试时间（最小0） | +| retry_interval | Int | 是 | 重试间隔（最小0） | + +#### 执行参数（plugin_id为其他选项时） + +| 字段 | 类型 | 必选 | 描述 | +| --------------- | ------ | ---- | ------------------------------- | +| template_id | String | 是 | 周边系统的模版ID | +| template_detail | Dict | 是 | 模版详情（默认{}） | +| timeout | Int | 是 | 执行超时时间（单位s，默认600s） | + +#### 示例数据 + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx", + "execute_config": { + "template_detail": { + "method": "GET", + "url": "http://www.baidu.com", + "headers": [], + "authorize": { + "auth_config": {}, + "auth_type": "none", + "insecure_skip_verify": false + }, + "body": { + "data_type": "default", + "content_type": "", + "content": "", + "params": [] + }, + "query_params": [], + "need_poll": false, + "notify_interval": 7200, + "failed_retry": { + "is_enabled": true, + "max_retry_times": 2, + "retry_interval": 2, + "timeout": 10 + } + }, + "timeout": 600 + }, + "name": "测试新建处理套餐", + "desc": "测试新建处理套餐1111", + "plugin_id": 2, + "id": 1, + "bk_biz_id": 2 +} +``` + +### 响应参数 + +| 字段 | 类型 | 描述 | +| ------- | ------ | ------------ | +| result | Bool | 请求是否成功 | +| code | Int | 返回的状态码 | +| message | String | 描述信息 | +| data | Dict | 处理套餐信息 | + +#### data字段说明 + +| 字段 | 类型 | 描述 | +| -------------- | ------ | ------------------------------------------------------------ | +| bk_biz_id | Int | 业务ID | +| name | String | 名称 | +| plugin_id | Int | 插件ID，可选项：2（HTTP回调），3（作业平台），4（标准运维），5（流程服务），6（标准运维公共流程） | +| desc | String | 描述 | +| execute_config | Dict | 执行参数（根据plug_in对应的 plugin_type不同，所需参数也不同） | +| id | Int | 处理套餐ID | +| create_time | String | 创建时间 | +| create_user | String | 创建用户 | +| update_time | String | 更新时间 | +| update_user | String | 更新用户 | + +#### 执行参数（plugin_id为2时） + +| 字段 | 类型 | 描述 | +| -------------------- | ------ | -------------------------------------------------------- | +| method | String | 请求方法，可选（"POST","GET","PUT"）默认"GET" | +| url | String | 回调地址 | +| headers | List | 请求头 | +| authorize | Dict | 认证信息 | +| body | Dict | 请求体 | +| query_params | List | 请求参数 | +| failed_retry | Dict | 失败重试机制 | +| need_poll | Bool | 是否需要告警（默认是） | +| notify_interval | Int | 告警周期（按s为单位，最小1分钟，默认1h） | +| interval_notify_mode | String | 告警方法（可选"increasing", "standard"，默认"standard"） | + +##### execute_config.template_detail.headers + +| 字段 | 类型 | 描述 | +| ---------- | ------ | -------- | +| key | String | 字段名 | +| value | String | 字段值 | +| desc | String | 描述 | +| is_builtin | Bool | 是否内嵌 | +| is_enabled | Bool | 是否启用 | + +##### execute_config.template_detail.authorize + +| 字段 | 类型 | 描述 | +| ----------- | ------ | ------------------------------------------------- | +| auth_type | String | 类型（可选"none", "basic_auth", "bearer_token" ） | +| auth_config | Dict | 配置信息 | + +##### execute_config.template_detail.body + +| 字段 | 类型 | 描述 | +| ------------ | ------ | ------------------------------------------------------------ | +| data_type | String | 类型（可选"default", "raw", "form_data", "x_www_form_urlencoded"） | +| params | List | 与execute_config.headers参数配置一样 | +| content | String | 当type为raw时这里配置相关内容 | +| content_type | String | 内容类型（可选"text","json", "html","xml"默认"text"） | + +##### execute_config.template_detail.query_params + +| 字段 | 类型 | 描述 | +| ---------- | ------ | -------- | +| key | String | 字段名 | +| value | String | 字段值 | +| desc | String | 描述 | +| is_builtin | Bool | 是否内嵌 | +| is_enabled | Bool | 是否启用 | + +##### execute_config.template_detail.failed_retry + +| 字段 | 类型 | 描述 | +| --------------- | ---- | --------------------- | +| is_enabled | Bool | 是否启用 | +| value | Int | 处理时间 | +| max_retry_times | Int | 最大重试时间（最小0） | +| retry_interval | Int | 重试间隔（最小0） | + +#### 执行参数（plugin_id为其他选项时） + +| 字段 | 类型 | 描述 | +| --------------- | ------ | ------------------------------- | +| template_id | String | 周边系统的模版ID | +| template_detail | Dict | 模版详情（默认{}） | +| timeout | Int | 执行超时时间（单位s，默认600s） | + +#### 示例数据 + +```json +{ + "message": "OK", + "code": 200, + "data": { + "execute_config": { + "template_detail": { + "method": "GET", + "url": "http://www.baidu.com", + "headers": [], + "authorize": { + "auth_config": {}, + "auth_type": "none", + "insecure_skip_verify": false + }, + "body": { + "data_type": "default", + "content_type": "", + "content": "", + "params": [] + }, + "query_params": [], + "need_poll": false, + "notify_interval": 7200, + "failed_retry": { + "is_enabled": true, + "max_retry_times": 2, + "retry_interval": 2, + "timeout": 10 + } + }, + "timeout": 600 + }, + "name": "测试新建处理套餐", + "desc": "测试新建处理套餐1111", + "is_enabled": false, + "bk_biz_id": 2, + "id": 1, + "create_time": "2022-02-25 11:01:25+0800", + "create_user": "admin", + "update_time": "2022-02-25 15:19:23+0800", + "update_user": "admin" + }, + "result": true +} +``` \ No newline at end of file diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/edit_calendar.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/edit_calendar.md new file mode 100644 index 000000000..8b7c726c8 --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/edit_calendar.md @@ -0,0 +1,71 @@ +### 功能描述 + +修改日历 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段名 | 类型 | 必选 | 描述 | +| ----------- | ------ | ---- | ------------ | +| id | Int | 是 | 日历Id | +| name | String | 否 | 日历名称 | +| deep_color | String | 否 | 日历深色底色 | +| light_color | String | 否 | 日历浅色底色 | + +#### 示例数据 + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx", + "id": 1, + "name": "测试日历" +} +``` + +### 响应参数 + +| 字段名 | 类型 | 描述 | +| ------- | ------ | ------------ | +| result | bool | 请求是否成功 | +| code | int | 返回的状态码 | +| message | string | 描述信息 | +| data | dict | 日历的信息 | + +#### data字段说明 + +| 字段名 | 类型 | 描述 | +| ----------- | ------ | ---------------------------------------------- | +| id | Int | 日历ID | +| name | String | 日历名称 | +| update_user | String | 更新者 | +| update_time | Int | 更新时间 | +| create_user | String | 创建者 | +| create_time | Int | 创建时间 | +| classify | String | 日历分类（内置："default"，自定义："defined"） | +| color | String | 日历颜色 | + +#### 示例数据 + +```json +{ + "message": "OK", + "code": 200, + "data": { + "id": 1, + "name": "测试日历", + "update_user": "xxx", + "update_time": 1646883864, + "create_user": "xxx", + "create_time": 1646883864, + "classify": "defined", + "deep_color": "#BBFFFF", + "light_color": "#111111" + }, + "result": true +} +``` \ No newline at end of file diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/edit_item.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/edit_item.md new file mode 100644 index 000000000..0e3406c77 --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/edit_item.md @@ -0,0 +1,360 @@ +### 功能描述 + +修改日历事项 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段名 | 类型 | 必选 | 描述 | +| ----------- | ------ | ---- | ------------------------------------------------------------ | +| id | Int | 是 | 日历事项ID | +| name | String | 否 | 日历事项名称 | +| calendar_id | Int | 否 | 所属日历ID | +| start_time | Int | 否 | 事项开始时间 | +| end_time | Int | 否 | 事项结束时间 | +| repeat | Dict | 否 | 重复事项配置信息（默认为{},表示不重复） | +| change_type | Int | 是 | 修改事项类型（所有事项均修改：0；仅修改当前项：1；修改当前项及未来事项均生效：2） | + +#### 重复事项配置信息（repeat） + +| 字段名 | 类型 | 说明 | +| ------------ | ----------- | ------------------------------------------------------------ | +| freq | String | 重复频率（天："day"，周："week"，月："month"，年："year"） | +| interval | Int | 重复间隔 | +| until | Int | 重复结束时间 | +| every | List（int） | 重复区间，当`label`为`week`时这里是`0-6`(0为周天)的数字，当`label`为`month`的时候，这里是`1-31`的数字，当`label`为`year`的时候这里的数字是`1-12`(注：如果传入的start_time对应的标志不在重复区间内，则会自动将其加入） | +| exclude_date | List(int) | 排除事项日期(这里记录排除在重复范围内的日期) | + +- 不重复（默认）=>`repeat={}` + +- 每天 + + ```python + { + "freq": "day", + "interval": 1, # 间隔 + "until": 1648569600, # 结束日期 + "every": [], # 区间 + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每个工作日 + + ```python + { + "freq": "week", + "interval": 1, + "until": null, # 永不结束 + "every": [1,2,3,4,5], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每周 + + ```python + { + "freq": "week", + "interval": 1, + "until": null, + "every": [], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每月 + + ```python + { + "freq": "month", + "interval": 1, + "until": null, + "every": [], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每年 + + ```python + { + "freq": "year", + "interval": 1, + "until": null, + "every": [], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 自定义 + + 自定义这里，根据用户选择的重复结束日期和重复间隔在对应的位置进行处理 + + ```python + # 每三天并且永不结束 + { + "freq": "day", + "interval": 3, # 间隔 + "until": null, # 结束日期 + "every": [], # 区间 + "exclude_date": [] # 排除事项日期 + } + # 每四周并且10.1日结束 + { + "freq": "week", + "interval": 4, # 间隔 + "until": 1664553600, # 结束日期 + "every": [], # 区间 + "exclude_date": [] # 排除事项日期 + } + # 每周四和六并且两周一次，永不结束 + { + "freq": "week", + "interval": 2, # 间隔 + "until": null, # 结束日期 + "every": [4,6], # 区间 + "exclude_date": [] # 排除事项日期 + } + # 每月1号和15号重复，并且间隔3个月，永不重复 + { + "freq": "month", + "interval": 3, # 间隔 + "until": null, # 结束日期 + "every": [1, 15], # 区间 + "exclude_date": [] # 排除事项日期 + } + ``` + +#### 排除日期（repeat.exclude_date） + +当用户对一个重复的事项进行单个编辑或者删除的时候，对应的日期就会存入`exclude_date` + +例如：当有一从`2022-03-10至2022-03-20`的每天重复的事项，如果将15号的事项删除，则可以将3.15存入`exclude_date`，使之变成`[1647273600]` + +#### 示例数据 + +修改所有的事项名 + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx", + "id": 1, + "name": "新建事项111", + "change_type"：0 +} +``` + +修改单个事项的事项名 + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx", + "id": 1, + "name": "新建事项222", + "change_type": 1 +} +``` + +修改当前事项及未来的所有事项 + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx", + "id": 1, + "name": "新建事项333", + "start_time": 1641517200, + "end_time": 1641524400, + "change_type": 2 +} +``` + +> 上面的例子是对1.7号当前及以后的事项进行批量修改，他们的名字进行了改变，并且事项的开始时间和结束时间均发生改变 + +### 响应参数 + +| 字段名 | 类型 | 描述 | +| ------- | ------ | ------------ | +| result | Bool | 请求是否成功 | +| code | Int | 返回的状态码 | +| message | String | 描述信息 | +| data | Dict | 事项信息 | + +#### data字段说明 + +| 字段名 | 类型 | 描述 | +| ------------ | ------ | -------------------------------------------------------- | +| id | Int | 事项ID | +| name | String | 事项名 | +| update_user | String | 更新者 | +| update_time | Int | 更新时间 | +| create_user | String | 创建者 | +| create_time | Int | 创建时间 | +| calendar_id | Int | 所属日历ID | +| start_time | Int | 事项开始时间 | +| end_time | Int | 事项结束时间 | +| repeat | Dict | 重复事项配置信息 | +| parent_id | Int | 父表ID（在编辑单个事项的时候，该字段将被用到，默认null） | +| is_first | Bool | 是否是第一个事项 | +| deep_color | String | 日历深色底色 | +| light_color | String | 日历浅色底色 | + +#### 重复事项配置信息（repeat） + +| 字段名 | 类型 | 说明 | +| ------------ | ----------- | ------------------------------------------------------------ | +| freq | String | 重复频率（天："day"，周："week"，月："month"，年："year"） | +| interval | Int | 重复间隔 | +| until | Int | 重复结束时间 | +| every | List（int） | 重复区间，当`label`为`week`时这里是`0-6`(0为周天)的数字，当`label`为`month`的时候，这里是`1-31`的数字，当`label`为`year`的时候这里的数字是`1-12` | +| exclude_date | List(int) | 排除事项日期(这里记录排除在重复范围内的日期) | + +- 不重复（默认）=>`repeat={}` + +- 每天 + + ```python + { + "freq": "day", + "interval": 1, # 间隔 + "until": 1648569600, # 结束日期 + "every": [], # 区间 + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每个工作日 + + ```python + { + "freq": "week", + "interval": 1, + "until": null, # 永不结束 + "every": [1,2,3,4,5], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每周 + + ```python + { + "freq": "week", + "interval": 1, + "until": null, + "every": [], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每月 + + ```python + { + "freq": "month", + "interval": 1, + "until": null, + "every": [], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每年 + + ```python + { + "freq": "year", + "interval": 1, + "until": null, + "every": [], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 自定义 + + 自定义这里，根据用户选择的重复结束日期和重复间隔在对应的位置进行处理 + + ```python + # 每三天并且永不结束 + { + "freq": "day", + "interval": 3, # 间隔 + "until": null, # 结束日期 + "every": [], # 区间 + "exclude_date": [] # 排除事项日期 + } + # 每四周并且10.1日结束 + { + "freq": "week", + "interval": 4, # 间隔 + "until": 1664553600, # 结束日期 + "every": [], # 区间 + "exclude_date": [] # 排除事项日期 + } + # 每周四和六并且两周一次，永不结束 + { + "freq": "week", + "interval": 2, # 间隔 + "until": null, # 结束日期 + "every": [4,6], # 区间 + "exclude_date": [] # 排除事项日期 + } + # 每月1号和15号重复，并且间隔3个月，永不重复 + { + "freq": "month", + "interval": 3, # 间隔 + "until": null, # 结束日期 + "every": [1, 15], # 区间 + "exclude_date": [] # 排除事项日期 + } + ``` + +#### 排除日期（repeat.exclude_date） + +当用户对一个重复的事项进行单个编辑或者删除的时候，对应的日期就会存入`exclude_date` + +例如：当有一从`2022-03-10至2022-03-20`的每天重复的事项，如果将15号的事项删除，则可以将3.15存入`exclude_date`，使之变成`[1647273600]` + +#### 示例数据 + +```json +{ + "message": "OK", + "code": 200, + "data": { + "id": 1, + "name": "新建事项", + "update_user": "xxx", + "update_time": 1647273600, + "create_user": "xxx", + "create_time": 1647273600, + "calendar_id": 1, + "start_time": 1641517200, + "end_time": 1641517400, + "repeat": { + "freq": "day", + "interval": 3, + "until": null, + "every": [], + "exclude_data": [1641571200, 1641830400] + }, + "parent_id": null, + "is_first": true, + "deep_color": "#111111", + "light_color": "#111111" + }, + "result": true +} +``` + +> 上面的例子就是一个名为“新建事项”的事项。他是主事项，他归属于`id`为1的日历，是一个每3天为一个周期，并且设置时间在早上8点到12点的永不停止的事项，但是在2022年1月8日和1月11日跳过的事项。 \ No newline at end of file diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/export_uptime_check_task.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/export_uptime_check_task.md index 8e2e1d040..dafbf747f 100644 --- a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/export_uptime_check_task.md +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/export_uptime_check_task.md @@ -10,7 +10,7 @@ | 字段 | 类型 | 必选 | 描述 | | ------ | ------ | ---- | ------------------------------------------------------------ | -| bk_biz_id | int | 是 | 业务id | +| biz_id | int | 是 | 业务id | | protocol | str | 否 | 协议类型(TCP、UDP、HTTP)| | task_ids | str | 否 | 任务ID，多个任务以逗号分隔 | | node_conf_needed | int | 否 | 是否导出任务相关的节点配置信息，0或1,默认为1 | @@ -22,7 +22,7 @@ "bk_app_code": "xxx", "bk_app_secret": "xxxxx", "bk_token": "xxxx", - "bk_biz_id": 2, + "biz_id": 2, "task_ids": "60", "protocol": "TCP" } diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/get_action_config.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/get_action_config.md new file mode 100644 index 000000000..ce8c5841f --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/get_action_config.md @@ -0,0 +1,167 @@ +### 功能描述 + +查询单个处理套餐 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段 | 类型 | 必选 | 描述 | +| --------- | ---- | ---- | ---------- | +| id | Int | 是 | 处理套餐ID | +| bk_biz_id | Int | 是 | 业务ID | + +#### 示例数据 + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx", + "id": 1, + "bk_biz_id": 2 +} +``` + +### 响应参数 + +| 字段 | 类型 | 描述 | +| ------- | ------ | ------------ | +| result | Bool | 请求是否成功 | +| code | Int | 返回的状态码 | +| message | String | 描述信息 | +| data | Dict | 处理套餐信息 | + +#### data字段说明 + +| 字段 | 类型 | 描述 | +| -------------- | ------ | ------------------------------------------------------------ | +| bk_biz_id | Int | 业务ID | +| name | String | 名称 | +| plugin_id | Int | 插件ID，选项：2（HTTP回调），3（作业平台），4（标准运维），5（流程服务），6（标准运维公共流程） | +| desc | String | 描述 | +| execute_config | Dict | 执行参数（根据plug_in对应的 plugin_type不同，所需参数也不同） | +| id | Int | 处理套餐ID | +| create_time | String | 创建时间 | +| create_user | String | 创建用户 | +| update_time | String | 更新时间 | +| Update_user | String | 更新用户 | + +#### 执行参数（plugin_id为2时） + +| 字段 | 类型 | 描述 | +| -------------------- | ------ | -------------------------------------------------------- | +| method | String | 请求方法，可选（"POST","GET","PUT"）默认"GET" | +| url | String | 回调地址 | +| headers | List | 请求头 | +| authorize | Dict | 认证信息 | +| body | Dict | 请求体 | +| query_params | List | 请求参数 | +| failed_retry | Dict | 失败重试机制 | +| need_poll | Bool | 是否需要告警（默认是） | +| notify_interval | Int | 告警周期（按s为单位，最小1分支，默认1h） | +| interval_notify_mode | String | 告警方法（可选"increasing", "standard"，默认"standard"） | + +##### execute_config.template_detail.headers + +| 字段 | 类型 | 描述 | +| ---------- | ------ | -------- | +| key | String | 字段名 | +| value | String | 字段值 | +| desc | String | 描述 | +| is_builtin | Bool | 是否内嵌 | +| is_enabled | Bool | 是否启用 | + +##### execute_config.template_detail.authorize + +| 字段 | 类型 | 描述 | +| ----------- | ------ | ------------------------------------------------- | +| auth_type | String | 类型（可选"none", "basic_auth", "bearer_token" ） | +| auth_config | Dict | 配置信息 | + +##### execute_config.template_detail.body + +| 字段 | 类型 | 描述 | +| ------------ | ------ | ------------------------------------------------------------ | +| data_type | String | 类型（可选"default", "raw", "form_data", "x_www_form_urlencoded"） | +| params | List | 与execute_config.headers参数配置一样 | +| content | String | 当type为raw时这里配置相关内容 | +| content_type | String | 内容类型（可选"text","json", "html","xml"默认"text"） | + +##### execute_config.template_detail.query_params + +| 字段 | 类型 | 描述 | +| ---------- | ------ | -------- | +| key | String | 字段名 | +| value | String | 字段值 | +| desc | String | 描述 | +| is_builtin | Bool | 是否内嵌 | +| is_enabled | Bool | 是否启用 | + +##### execute_config.template_detail.failed_retry + +| 字段 | 类型 | 描述 | +| --------------- | ---- | --------------------- | +| is_enabled | Bool | 是否启用 | +| value | Int | 处理时间 | +| max_retry_times | Int | 最大重试时间（最小0） | +| retry_interval | Int | 重试间隔（最小0） | + +#### 执行参数（plugin_id为其他选项时） + +| 字段 | 类型 | 描述 | +| --------------- | ------ | ------------------------------- | +| template_id | String | 周边系统的模版ID | +| template_detail | Dict | 模版详情（默认{}） | +| timeout | Int | 执行超时时间（单位s，默认600s） | + +#### 示例数据 + +```json +{ + "message": "OK", + "code": 200, + "data": { + "execute_config": { + "template_detail": { + "method": "GET", + "url": "http://www.baidu.com", + "headers": [], + "authorize": { + "auth_config": {}, + "auth_type": "none", + "insecure_skip_verify": false + }, + "body": { + "data_type": "default", + "content_type": "", + "content": "", + "params": [] + }, + "query_params": [], + "need_poll": false, + "notify_interval": 7200, + "failed_retry": { + "is_enabled": true, + "max_retry_times": 2, + "retry_interval": 2, + "timeout": 10 + } + }, + "timeout": 600 + }, + "name": "测试新建处理套餐", + "desc": "测试新建处理套餐1111", + "is_enabled": false, + "bk_biz_id": 2, + "id": 1, + "create_time": "2022-02-25 11:01:25+0800", + "create_user": "admin", + "update_time": "2022-02-25 15:19:23+0800", + "update_user": "admin" + }, + "result": true +} +``` \ No newline at end of file diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/get_calendar.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/get_calendar.md new file mode 100644 index 000000000..75a5d5f7a --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/get_calendar.md @@ -0,0 +1,72 @@ +### 功能描述 + +查询单个日历 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段名 | 类型 | 必选 | 描述 | +| ------ | ------ | ---- | -------- | +| id | Int | 否 | 日历Id | +| name | String | 否 | 日历名称 | + +> 支持按照id查询或日历名称查询，这两个必须输入一个，如果都输入则返回符合条件的日历信息 + +#### 示例数据 + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx", + "id": 1, + "name": "测试日历" +} +``` + +### 响应参数 + +| 字段名 | 类型 | 描述 | +| ------- | ------ | ------------ | +| result | bool | 请求是否成功 | +| code | int | 返回的状态码 | +| message | string | 描述信息 | +| data | dict | 日历的信息 | + +#### data字段说明 + +| 字段名 | 类型 | 描述 | +| ----------- | ------ | --------------------------------------------- | +| id | Int | 日历ID | +| name | String | 日历名称 | +| update_user | String | 更新者 | +| update_time | Int | 更新时间 | +| create_user | String | 创建者 | +| create_time | Int | 创建时间 | +| classify | String | 日历分类（内置："default"，自定义："custom"） | +| deep_color | String | 日历深色底色 | +| Light_color | String | 日历浅色底色 | + +#### 示例数据 + +```json +{ + "message": "OK", + "code": 200, + "data": { + "id": 1, + "name": "测试日历", + "update_user": "xxx", + "update_time": 1647273600, + "create_user": "xxx", + "create_time": 1647273600, + "classify": "custom", + "deep_color": "#BBFFFF", + "light_color": "#111111" + }, + "result": true +} +``` \ No newline at end of file diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/get_ts_data.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/get_ts_data.md index 9d386d4bf..5fc76c51e 100644 --- a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/get_ts_data.md +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/get_ts_data.md @@ -31,19 +31,16 @@ >sql中的结果表名为biz_id + db_name + table_name > ->- Biz_id：业务id -> ->- Db_name: 数据库名 -> ->- Table_name: 数据表名 -> -> 例：2_system_cpu_detail：业务2下的system库的cpu_detail表 ,查询一个小时内的单核cpu的使用率的sql语句： -> -> Select Mean(usage) as usage from 2_system_detail where time > '1h' group by ip,device_name,minute1 limit 10 +>Biz_id：业务id +>Db_name: 数据库名 +>Table_name: 数据表名 +>例：2_system_cpu_detail：业务2下的system库的cpu_detail表 +>查询一个小时内的单核cpu的使用率的sql语句： +>Select Mean(usage) as usage from 2_system_detail where time > '1h' group by ip,device_name,minute1 limit 10 >上面请求实例中结果表3_system_disk表示：业务3下的system库中的disk表 ->注意：上述的库和表并非和时序存储中的实际物理库、表对应。而是指`源数据管理模块`的库表 +>注意：上述的库和表并非和时序存储中的实际物理库、表对应。而是指'源数据管理模块'的库表 ### 返回结果 diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/import_uptime_check_task.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/import_uptime_check_task.md index 4f56c2ef1..1a2a481ec 100644 --- a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/import_uptime_check_task.md +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/import_uptime_check_task.md @@ -114,7 +114,7 @@ ###### 拨测任务详细配置(HTTP)--conf_list.collector_conf.config -| 字段 | 类型 | 必选 | +| 字段 | 类型 | 描述 | | -------------------- | ---- | ---- | | urls | str | 是 | | method | str | 是 | @@ -125,6 +125,7 @@ | timeout | int | 否 | | response | str | 否 | | response_code | str | 否 | +| request | str | 否 | ##### 监控策略配置--conf_list.monitor_conf diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/item_detail.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/item_detail.md new file mode 100644 index 000000000..b388fbf49 --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/item_detail.md @@ -0,0 +1,206 @@ +### 功能描述 + +获取某些日历下某个时间点的所有事项 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段名 | 类型 | 必选 | 描述 | +| ------------ | --------- | ---- | ---------------- | +| calendar_ids | List(int) | 是 | 日历列表 | +| time | Int | 是 | 查询事项的时间点 | +| start_time | Int | 否 | 查询详情开始时间 | + +#### 示例数据 + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx", + "calendar_ids": [1], + "time": 1642381200 +} +``` + +### 响应参数 + +| 字段名 | 类型 | 描述 | +| ------- | ------ | -------------------------------- | +| result | Bool | 请求是否成功 | +| code | Int | 返回的状态码 | +| message | String | 描述信息 | +| data | List | 该日历中对应时间点的所有事项列表 | + +#### data字段详解 + +| 字段名 | 类型 | 描述 | +| ----------- | ------ | ------------------------------ | +| id | Int | 事项ID | +| name | String | 事项名称 | +| start_time | Int | 事项开始时间 | +| end_time | Int | 事项结束时间 | +| update_user | String | 更新者 | +| update_time | Int | 更新时间 | +| create_user | String | 创建者 | +| create_time | Int | 创建时间 | +| calendar_id | Int | 所属日历ID | +| deep_color | String | 深色底色（由所属日历底色决定） | +| repeat | Dict | 重复事项配置信息 | +| is_first | Bool | 是否是第一个事项 | +| parent_id | Int | 父事项ID（默认为空） | +| Light_color | String | 浅色底色（由所属日历底色决定） | + +#### 重复事项配置信息（repeat） + +| 字段名 | 类型 | 说明 | +| ------------ | ----------- | ------------------------------------------------------------ | +| freq | String | 重复频率（天："day"，周："week"，月："month"，年："year"） | +| interval | Int | 重复间隔 | +| until | Int | 重复结束时间 | +| every | List（int） | 重复区间，当`label`为`week`时这里是`0-6`(0为周天)的数字，当`label`为`month`的时候，这里是`1-31`的数字，当`label`为`year`的时候这里的数字是`1-12`(注：如果传入的start_time对应的标志不在重复区间内，则会自动将其加入） | +| exclude_date | List(int) | 排除事项日期(这里记录排除在重复范围内的日期) | + +- 不重复（默认）=>`repeat={}` + +- 每天 + + ```python + { + "freq": "day", + "interval": 1, # 间隔 + "until": 1648569600, # 结束日期 + "every": [], # 区间 + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每个工作日 + + ```python + { + "freq": "week", + "interval": 1, + "until": null, # 永不结束 + "every": [1,2,3,4,5], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每周 + + ```python + { + "freq": "week", + "interval": 1, + "until": null, + "every": [], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每月 + + ```python + { + "freq": "month", + "interval": 1, + "until": null, + "every": [], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每年 + + ```python + { + "freq": "year", + "interval": 1, + "until": null, + "every": [], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 自定义 + + 自定义这里，根据用户选择的重复结束日期和重复间隔在对应的位置进行处理 + + ```python + # 每三天并且永不结束 + { + "freq": "day", + "interval": 3, # 间隔 + "until": null, # 结束日期 + "every": [], # 区间 + "exclude_date": [] # 排除事项日期 + } + # 每四周并且10.1日结束 + { + "freq": "week", + "interval": 4, # 间隔 + "until": 1664553600, # 结束日期 + "every": [], # 区间 + "exclude_date": [] # 排除事项日期 + } + # 每周四和六并且两周一次，永不结束 + { + "freq": "week", + "interval": 2, # 间隔 + "until": null, # 结束日期 + "every": [4,6], # 区间 + "exclude_date": [] # 排除事项日期 + } + # 每月1号和15号重复，并且间隔3个月，永不重复 + { + "freq": "month", + "interval": 3, # 间隔 + "until": null, # 结束日期 + "every": [1, 15], # 区间 + "exclude_date": [] # 排除事项日期 + } + ``` + +#### 排除日期（repeat.exclude_date） + +当用户对一个重复的事项进行单个编辑或者删除的时候，对应的日期就会存入`exclude_date` + +例如：当有一从`2022-03-10至2022-03-20`的每天重复的事项，如果将15号的事项删除，则可以将3.15存入`exclude_date`，使之变成`[1647273600]` + +#### 示例数据 + +```json +{ + "message": "OK", + "code": 200, + "data": [ + { + "id": 1, + "name": "新建事项", + "start_time": 1673913600, + "end_time": 1673928000, + "update_user": "xxx", + "update_time": 1648569600, + "create_user": "xxx", + "create_time": 1648569600, + "calendar_id": 1, + "deep_color": "#BBFFFF", + "repeat": { + "freq": "day", + "interval": 3, + "until": null, + "every": [], + "exclude_date": [] + }, + "is_first": true, + "parent_id": null, + "light_color": "#111111" + } + ], + "result": true +} +``` \ No newline at end of file diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/item_list.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/item_list.md new file mode 100644 index 000000000..943fc7ddd --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/item_list.md @@ -0,0 +1,246 @@ +### 功能描述 + +查询规定日期内的所有日历事项列表 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段名 | 类型 | 必选 | 描述 | +| ------------ | --------- | ---- | ------------------------------------------------ | +| calendar_ids | List(int) | 是 | 日历列表 | +| start_time | Int | 是 | 日历查询范围开始时间 | +| end_time | Int | 是 | 日历查询范围结束时间 | +| time_zone | String | 否 | 时区信息，如果不填，默认使用创建时的时区进行查询 | +| search_key | String | 否 | 搜索关键字 | + +#### 示例数据 + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx", + "calendar_ids": [1], + "start_time": 1640966400, + "end_time": 1672502400 +} +``` + +> 上面是查找id为1的日历在2022年整年的日历事项 + +### 响应参数 + +| 字段名 | 类型 | 描述 | +| ------- | ------ | ------------------------ | +| result | Bool | 请求是否成功 | +| code | Int | 返回的状态码 | +| message | String | 描述信息 | +| data | List | 时间范围内的所有日历事项 | + +#### data字段详解 + +| 字段名 | 类型 | 描述 | +| ----------- | ------ | ------------------------------------ | +| id | Int | 事项ID | +| name | String | 事项名称 | +| start_time | Int | 事项开始时间 | +| end_time | Int | 事项结束时间 | +| update_user | String | 更新者 | +| update_time | Int | 更新时间 | +| create_user | String | 创建者 | +| create_time | Int | 创建时间 | +| calendar_id | Int | 所属日历ID | +| deep_color | String | 深色底色（由所属日历底色决定） | +| repeat | Dict | 重复事项配置信息 | +| is_first | Bool | 是否是第一个事项 | +| parent_id | Int | 父事项ID | +| status | Bool | 事项是否有效（和此刻的时间进行对比） | +| Light_color | String | 浅色底色（由所属日历底色决定） | + +#### 重复事项配置信息（repeat） + +| 字段名 | 类型 | 说明 | +| ------------ | ----------- | ------------------------------------------------------------ | +| freq | String | 重复频率（天："day"，周："week"，月："month"，年："year"） | +| interval | Int | 重复间隔 | +| until | Int | 重复结束时间 | +| every | List（int） | 重复区间，当`label`为`week`时这里是`0-6`(0为周天)的数字，当`label`为`month`的时候，这里是`1-31`的数字，当`label`为`year`的时候这里的数字是`1-12` | +| exclude_date | List(int) | 排除事项日期(这里记录排除在重复范围内的日期) | + +- 不重复（默认）=>`repeat={}` + +- 每天 + + ```python + { + "freq": "day", + "interval": 1, # 间隔 + "until": 1648569600, # 结束日期 + "every": [], # 区间 + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每个工作日 + + ```python + { + "freq": "week", + "interval": 1, + "until": null, # 永不结束 + "every": [1,2,3,4,5], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每周 + + ```python + { + "freq": "week", + "interval": 1, + "until": null, + "every": [], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每月 + + ```python + { + "freq": "month", + "interval": 1, + "until": null, + "every": [], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每年 + + ```python + { + "freq": "year", + "interval": 1, + "until": null, + "every": [], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 自定义 + + 自定义这里，根据用户选择的重复结束日期和重复间隔在对应的位置进行处理 + + ```python + # 每三天并且永不结束 + { + "freq": "day", + "interval": 3, # 间隔 + "until": null, # 结束日期 + "every": [], # 区间 + "exclude_date": [] # 排除事项日期 + } + # 每四周并且10.1日结束 + { + "freq": "week", + "interval": 4, # 间隔 + "until": 1664553600, # 结束日期 + "every": [], # 区间 + "exclude_date": [] # 排除事项日期 + } + # 每周四和六并且两周一次，永不结束 + { + "freq": "week", + "interval": 2, # 间隔 + "until": null, # 结束日期 + "every": [4,6], # 区间 + "exclude_date": [] # 排除事项日期 + } + # 每月1号和15号重复，并且间隔3个月，永不重复 + { + "freq": "month", + "interval": 3, # 间隔 + "until": null, # 结束日期 + "every": [1, 15], # 区间 + "exclude_date": [] # 排除事项日期 + } + ``` + +#### 排除日期（repeat.exclude_date） + +当用户对一个重复的事项进行单个编辑或者删除的时候，对应的日期就会存入`exclude_date` + +例如：当有一从`2022-03-10至2022-03-20`的每天重复的事项，如果将15号的事项删除，则可以将3.15存入`exclude_date`，使之变成`[1647273600]` + +#### 示例数据 + +```json +{ + "message": "OK", + "code": 200, + "data": [ + { + "today": 1641312000, + "list": [ + { + "id": 1, + "name": "新建事项", + "start_time": 1641340800, + "end_time": 1641355200, + "update_user": "xxx", + "update_time": 1648569600, + "create_user": "xxx", + "create_time": 1648569600, + "calendar_id": 1, + "deep_color": "#BBFFFF", + "repeat": { + "freq": "day", + "interval": 3, + "until": null, + "every": [], + "exclude_date": [] + }, + "is_first": true, + "parent_id": null, + "status": true, + "light_color": "#111111" + } + ] + }, + { + "today": 1673625600, + "list": [ + { + "id": 1, + "name": "新建事项", + "start_time": 1673654400, + "end_time": 1673668800, + "update_user": "xxx", + "update_time": 1648569600, + "create_user": "xxx", + "create_time": 1648569600, + "calendar_id": 1, + "deep_color": "#BBFFFF", + "light_color": "#111111", + "repeat": { + "freq": "day", + "interval": 3, + "until": null, + "every": [], + "exclude_date": [] + }, + "is_first": false, + "parent_id": null, + "status": false + } + ] + } + ], + "result": true +} +``` \ No newline at end of file diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/list_calendar.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/list_calendar.md new file mode 100644 index 000000000..3f6fad67c --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/list_calendar.md @@ -0,0 +1,74 @@ +### 功能描述 + +批量获取日历列表 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段名 | 类型 | 必选 | 描述 | +| --------- | ------ | ---- | ------------------------------------------------------------ | +| page | Int | 否 | 当前页（默认1） | +| page_size | Int | 否 | 页面大小（默认10， 最大1000） | +| order | String | 否 | 排序方式（可选"id", "create_time", "update_time"如果想要反向在前面加"-"，默认按照"-update_time"查询） | + +#### 示例数据 + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx" +} +``` + +### 响应参数 + +| 字段名 | 类型 | 描述 | +| ------- | ------ | ------------ | +| result | Bool | 请求是否成功 | +| code | Int | 返回的状态码 | +| message | String | 描述信息 | +| data | List | 日历的信息 | + +#### data字段说明 + +| 字段名 | 类型 | 描述 | +| ----------- | ------ | --------------------------------------------- | +| id | Int | 日历ID | +| name | String | 日历名称 | +| update_user | String | 更新者 | +| update_time | Int | 更新时间 | +| create_user | String | 创建者 | +| create_time | Int | 创建时间 | +| classify | String | 日历分类（内置："default"，自定义："custom"） | +| deep_color | String | 日历深色底色 | +| light_color | String | 日历浅色底色 | + +#### 示例数据 + +```json +{ + "message": "OK", + "code": 200, + "data": { + "data": [ + { + "id": 1, + "name": "测试日历", + "update_user": "xxx", + "update_time": 1647273600, + "create_user": "xxx", + "create_time": 1647273600, + "classify": "custom", + "deep_color": "#BBFFFF", + "light_color": "#111111" + } + ], + "count": 1 + }, + "result": true +} +``` \ No newline at end of file diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/list_shield.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/list_shield.md index c872730b7..2c47da7ee 100644 --- a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/list_shield.md +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/list_shield.md @@ -8,13 +8,13 @@ #### 接口参数 -| 字段 | 类型 | 是否必选 | 描述 | -| ---------- | ------ |------| -------- | -| time_range | string | 否 | 时间范围 | -| bk_biz_id | int | 否 | 业务ID | -| is_active | bool | 否 | 是否生效 | -| page | int | 否 | 页数 | -| page_size | int | 否 | 每页数量 | +| 字段 | 类型 | 描述 | +| ---------- | ------ | -------- | +| time_range | string | 时间范围 | +| bk_biz_id | int | 业务ID | +| is_active | bool | 是否生效 | +| page | int | 页数 | +| page_size | int | 每页数量 | #### 示例数据 diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/metadata_create_time_series_group.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/metadata_create_time_series_group.md index 7451add97..58a8eb551 100644 --- a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/metadata_create_time_series_group.md +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/metadata_create_time_series_group.md @@ -22,10 +22,10 @@ #### metric_info_list具体内容说明 -| 字段 | 类型 | 必选 | 描述 | -| ------------------- | ------ |-----| -------- | -| field_name | string | 是 | 自定义时序名 | -| tag | list | 是 | 维度列表 | +| 字段 | 类型 | 描述 | +| ------------------- | ------ | -------- | +| field_name | string | 自定义时序名 | +| tag | list | 维度列表 | #### 请求示例 diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/metadata_get_data_id.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/metadata_get_data_id.md index 842b5348a..e5095bbe0 100644 --- a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/metadata_get_data_id.md +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/metadata_get_data_id.md @@ -15,6 +15,7 @@ | -------------- | ------ | ---- | ----------- | | bk_data_id | int | 否 | 数据源ID | | data_name | string | 否 | 数据源名称 | +| with_rt_info | bool | 否 | 是否需要ResultTable信息（默认是） | > 注意： > 1. 上述两个必须提供一个，不可以两者同时为空; @@ -27,7 +28,8 @@ "bk_app_code": "xxx", "bk_app_secret": "xxxxx", "bk_token": "xxxx", - "bk_data_id": 1001 + "bk_data_id": 1001, + "with_rt_info": false } ``` diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_action_config.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_action_config.md new file mode 100644 index 000000000..cc2d69925 --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_action_config.md @@ -0,0 +1,150 @@ +### 功能描述 + +保存处理套餐 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段 | 类型 | 必选 | 描述 | +| -------------- | ------ | ---- | ------------------------------------------------------------ | +| bk_biz_id | Int | 是 | 业务ID | +| name | String | 是 | 名称 | +| plugin_id | Int | 是 | 插件ID，可选项：2（HTTP回调），3（作业平台），4（标准运维），5（流程服务），6（标准运维公共流程） | +| desc | String | 否 | 描述 | +| execute_config | Dict | 是 | 执行参数（根据plug_in对应的 plugin_type不同，所需参数也不同） | + +#### 执行参数（plugin_id为2时） + +| 字段 | 类型 | 必选 | 描述 | +| -------------------- | ------ | ---- | -------------------------------------------------------- | +| method | String | 否 | 请求方法，可选（"POST","GET","PUT"）默认"GET" | +| url | String | 是 | 回调地址 | +| headers | List | 否 | 请求头 | +| authorize | Dict | 否 | 认证信息 | +| body | Dict | 否 | 请求体 | +| query_params | List | 否 | 请求参数 | +| failed_retry | Dict | 否 | 失败重试机制 | +| need_poll | Bool | 否 | 是否需要告警（默认是） | +| notify_interval | Int | 否 | 告警周期（按s为单位，最小1分钟，默认1h） | +| interval_notify_mode | String | 否 | 告警方法（可选"increasing", "standard"，默认"standard"） | + +##### execute_config.template_detail.headers + +| 字段 | 类型 | 必选 | 描述 | +| ---------- | ------ | ---- | -------- | +| key | String | 是 | 字段名 | +| value | String | 否 | 字段值 | +| desc | String | 否 | 描述 | +| is_builtin | Bool | 否 | 是否内嵌 | +| is_enabled | Bool | 否 | 是否启用 | + +##### execute_config.template_detail.authorize + +| 字段 | 类型 | 必选 | 描述 | +| ----------- | ------ | ---- | ------------------------------------------------- | +| auth_type | String | 是 | 类型（可选"none", "basic_auth", "bearer_token" ） | +| auth_config | Dict | 否 | 配置信息 | + +##### execute_config.template_detail.body + +| 字段 | 类型 | 必选 | 描述 | +| ------------ | ------ | ---- | ------------------------------------------------------------ | +| data_type | String | 否 | 类型（可选"default", "raw", "form_data", "x_www_form_urlencoded"） | +| params | List | 否 | 与execute_config.headers参数配置一样 | +| content | String | 否 | 当type为raw时这里配置相关内容 | +| content_type | String | 否 | 内容类型（可选"text","json", "html","xml"默认"text"） | + +##### execute_config.template_detail.query_params + +| 字段 | 类型 | 必选 | 描述 | +| ---------- | ------ | ---- | -------- | +| key | String | 是 | 字段名 | +| value | String | 否 | 字段值 | +| desc | String | 否 | 描述 | +| is_builtin | Bool | 否 | 是否内嵌 | +| is_enabled | Bool | 否 | 是否启用 | + +##### execute_config.template_detail.failed_retry + +| 字段 | 类型 | 必选 | 描述 | +| --------------- | ---- | ---- | --------------------- | +| is_enabled | Bool | 否 | 是否启用 | +| value | Int | 否 | 处理时间 | +| max_retry_times | Int | 是 | 最大重试时间（最小0） | +| retry_interval | Int | 是 | 重试间隔（最小0） | + +#### 执行参数（plugin_id为其他选项时） + +| 字段 | 类型 | 必选 | 描述 | +| --------------- | ------ | ---- | ------------------------------- | +| template_id | String | 是 | 周边系统的模版ID | +| template_detail | Dict | 是 | 模版详情（默认{}） | +| timeout | Int | 是 | 执行超时时间（单位s，默认600s） | + +#### 示例数据 + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx", + "execute_config": { + "template_detail": { + "method": "GET", + "url": "http://www.baidu.com", + "headers": [], + "authorize": { + "auth_config": {}, + "auth_type": "none", + "insecure_skip_verify": false + }, + "body": { + "data_type": "default", + "content_type": "", + "content": "", + "params": [] + }, + "query_params": [], + "need_poll": false, + "notify_interval": 7200, + "failed_retry": { + "is_enabled": true, + "max_retry_times": 2, + "retry_interval": 2, + "timeout": 10 + } + }, + "timeout": 600 + }, + "name": "测试新建处理套餐", + "desc": "测试新建处理套餐1111", + "is_enabled": false, + "bk_biz_id": 2, + "plugin_id": 2 +} +``` + +### 响应参数 + +| 字段 | 类型 | 描述 | +| ------- | ------ | -------------- | +| result | bool | 请求是否成功 | +| code | int | 返回的状态码 | +| message | string | 描述信息 | +| data | Int | 处理套餐配置id | + +#### 示例数据 + +```json +{ + "message": "OK", + "code": 200, + "data": { + "id": 1 + }, + "result": true +} +``` \ No newline at end of file diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_alarm_strategy.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_alarm_strategy.md index d22621ed2..ebd0fe78e 100644 --- a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_alarm_strategy.md +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_alarm_strategy.md @@ -285,9 +285,9 @@ host_set_template #### data字段说明 -| 字段 | 类型 | 描述 | -| ----------- | ---- | ------ | -| strategy_id | int | 策略ID | +| 字段 | 类型 | 必选 | 描述 | +| ----------- | ---- | ---- | ------ | +| strategy_id | int | 是 | 策略ID | #### 示例数据 diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_alarm_strategy_v3.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_alarm_strategy_v3.md new file mode 100644 index 000000000..8f34dfe2a --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_alarm_strategy_v3.md @@ -0,0 +1,561 @@ +### 功能描述 + +保存告警策略 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 +| 字段 | 类型 | 必选 | 描述 | +|:-----------|---------|-----|----------------| +| actions | list | 是 | 处理套餐列表(ActionRelation) | +| bk_biz_id | int | 是 | 业务ID | +| detects | list | 是 | 检测配置列表(Detect) | +| id | int | 是 | 策略ID | +| items | list | 是 | 监控项表(Item) | +| labels | list | 否 | 策略标签列表 | +| name | string | 是 | 策略名称 | +| scenario | string | 是 | 监控对象 | +| source | string | 是 | 监控源 | +| is_enabled | boolean | 否 | 是否开启，默认开启 | +| notice | object | 是 | 通知套餐(NoticeRelation) | + +#### ActionRelation + +| 字段 | 类型 | 必选 | 描述 | +|-----------------------------------|--------|-----|--------------| +| config_id | int | 否 | 套餐ID | +| user_groups | list | 否 | 通知组ID列表 | +| signal | list | 是 | 处理信号，允许为空, ACTION_SIGNAL多选 | +| options | string | 是 | 处理套餐配置 | +| options.converge_config | object | 是 | 收敛配置 | + + +#### NoticeRelation + +| 字段 | 类型 | 必选 | 描述 | +|-----------------------------------|--------|-----|--------------| +| options | dict | 是 | 通知套餐配置 | +| options.converge_config | string | 是 | 收敛配置 | +| options.start_time | string | 是 | 生效开始时间（格式：00:00:00） | +| options.end_time | string | 是 | 生效结束时间（格式：23:59:59) | +| config | string | 是 | | +| config.template | list | 是 | 通知模板配置 | +| config.template.signal | string | 是 | 触发信号，NOTICE_SIGNAL单选 | +| config.template.message_tmpl | string | 否 | 通知信息模板 | +| config.template.title_tmpl | string | 否 | 通知标题模板 | + +#### ConvergeConfig + +| 字段 | 类型 | 必选 | 描述 | +|-----------------------------------|--------|-----|--------------| +| need_biz_converge | boolean | 否 | 是否需要业务汇总 | + + +#### 相关选项 +##### NOTICE_SIGNAL +| 字段 | 标签 | +|-----------------------------------|--------| +|MANUAL|手动| +|ABNORMAL|告警触发时| +|RECOVERED|告警恢复时| +|CLOSED|告警关闭时| +|NO_DATA|无数据时| +|COLLECT|汇总| +|EXECUTE|执行动作时| +|EXECUTE_SUCCESS|执行成功时| +|EXECUTE_FAILED|执行失败时| +|DEMO|调试| + +##### ACTION_SIGNAL +| 字段 | 标签 | +|-----------------------------------|--------| +|ABNORMAL|告警触发时| +|RECOVERED|告警恢复时| +|CLOSED|告警关闭时| +|NO_DATA|无数据时| +|COLLECT|汇总| +|EXECUTE|执行动作时| +|EXECUTE_SUCCESS|执行成功时| +|EXECUTE_FAILED|执行失败时| + +##### CONVERGE_FUNCTION +| 字段 | 标签 | +|-----------------------------------|--------| + |SKIP_WHEN_SUCCESS|成功后跳过| + |SKIP_WHEN_PROCEED|执行中跳过| + |WAIT_WHEN_PROCEED|执行中等待| + |SKIP_WHEN_EXCEED|超出后忽略| + |DEFENSE|异常防御审批| + |COLLECT|超出后汇总| + |COLLECT_ALARM|汇总通知| + + +#### Detect + +| 字段 | 类型 | 必选 | 描述 | +|------------------------------|--------|-----|----------| +| id | int | 是 | 检测id | +| level | int | 是 | 告警级别 | +| expression | string | 是 | 计算公式 | +| trigger_config | dict | 是 | 触发条件配置 | +| trigger_config.count | int | 是 | 触发次数 | +| trigger_config.check_window | int | 是 | 触发周期 | +| recovery_config | dict | 是 | 恢复条件配置 | +| recovery_config.check_window | int | 是 | 恢复周期 | +| connector | string | 是 | 同级别算法连接符 | + +#### Item + +| 字段 | 类型 | 必选 | 描述 | +|---------------------------|--------|-----|---------------------| +| query_configs | list | 是 | 指标查询配置(QueryConfig) | +| id | string | 是 | 监控项配置id | +| name | string | 是 | 监控项名称 | +| expression | string | 是 | 计算公式 | +| origin_sql | string | 是 | 源sql | +| algorithms | list | 是 | 算法配置列表(Algorithm) | +| no_data_config | dict | 是 | 无数据配置 | +| no_data_config.is_enabled | bool | 是 | 是否开启无数据告警 | +| no_data_config.continuous | int | 否 | 无数据告警检测周期数 | +| target | list | 是 | 监控目标 | + +#### Target + +| 字段 | 类型 | 必选 | 描述 | +|--------|--------|-----|---------| +| field | string | 是 | 监控目标类型 | +| value | dict | 是 | 监控目标数据项 | +| method | string | 是 | 监控目标方法 | + +field - 根据目标节点类型和目标对象类型组合 +host_target_ip +host_ip +host_topo +service_topo +service_service_template +service_set_template +host_service_template +host_set_template + +```json +{ + "target": [ + [ + { + "field": "host_topo_node", + "method": "eq", + "value": [ + { + "bk_inst_id": 7, + "bk_obj_id": "biz" + } + ] + } + ] + ] +} +``` + +#### QueryConfig + +| 字段 | 类型 | 必选 | 描述 | +|-------------------|--------|-----|--------| +| alias | string | 是 | 别名 | +| data_source_label | string | 是 | 数据源标签 | +| data_type_label | string | 是 | 数据类型标签 | + +##### BkMonitorTimeSeries类型 + +```json +{ + "data_source_label": "bk_monitor", + "data_type_label": "time_series" +} +``` + +| 字段 | 类型 | 必选 | 描述 | +|-----------------|--------|-----|-------| +| metric_field | string | 是 | 指标 | +| unit | string | 是 | 单位 | +| agg_condition | list | 是 | 查询条件 | +| agg_dimension | list | 是 | 聚合维度 | +| agg_method | string | 是 | 聚合方法 | +| agg_interval | int | 是 | 聚合周期 | +| result_table_id | string | 是 | 结果表ID | + +##### BkMonitorLog类型 + +```json +{ + "data_source_label": "bk_monitor", + "data_type_label": "log" +} +``` + +| 字段 | 类型 | 必选 | 描述 | +|-----------------|--------|-----|------| +| agg_method | string | 是 | 聚合方法 | +| agg_condition | list | 是 | 查询条件 | +| result_table_id | string | 是 | 结果表 | +| agg_interval | int | 是 | 聚合周期 | + +##### BkMonitorEvent类型 + +```json +{ + "data_source_label": "bk_monitor", + "data_type_label": "event" +} +``` + +| 字段 | 类型 | 必选 | 描述 | +|-----------------|--------|-----|------| +| metric_field | string | 是 | 指标 | +| agg_condition | list | 是 | 查询条件 | +| result_table_id | string | 是 | 结果表 | + +##### BkLogSearchTimeSeries类型 + +```json +{ + "data_source_label": "bk_log_search", + "data_type_label": "time_series" +} +``` + +| 字段 | 类型 | 必选 | 描述 | +|-----------------|--------|-----|-------| +| metric_field | string | 是 | 指标 | +| index_set_id | int | 是 | 索引集ID | +| agg_condition | list | 是 | 查询条件 | +| agg_dimension | list | 是 | 聚合维度 | +| agg_method | string | 是 | 聚合方法 | +| result_table_id | string | 是 | 索引 | +| agg_interval | int | 是 | 聚合周期 | +| time_field | string | 是 | 时间字段 | +| unit | string | 是 | 单位 | + +##### BkLogSearchLog类型 + +```json +{ + "data_source_label": "bk_log_search", + "data_type_label": "log" +} +``` + +| 字段 | 类型 | 必选 | 描述 | +|-----------------|--------|-----|-------| +| index_set_id | int | 是 | 索引集ID | +| agg_condition | list | 是 | 查询条件 | +| query_string | int | 是 | 查询语句 | +| agg_dimension | list | 是 | 聚合维度 | +| result_table_id | string | 是 | 索引 | +| agg_interval | int | 是 | 聚合周期 | +| time_field | string | 是 | 时间字段 | + +##### CustomEvent类型 + +```json +{ + "data_source_label": "custom", + "data_type_label": "event" +} +``` + +| 字段 | 类型 | 必选 | 描述 | +|-------------------|--------|-----|---------| +| custom_event_name | string | 是 | 自定义事件名称 | +| agg_condition | list | 是 | 查询条件 | +| agg_interval | int | 是 | 聚合周期 | +| agg_dimension | list | 是 | 查询维度 | +| agg_method | string | 是 | 聚合方法 | +| result_table_id | string | 是 | 结果表ID | + +##### CustomTimeSeries类型 + +```json +{ + "data_source_label": "custom", + "data_type_label": "time_series" +} +``` + | 字段 | 类型 | 必选 | 描述 | +|-----------------|--------|-----|-------| +| metric_field | string | 是 | 指标 | +| unit | string | 是 | 单位 | +| agg_condition | list | 是 | 查询条件 | +| agg_dimension | list | 是 | 聚合维度 | +| agg_method | string | 是 | 聚合方法 | +| agg_interval | int | 是 | 聚合周期 | +| result_table_id | string | 是 | 结果表ID | + +##### BkDataTimeSeries类型 + +```json +{ + "data_source_label": "bk_data", + "data_type_label": "time_series" +} +``` + +| 字段 | 类型 | 必选 | 描述 | +|-----------------|--------|-----|------| +| metric_field | string | 是 | 指标 | +| unit | string | 是 | 单位 | +| agg_condition | list | 是 | 查询条件 | +| agg_dimension | list | 是 | 聚合维度 | +| agg_method | string | 是 | 聚合方法 | +| agg_interval | int | 是 | 聚合周期 | +| result_table_id | string | 是 | 结果表 | +| time_field | string | 是 | 时间字段 | + + + +#### Algorithm + +| 字段 | 类型 | 必选 | 描述 | +|-------------|--------|-----|--------| +| config | list | 是 | 算法配置列表 | +| level | int | 是 | 告警级别 | +| type | string | 是 | 算法类型 | +| unit_prefix | string | 否 | 算法单位前缀 | + +#### 算法配置config + +##### 静态阈值Threshold + +```json +[ + { + "method": "gt", // gt,gte,lt,lte,eq,neq + "threshold": "1" + } +] +``` + +##### 简单环比SimpleRingRatio + +```json +{ + "floor": "1", + "ceil": "1" +} +``` + +##### 简单同比SimpleYearRound + +```json +{ + "floor": "1", + "ceil": "1" +} +``` + +##### 高级环比AdvancedRingRatio + +```json +{ + "floor": "1", + "ceil": "1", + "floor_interval": 1, + "ceil_interval": 1 +} +``` + +##### 高级同比AdvancedYearRound + +与高级环比检测算法配置格式一致 + +##### 智能异常检测IntelligentDetect + +```json +{ + "sensitivity_value": 1 // 0-100 + "anomaly_detect_direct": "ceil" // "ceil", "floor", "all"(default) +} +``` + +##### 同比振幅YearRoundAmplitude + +```json +{ + "ratio": 1, + "shock": 1, + "days": 1, + "method": "gte" // gt,gte,lt,lte,eq,neq +} +``` + +##### 同比区间YearRoundRange + +与同比振幅配置格式一致 + +##### 环比振幅RingRatioAmplitude + +```json +{ + "ratio": 1, + "shock": 1, + "days": 1, + "threshold": 1 +} +``` + +#### 示例数据 + +```json +{ + "id": 36, + "bk_biz_id": 7, + "scenario": "host_process", + "name": "进程端口", + "labels": [], + "is_enabled": true, + "items": [ + { + "name": "AVG(CPU使用率)", + "no_data_config": { + "continuous": 10, + "is_enabled": false, + "agg_dimension": [ + "bk_target_ip", + "bk_target_cloud_id" + ], + "level": 2 + }, + "target": [], + "expression": "a", + "origin_sql": "", + "query_configs": [ + { + "data_source_label": "bk_monitor", + "data_type_label": "time_series", + "alias": "a", + "result_table_id": "system.cpu_summary", + "agg_method": "AVG", + "agg_interval": 60, + "agg_dimension": [ + "bk_target_ip", + "bk_target_cloud_id" + ], + "agg_condition": [], + "metric_field": "usage", + "unit": "percent", + "metric_id": "bk_monitor.system.cpu_summary.usage", + "index_set_id": "", + "query_string": "*", + "custom_event_name": "usage", + "functions": [], + "time_field": "time", + "bkmonitor_strategy_id": "usage", + "alert_name": "usage" + } + ], + "algorithms": [ + { + "level": 1, + "type": "Threshold", + "config": [ + [ + { + "method": "gte", + "threshold": "80" + } + ] + ], + "unit_prefix": "%" + } + ] + } + ], + "detects": [ + { + "level": 2, + "expression": "", + "trigger_config": { + "count": 1, + "check_window": 5 + }, + "recovery_config": { + "check_window": 5 + }, + "connector": "and" + } + ], + "notice": { // 通知设置 + "config_id":0, // 套餐ID，如果不选套餐请置为0 + "user_groups":[ // 告警组ID + 1, + 2 + ], + "signal":["abnormal", "recovered"], // 触发信号，abnormal-异常，recovered-恢复，closed-关闭，execute-执行动作时, execute_success-执行成功, execute_failed-执行失败 + "options": { + "converge_config": { + "need_biz_converge": true // 告警风暴开关 + }, + "start_time": "00:00:00", + "end_time": "23:59:59" + }, + "config": { + "interval_notify_mode": "standard", // 间隔模式 + "notify_interval": 7200, // 通知间隔 + "template": [ // 通知模板配置 + { + "signal": "abnormal", // 触发信号：abnormal-告警触发时，recovered-告警恢复时，closed-告警关闭时 + "message_tmpl": "{{content.level}}\n{{content.begin_time}}\n{{content.time}}\n{{content.duration}}\n{{content.target_type}}\n{{content.data_source}}\n{{content.content}}\n{{content.current_value}}\n{{content.biz}}\n{{content.target}}\n{{content.dimension}}\n{{content.detail}}\n{{content.related_info}}", + "title_tmpl": "【{{level_name}}】{{business.bk_biz_name}} - {{alarm.name}}{{alarm.display_type}}" + }, + { + "signal": "recovered", + "message_tmpl": "{{content.level}}\n{{content.begin_time}}\n{{content.time}}\n{{content.duration}}\n{{content.target_type}}\n{{content.data_source}}\n{{content.content}}\n{{content.current_value}}\n{{content.biz}}\n{{content.target}}\n{{content.dimension}}\n{{content.detail}}\n{{content.related_info}}", + "title_tmpl": "【{{level_name}}】{{business.bk_biz_name}} - {{alarm.name}}{{alarm.display_type}}" + }, + { + "signal": "closed", + "message_tmpl": "{{content.level}}\n{{content.begin_time}}\n{{content.time}}\n{{content.duration}}\n{{content.target_type}}\n{{content.data_source}}\n{{content.content}}\n{{content.current_value}}\n{{content.biz}}\n{{content.target}}\n{{content.dimension}}\n{{content.detail}}\n{{content.related_info}}", + "title_tmpl": "【{{level_name}}】{{business.bk_biz_name}} - {{alarm.name}}{{alarm.display_type}}" + } + ] + } + }, + "actions":[ // 如果用户没有选处理动作，请置为空列表 + { + "config_id":333, // 套餐ID + "user_groups":[ // 告警组ID，提交时请与通知中设置的告警组保持一致 + 1, + 2 + ], + "options": { + "converge_config": { + "converge_func": "skip_when_success", // 防御动作 + "timedelta": 60, // 防御窗口大小（秒），默认设置为 60 + "count": 1 // 执行次数，默认设置为 1 + } + } + } + ] +} +``` + +### 响应参数 + +data返回保存的策略结构，与请求参数一致（示例数据中省略） + +#### 示例数据 + +```json +{ + "result": true, + "code": 200, + "message": "OK", + "data": {} +} +``` + + + + + diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_calendar.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_calendar.md new file mode 100644 index 000000000..780122c97 --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_calendar.md @@ -0,0 +1,50 @@ +### 功能描述 + +创建日历 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段 | 类型 | 必选 | 描述 | +| ----------- | ------ | ---- | ------------ | +| name | String | 是 | 日历名称 | +| deep_color | String | 是 | 日历深色底色 | +| Light_color | String | 是 | 日历浅色底色 | + +#### 示例数据 + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx", + "name": "测试日历", + "deep_color": "#BBFFFF", + "light_color": "#111111" +} +``` + +### 响应参数 + +| 字段 | 类型 | 描述 | +| ------- | ------ | ------------ | +| result | bool | 请求是否成功 | +| code | int | 返回的状态码 | +| message | string | 描述信息 | +| data | dict | 日历的id | + +#### 示例数据 + +```json +{ + "message": "OK", + "code": 200, + "data": { + "id": 1 + }, + "result": true +} +``` \ No newline at end of file diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_item.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_item.md new file mode 100644 index 000000000..cade59fd4 --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_item.md @@ -0,0 +1,181 @@ +### 功能描述 + +保存日历事项 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段名 | 类型 | 必选 | 描述 | +| ----------- | ------ | ---- | --------------------------------------- | +| name | String | 是 | 日历事项名称（最大15个汉字） | +| calendar_id | Int | 是 | 所属日历ID | +| start_time | Int | 是 | 事项开始时间 | +| end_time | Int | 是 | 事项结束时间 | +| repeat | Dict | 否 | 重复事项配置信息（默认为{},表示不重复） | +| time_zone | String | 是 | 时区信息 | + +#### 重复事项配置信息（repeat） + +| 字段名 | 类型 | 必选 | 说明 | +| ------------ | ----------- | ---- | ------------------------------------------------------------ | +| freq | String | 是 | 重复频率（天："day"，周："week"，月："month"，年："year"） | +| interval | Int | 是 | 重复间隔 | +| until | Int | 是 | 重复结束时间 | +| every | List（int） | 是 | 重复区间，当`label`为`week`时这里是`0-6`(0为周天)的数字，当`label`为`month`的时候，这里是`1-31`的数字，当`label`为`year`的时候这里的数字是`1-12`(注：如果传入的start_time对应的标志不在重复区间内，则会自动将其加入） | +| exclude_date | List(int) | 是 | 排除事项日期(这里记录排除在重复范围内的日期) | + +- 不重复（默认）=>`repeat={}` + +- 每天 + + ```python + { + "freq": "day", + "interval": 1, # 间隔 + "until": 1648569600, # 结束日期 + "every": [], # 区间 + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每个工作日 + + ```python + { + "freq": "week", + "interval": 1, + "until": null, # 永不结束 + "every": [1,2,3,4,5], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每周 + + ```python + { + "freq": "week", + "interval": 1, + "until": null, + "every": [], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每月 + + ```python + { + "freq": "month", + "interval": 1, + "until": null, + "every": [], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 每年 + + ```python + { + "freq": "year", + "interval": 1, + "until": null, + "every": [], + "exclude_date": [] # 排除事项日期 + } + ``` + +- 自定义 + + 自定义这里，根据用户选择的重复结束日期和重复间隔在对应的位置进行处理 + + ```python + # 每三天并且永不结束 + { + "freq": "day", + "interval": 3, # 间隔 + "until": null, # 结束日期 + "every": [], # 区间 + "exclude_date": [] # 排除事项日期 + } + # 每四周并且10.1日结束 + { + "freq": "week", + "interval": 4, # 间隔 + "until": 1664553600, # 结束日期 + "every": [], # 区间 + "exclude_date": [] # 排除事项日期 + } + # 每周四和六并且两周一次，永不结束 + { + "freq": "week", + "interval": 2, # 间隔 + "until": null, # 结束日期 + "every": [4,6], # 区间 + "exclude_date": [] # 排除事项日期 + } + # 每月1号和15号重复，并且间隔3个月，永不重复 + { + "freq": "month", + "interval": 3, # 间隔 + "until": null, # 结束日期 + "every": [1, 15], # 区间 + "exclude_date": [] # 排除事项日期 + } + ``` + +#### 排除日期（repeat.exclude_date） + +当用户对一个重复的事项进行单个编辑或者删除的时候，对应的日期就会存入`exclude_date` + +例如：当有一从`2022-03-10至2022-03-20`的每天重复的事项，如果将15号的事项删除，则可以将3.15存入`exclude_date`，使之变成`[1647273600]` + +#### 示例数据 + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx", + "name": "新建事项", + "calendar_id": 1, + "start_time": 1641340800, + "end_time": 1641351600, + "time_zone": "Asia/Shanghai", + "repeat": { + "freq": "day", + "interval": 3, + "until": null, + "every": [], + "exclude_date": [1641571200, 1641830400] + } +} +``` + +> 上面的例子就是一个名为“新建事项”的事项。他归属于`id`为1的日历，是一个每3天为一个周期，并且设置时间在早上8点到12点的永不停止的事项，但是在2022年1月8日和1月11日跳过的事项。 + +### 响应参数 + +| 字段名 | 类型 | 描述 | +| ------- | ------ | ------------ | +| result | Bool | 请求是否成功 | +| code | Int | 返回的状态码 | +| message | String | 描述信息 | +| data | id | 事项id | + +#### 示例数据 + +```json +{ + "message": "OK", + "code": 200, + "data": { + "id": 1 + }, + "result": true +} +``` \ No newline at end of file diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_action.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_action.md new file mode 100644 index 000000000..6d2e8c248 --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_action.md @@ -0,0 +1,460 @@ +### 功能描述 + +查询处理记录列表 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段 | 类型 | 必选 | 描述 | +| ------------- | -------------- | ---- | ------------------------------------------------------------ | +| bk_biz_ids | List[int] | 是 | 业务ID列表 | +| alert_ids | List[string] | 否 | 告警ID列表 | +| status | List[string] | 否 | 状态，可选 `MINE`, `ABNORMAL`, `CLOSED`, `RECOVERED` | +| conditions | List[Condtion] | 否 | 过滤条件 | +| query_string | string | 否 | 查询字符串，语法：https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-query-notes | +| ordering | list[string] | 否 | 排序字段，字段前面加 "-" 代表倒序 | +| start_time | int | 否 | 开始时间 | +| end_time | int | 否 | 结束时间 | +| page | int | 是 | 页数 | +| page_size | int | 是 | 每页条数（最大1000） | +| show_overview | bool | 否 | 是否返回总览统计信息，默认 true | +| show_aggs | bool | 否 | 是否返回聚合统计信息，默认 true | +| show_dsl | Bool | 否 | 是否返回DSL，默认False | + +#### 过滤条件（conditions） + +| 字段 | 类型 | 必须 | 描述 | +| :-------- | :----- | :--- | :----------------------------------------------------------- | +| key | string | 是 | 字段名 | +| value | List | 是 | 可取值的列表。当 `method = eq`，则满足其一即可；当`method = neq`，则全都不满足 | +| method | string | 是 | 匹配方式，可选 `eq`, `neq`，默认 `eq` | +| condition | string | 否 | 可选 `and`, `or` | + +#### 示例数据 + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx", + "alert_ids": ["16424876305819838"], + "bk_biz_id": 5000140, + "conditions": [ + { + "key": "parent_action_id", + "value": [0], + "method": "eq" + } + ], + "ordering": ["create_time"], + "page": 1, + "page_size": 100, + "status": ["failure", "success"] +} +``` + +### 响应参数 + +| 字段 | 类型 | 描述 | +| ------- | ------ | ------------ | +| result | bool | 请求是否成功 | +| code | int | 返回的状态码 | +| message | string | 描述信息 | +| data | dict | 返回数据 | + +#### data字段说明 + +#### data字段说明 + +| 字段 | 类型 | 描述 | +| -------- | ---- | ------------------ | +| actions | List | 所有的处理记录列表 | +| code | Int | 返回处理记录的条数 | +| aggs | List | 返回的聚合统计信息 | +| overview | List | 返回的总览统计信息 | + +#### data.actions字段说明 + +| 字段 | 类型 | 描述 | +| -------------------------- | ------------ | ------------------------------------------------------------ | +| action_config | Dict | 套餐配置 | +| action_config_id | Int | 套餐ID | +| action_name | String | 套餐名称 | +| action_plugin | Dict | 套餐插件快照 | +| action_plugin_type | String | 套餐类型 | +| action_plugin_type_display | String | 套餐类型名称 | +| alert_id | List(string) | 告警ID | +| alert_level | Int | 告警级别 | +| bk_biz_id | String | 业务ID | +| bk_biz_name | String | 业务名称 | +| bk_module_ids | List(int) | 模块ID | +| bk_module_names | String | 模块名称（以`,`分割） | +| bk_set_ids | List(int) | 集群ID | +| bk_set_names | String | 集群名称（以`,`分割） | +| bk_target_display | String | 目标 | +| content | Dict | 处理内容 | +| converge_count | Int | 告警收敛数量 | +| converge_id | Int | 告警收敛记录ID | +| create_time | Int | 创建时间 | +| dimension_string | String | 维度信息 | +| dimensions | Dict | 维度信息 | +| duration | String | 处理时长 | +| end_time | Int | 结束时间 | +| ex_data | Dict | 异常信息 | +| execute_times | Int | 执行次数 | +| failure_type | String | 失败类型 | +| id | String | 处理记录ID | +| inputs | Dict | 动作输入 | +| is_converge_primary | Bool | 是否为收敛关键记录 | +| is_parent_action | Bool | 是否为子任务 | +| operate_target_string | String | 执行对象 | +| operator | List(string) | 负责人 | +| outputs | Dict | 输出动作 | +| parent_action_id | Int | 父记录ID | +| raw_id | Int | 原始Id | +| related_action_ids | List | 关联的任务ID | +| signal | String | 触发信号 | +| signal_display | String | 触发信号别名 | +| status | String | 状态：running - 执行中,success - 成功, failure - 失败, skipped-已收敛， shield - 被屏蔽 | +| status_tips | String | 状态别名 | +| strategy_id | Int | 策略ID | +| strategy_name | String | 策略名称 | +| update_time | Int | 更新时间 | + +#### data.aggs字段说明（over_view结构与之类似） + +| 字段 | 类型 | 描述 | +| -------- | ----------- | ------------------ | +| id | String | 聚合统计ID | +| name | String | 聚合统计名称 | +| count | Int | 相关数量 | +| children | List（agg） | 该聚合统计可选内容 | + +#### 示例数据 + +```json +{ + "result": true, + "code": 200, + "message": "OK", + "data": { + "actions": [ + { + "id": "164248763151725306", + "converge_id": 0, + "is_converge_primary": false, + "status": "success", + "failure_type": "", + "ex_data": { + "message": "执行任务成功" + }, + "strategy_id": 41868, + "strategy_name": "CPU使用率告警", + "signal": "abnormal", + "alert_id": [ + "16424876305819838" + ], + "alert_level": 3, + "operator": [ + "xxxx" + ], + "inputs": { + "last_notify_interval": 0, + "time_range": "00:00:00--23:59:59", + "notify_info": { + "rtx": [ + "xxxxx" + ], + "mail": [ + "xxxx" + ], + "voice": [ + [ + "xxxx" + ] + ] + } + }, + "outputs": { + "retry_times": 1, + "execute_notify_result": {}, + "target_info": { + "bk_biz_name": "demo", + "bk_target_display": "10.0.0.1|0", + "dimensions": [ + { + "key": "ip", + "value": "10.0.0.1", + "display_key": "目标IP", + "display_value": "10.0.0.1" + }, + { + "key": "bk_cloud_id", + "value": 0, + "display_key": "云区域ID", + "display_value": 0 + } + ], + "strategy_name": "CPU使用率告警", + "operate_target_string": "None", + "bk_set_ids": [ + 5001664 + ], + "bk_set_names": "web服务", + "bk_module_ids": [ + 5004315 + ], + "bk_module_names": "nginx" + } + }, + "execute_times": 1, + "action_plugin_type": "notice", + "action_plugin": { + "id": 1, + "name": "通知", + "plugin_type": "notice", + "plugin_key": "notice", + "update_user": "admin", + "update_time": "2022-01-14T10:05:19.568322+08:00", + "is_enabled": true, + "config_schema": { + "content_template": "发送{{notice_way_display}}告警通知给{{notice_receiver}}{{status_display}}", + "content_template_with_url": "达到通知告警的执行条件【{{action_signal}}】，已触发告警通知" + }, + "backend_config": [ + { + "function": "execute_notify", + "name": "发送通知" + } + ] + }, + "action_name": "告警通知", + "action_config": { + "id": 36457, + "name": "告警通知", + "plugin_id": 1, + "bk_biz_id": 0, + "desc": "通知套餐，策略ID: 41868", + "execute_config": { + "template_detail": { + "need_poll": true, + "notify_interval": 7200, + "interval_notify_mode": "standard", + "template": [ + { + "signal": "abnormal", + "message_tmpl": "{{content.level}}\n{{content.begin_time}}\n{{content.time}}\n{{content.duration}}\n{{content.target_type}}\n{{content.data_source}}\n{{content.content}}\n{{content.current_value}}\n{{content.biz}}\n{{content.target}}\n{{content.dimension}}\n{{content.detail}}\n{{content.related_info}}", + "title_tmpl": "{{business.bk_biz_name}} - {{alarm.name}}{{alarm.display_type}}" + }, + { + "signal": "recovered", + "message_tmpl": "{{content.level}}\n{{content.begin_time}}\n{{content.time}}\n{{content.duration}}\n{{content.target_type}}\n{{content.data_source}}\n{{content.content}}\n{{content.current_value}}\n{{content.biz}}\n{{content.target}}\n{{content.dimension}}\n{{content.detail}}\n{{content.related_info}}", + "title_tmpl": "{{business.bk_biz_name}} - {{alarm.name}}{{alarm.display_type}}" + }, + { + "signal": "closed", + "message_tmpl": "{{content.level}}\n{{content.begin_time}}\n{{content.time}}\n{{content.duration}}\n{{content.target_type}}\n{{content.data_source}}\n{{content.content}}\n{{content.current_value}}\n{{content.biz}}\n{{content.target}}\n{{content.dimension}}\n{{content.detail}}\n{{content.related_info}}", + "title_tmpl": "{{business.bk_biz_name}} - {{alarm.name}}{{alarm.display_type}}" + } + ] + } + }, + "is_enabled": true, + "is_deleted": false, + "create_user": "xxxx", + "create_time": "2022-01-18T14:27:33.503839+08:00", + "update_user": "xxxx", + "update_time": "2022-01-18T14:27:50.870734+08:00", + "is_builtin": false, + "plugin_name": "通知", + "plugin_type": "notice" + }, + "action_config_id": 36457, + "is_parent_action": true, + "related_action_ids": null, + "parent_action_id": 0, + "create_time": 1642487631, + "update_time": 1642487631, + "end_time": 1642487631, + "bk_target_display": "10.0.0.1|0", + "bk_biz_id": "5000140", + "bk_biz_name": "demo", + "bk_set_ids": [ + 5001664 + ], + "bk_set_names": "web服务", + "bk_module_ids": [ + 5004315 + ], + "bk_module_names": "nginx", + "raw_id": 51725306, + "duration": "0s", + "operate_target_string": "None", + "content": { + "text": "达到通知告警的执行条件【告警触发时】，已触发告警通知", + "url": "xxxxxxx", + "action_plugin_type": "notice" + }, + "dimensions": [ + { + "key": "ip", + "value": "10.0.0.1", + "display_key": "目标IP", + "display_value": "10.0.0.1" + }, + { + "key": "bk_cloud_id", + "value": 0, + "display_key": "云区域ID", + "display_value": 0 + } + ], + "dimension_string": "目标IP(10.0.0.1) - 云区域ID(0)", + "status_tips": "执行任务成功", + "converge_count": 0, + "action_plugin_type_display": "通知", + "signal_display": "告警触发时" + } + ], + "total": 1, + "overview": { + "id": "action", + "name": "处理记录", + "count": 2, + "children": [ + { + "id": "success", + "name": "成功", + "count": 2 + }, + { + "id": "failure", + "name": "失败", + "count": 0 + } + ] + }, + "aggs": [ + { + "id": "action_plugin_type", + "name": "套餐类型", + "count": 2, + "children": [ + { + "id": "notice", + "name": "通知", + "count": 2 + }, + { + "id": "webhook", + "name": "HTTP回调", + "count": 0 + }, + { + "id": "job", + "name": "作业平台", + "count": 0 + }, + { + "id": "sops", + "name": "标准运维", + "count": 0 + }, + { + "id": "itsm", + "name": "流程服务", + "count": 0 + }, + { + "id": "sops_common", + "name": "标准运维公共流程", + "count": 0 + }, + { + "id": "authorize", + "name": "内置授权套餐", + "count": 0 + } + ] + }, + { + "id": "signal", + "name": "触发信号", + "count": 2, + "children": [ + { + "id": "manual", + "name": "手动", + "count": 0 + }, + { + "id": "abnormal", + "name": "告警触发时", + "count": 2 + }, + { + "id": "recovered", + "name": "告警恢复时", + "count": 0 + }, + { + "id": "closed", + "name": "告警关闭时", + "count": 0 + }, + { + "id": "no_data", + "name": "无数据时", + "count": 0 + }, + { + "id": "collect", + "name": "汇总", + "count": 0 + }, + { + "id": "execute_success", + "name": "执行成功时", + "count": 0 + }, + { + "id": "execute_failed", + "name": "执行失败时", + "count": 0 + }, + { + "id": "demo", + "name": "调试", + "count": 0 + } + ] + }, + { + "id": "duration", + "name": "处理时长", + "count": 2, + "children": [ + { + "id": "minute", + "name": "小于1h", + "count": 2 + }, + { + "id": "hour", + "name": "大于1h且小于1d", + "count": 0 + }, + { + "id": "day", + "name": "大于1d", + "count": 0 + } + ] + } + ] + } +} +``` \ No newline at end of file diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_action_config.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_action_config.md new file mode 100644 index 000000000..b9f961092 --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_action_config.md @@ -0,0 +1,180 @@ +### 功能描述 + +批量获取处理套餐 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段 | 类型 | 必选 | 描述 | +| --------- | ------ | ---- | ------------------------------------------------------------ | +| bk_biz_id | Int | 是 | 业务ID | +| page | Int | 否 | 当前页（默认1） | +| page_size | Int | 否 | 页面大小（默认0， 最大1000） | +| order | String | 否 | 排序方式（可选"id", "create_time", "update_time"如果想要反向在前面加"-"） | + +#### 示例数据 + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx", + "bk_biz_id": 2 +} +``` + +### 响应参数 + +| 字段 | 类型 | 描述 | +| ------- | ------ | ------------ | +| result | Bool | 请求是否成功 | +| code | Int | 返回的状态码 | +| message | String | 描述信息 | +| data | List | 处理套餐信息 | + +#### data字段说明 + +| 字段 | 类型 | 描述 | +| ----- | ---- | ------------------ | +| count | Int | 总条数 | +| data | List | 相关的套餐数据列表 | + +#### action_config_list + +| 字段 | 类型 | 描述 | +| -------------- | ------ | ------------------------------------------------------------ | +| bk_biz_id | Int | 业务ID | +| name | String | 名称 | +| plugin_id | Int | 插件ID，可选项：2（HTTP回调），3（作业平台），4（标准运维），5（流程服务），6（标准运维公共流程） | +| desc | String | 描述 | +| execute_config | Dict | 执行参数（根据plug_in对应的 plugin_type不同，所需参数也不同） | +| id | Int | 处理套餐ID | +| create_time | String | 创建时间 | +| create_user | String | 创建用户 | +| update_time | String | 更新时间 | +| Update_user | String | 更新用户 | + +#### 执行参数（plugin_id为2时） + +| 字段 | 类型 | 描述 | +| -------------------- | ------ | -------------------------------------------------------- | +| method | String | 请求方法，可选（"POST","GET","PUT"）默认"GET" | +| url | String | 回调地址 | +| headers | List | 请求头 | +| authorize | Dict | 认证信息 | +| body | Dict | 请求体 | +| query_params | List | 请求参数 | +| failed_retry | Dict | 失败重试机制 | +| need_poll | Bool | 是否需要告警（默认是） | +| notify_interval | Int | 告警周期（按s为单位，最小1分支，默认1h） | +| interval_notify_mode | String | 告警方法（可选"increasing", "standard"，默认"standard"） | + +##### execute_config.template_detail.headers + +| 字段 | 类型 | 描述 | +| ---------- | ------ | -------- | +| key | String | 字段名 | +| value | String | 字段值 | +| desc | String | 描述 | +| is_builtin | Bool | 是否内嵌 | +| is_enabled | Bool | 是否启用 | + +##### execute_config.template_detail.authorize + +| 字段 | 类型 | 描述 | +| ----------- | ------ | ------------------------------------------------- | +| auth_type | String | 类型（可选"none", "basic_auth", "bearer_token" ） | +| auth_config | Dict | 配置信息 | + +##### execute_config.template_detail.body + +| 字段 | 类型 | 描述 | +| ------------ | ------ | ------------------------------------------------------------ | +| data_type | String | 类型（可选"default", "raw", "form_data", "x_www_form_urlencoded"） | +| params | List | 与execute_config.headers参数配置一样 | +| content | String | 当type为raw时这里配置相关内容 | +| content_type | String | 内容类型（可选"text","json", "html","xml"默认"text"） | + +##### execute_config.template_detail.query_params + +| 字段 | 类型 | 描述 | +| ---------- | ------ | -------- | +| key | String | 字段名 | +| value | String | 字段值 | +| desc | String | 描述 | +| is_builtin | Bool | 是否内嵌 | +| is_enabled | Bool | 是否启用 | + +##### execute_config.template_detail.failed_retry + +| 字段 | 类型 | 描述 | +| --------------- | ---- | --------------------- | +| is_enabled | Bool | 是否启用 | +| value | Int | 处理时间 | +| max_retry_times | Int | 最大重试时间（最小0） | +| retry_interval | Int | 重试间隔（最小0） | + +#### 执行参数（plugin_id为其他选项时） + +| 字段 | 类型 | 描述 | +| --------------- | ------ | ---------------- | +| template_id | String | 周边系统的模版ID | +| template_detail | Dict | 超时时间 | +| timeout | Int | 执行超时时间 | + +#### 示例数据 + +```json +{ + "message": "OK", + "code": 200, + "data": { + "count": 1, + "data": [ + { + "execute_config": { + "template_detail": { + "method": "GET", + "url": "http://www.baidu.com", + "headers": [], + "authorize": { + "auth_config": {}, + "auth_type": "none", + "insecure_skip_verify": false + }, + "body": { + "data_type": "default", + "content_type": "", + "content": "", + "params": [] + }, + "query_params": [], + "need_poll": false, + "notify_interval": 7200, + "failed_retry": { + "is_enabled": true, + "max_retry_times": 2, + "retry_interval": 2, + "timeout": 10 + } + }, + "timeout": 600 + }, + "name": "测试新建处理套餐", + "desc": "测试新建处理套餐1111", + "is_enabled": false, + "bk_biz_id": 2, + "id": 1, + "create_time": "2022-02-25 11:01:25+0800", + "create_user": "admin", + "update_time": "2022-02-25 15:19:23+0800", + "update_user": "admin" + } + ] + }, + "result": true +} +``` \ No newline at end of file diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_alarm_strategy_v3.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_alarm_strategy_v3.md new file mode 100644 index 000000000..416f88994 --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_alarm_strategy_v3.md @@ -0,0 +1,580 @@ +### 功能描述 + +查询告警策略列表 + +### 接口参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段 | 类型 | 必选 | 描述 | +|-------------------|---------|-----|-----------| +| page | int | 否 | 页码，默认1 | +| page_size | int | 否 | 每页条数，默认10 | +| conditions | list | 否 | 查询条件Condition | +| bk_biz_id | int | 是 | 业务ID | +| scenario | char | 否 | 监控场景 | +| with_notice_group | Boolean | 否 | 是否补充通知组信息 | +| with_user_group_detail | Boolean | 否 | 补充通知组详细信息 | + +#### Condition + +| 字段 | 类型 | 必选 | 描述 | +|-------|--------|------|--------------| +| key | string | 是 | 筛选条件关键字 | +| value | list | 是 | 筛选条件值 | + +#### Condition.key +| 字段 | value类型 | 描述 | +|:------------------------|---------|--------| +| algorithm_type | string | 算法类型 | +| user_group_name | string | 告警组名 | +| user_group_id | int | 告警组id | +| strategy_status | string | 策略状态 | +| data_source_list | string | 数据来源 | +| label_name | string | 标签 | +| bk_cloud_id | int | 云区域ID | +| strategy_id | int | 策略ID | +| strategy_name | string | 策略名 | +| service_category | string | 服务分类 | +| task_id | int | 拨测任务ID | +| time_series_group_id | int | 自定义事件分组ID | +| time_series_group_id | int | 自定义指标分组ID | +| plugin_id | int | 插件ID | +| metric_id | string | 指标ID | +| metric_alias | string | 指标别名 | +| metric_name | string | 指标名 | +| updaters | string | 创建人 | +| updaters | string | 修改人 | +| scenario | string | 监控对象 | +| action_name | string | 套餐名 | +| result_table_id | string | 结果表 | +| invalid_type | string | 失效类型 | +| IP | string | ip | + +#### invalid_type选项 + "invalid_metric", + "invalid_target", + "invalid_related_strategy", + "deleted_related_strategy" + +#### algorithm_type选项 + "Threshold", + "SimpleRingRatio", + "AdvancedRingRatio", + "SimpleYearRound", + "AdvancedYearRound", + "PartialNodes", + "OsRestart", + "ProcPort", + "PingUnreachable", + "YearRoundAmplitude", + "YearRoundRange", + "RingRatioAmplitude", + "IntelligentDetect" + +#### strategy_status选项 + "ALERT", + "INVALID", + "OFF", + "ON" + +#### data_source_list选项 + "bk_monitor_time_series", + "log_time_series", + "bk_monitor_event", + "bk_data_time_series", + "custom_event", + "custom_time_series", + "bk_log_search_log", + "bk_monitor_log", + "bk_fta_event", + "bk_fta_alert", + "bk_monitor_alert" + +#### strategy_status选项 + "uptimecheck", + "application_check", + "service_module", + "component", + "host_process", + "os", + "host_device", + "kubernetes", + "hardware_device", + "other_rt" + +#### 示例数据 + +```json +{ + "page": 1, + "page_size": 10, + "conditions": [ + { + "key": "strategy_id", + "value": [ + "36" + ] + } + ], + "bk_biz_id": 7, + "with_notice_group": false, + "with_notice_group_detail": false +} +``` + +### 响应参数 + +| 字段 | 类型 | 描述 | +|:---------------------|------|------------------------| +| data_source_list | list | 数据源列表(DataSource) | +| user_group_list | list | 通知组列表(UserGroup) | +| scenario_list | list | 监控对象列表(Scenario) | +| strategy_config_list | int | 策略配置列表(StrategyConfig) | +| strategy_label_list | list | 策略标签列表(StrategyLabel) | + +#### DataSource + +| 字段 | 类型 | 描述 | +|-------------------|--------|------------| +| type | string | 数据类型 | +| name | string | 数据名称 | +| data_type_label | string | 数据类型标签 | +| data_source_label | string | 数据源标签 | +| count | int | 按数据源统计策略数量 | + + +#### UserGroup + +| 字段 | 类型 | 描述 | +|-------------------|------|-------------| +| user_group_id | list | 通知组ID | +| user_group_name | dict | 通知组名称 | +| count | int | 按通知组统计的策略数量 | + +#### Scenario + +| 字段 | 类型 | 描述 | +|--------------|--------|--------------| +| id | dict | 监控对象ID | +| display_name | string | 监控对象名称 | +| count | string | 按监控对象统计的策略数量 | + +#### StrategyConfig +| 字段 | 类型 | 描述 | +|:------------------------|---------|--------| +| actions | list | 处理套餐列表 | +| notice | list | 通知套餐列表 | +| source | string | 策略来源 | +| detects | list | 检测配置列表 | +| id | int | 策略ID | +| items | list | 监控项表 | +| labels | list | 策略标签列表 | +| name | string | 策略名称 | +| scenario | string | 监控对象 | +| is_enabled | Boolean | 是否开启 | +| update_time | string | 创建策略时间 | +| create_time | string | 创建策略时间 | +| update_user | string | 创建策略者 | +| create_user | string | 创建策略者 | +| alert_count | int | 告警次数 | +| type | string | 策略类型 | +| shield_info | dict | 屏蔽配置信息 | +| shield_info.is_shielded | Boolean | 是否屏蔽 | +| add_allowed | Boolean | 允许添加 | +| data_source_type | string | 数据源类型 | +| bk_biz_id | int | 业务ID | + + +#### StrategyLabel + +| 字段 | 类型 | 描述 | +|------------|--------|--------------| +| label_name | string | 策略标签名称 | +| id | int | 策略标签ID | +| count | string | 按策略标签统计的策略数量 | + +#### 示例数据 + +```json +{ + "result": true, + "code": 200, + "message": "OK", + "data": { + "scenario_list": [ + { + "id": "application_check", + "display_name": "业务应用", + "count": 0 + } + ], + "strategy_config_list": [ + { + "id": 38297, + "version": "v2", + "bk_biz_id": 100147, + "name": "测试", + "source": "bkmonitorv3", + "scenario": "os", + "type": "monitor", + "items": [ + { + "id": 40972, + "name": "AVG(CPU使用率)", + "no_data_config": { + "level": 2, + "continuous": 10, + "is_enabled": false, + "agg_dimension": [ + "bk_target_ip", + "bk_target_cloud_id" + ] + }, + "target": [ + [ + { + "field": "host_topo_node", + "value": [ + { + "bk_obj_id": "set", + "bk_inst_id": 68255 + } + ], + "method": "eq" + } + ] + ], + "expression": "a", + "origin_sql": "", + "query_configs": [ + { + "data_source_label": "bk_monitor", + "data_type_label": "time_series", + "alias": "a", + "metric_id": "bk_monitor.system.cpu_summary.usage", + "id": 34425, + "functions": [], + "result_table_id": "system.cpu_summary", + "agg_method": "AVG", + "agg_interval": 60, + "agg_dimension": [ + "bk_target_cloud_id", + "bk_target_ip" + ], + "agg_condition": [], + "metric_field": "usage", + "unit": "percent", + "name": "CPU使用率" + } + ], + "algorithms": [ + { + "id": 38108, + "type": "Threshold", + "level": 1, + "config": [ + [ + { + "method": "gte", + "threshold": 0 + } + ] + ], + "unit_prefix": "%" + } + ] + } + ], + "detects": [ + { + "id": 37609, + "level": 1, + "expression": "", + "trigger_config": { + "count": 1, + "check_window": 5 + }, + "recovery_config": { + "check_window": 5, + "status_setter": "recovery" + }, + "connector": "and" + } + ], + "actions": [ + { + "id": 46103, + "config_id": 33375, + "user_groups": [ + 63722 + ], + "signal": [ + "abnormal", + "closed", + "no_data", + "recovered" + ], + "options": { + "converge_config": { + "is_enabled": true, + "converge_func": "skip_when_success", + "timedelta": 60, + "count": 1, + "condition": [ + { + "dimension": "action_info", + "value": [ + "self" + ] + } + ], + "need_biz_converge": true + }, + "start_time": "00:00:00", + "end_time": "23:59:59" + }, + "relate_type": "ACTION", + "config": { + "id": 33375, + "name": "", + "desc": "", + "bk_biz_id": "100147", + "plugin_id": "2", + "execute_config": { + "template_detail": { + "need_poll": true, + "notify_interval": 3600, + "interval_notify_mode": "standard", + "method": "POST", + "url": "", + "headers": [], + "authorize": { + "auth_type": "none", + "auth_config": {} + }, + "body": { + "data_type": "raw", + "params": [], + "content": "{{alarm.callback_message}}", + "content_type": "text" + }, + "query_params": [], + "failed_retry": { + "is_enabled": true, + "timeout": 10, + "max_retry_times": 2, + "retry_interval": 2 + } + }, + "timeout": 600 + } + }, + "user_group_list": [ + { + "id": 63722, + "name": "", + "bk_biz_id": 100147, + "desc": "", + "update_user": "", + "update_time": "2021-11-24 15:52:07+0800", + "create_user": "", + "create_time": "2021-11-24 15:52:07+0800", + "users": [ + { + "id": "", + "display_name": "", + "type": "user" + } + ], + "strategy_count": 5, + "delete_allowed": false, + "edit_allowed": true + } + ] + } + ], + "notice": { + "id": 45035, + "config_id": 32676, + "user_groups": [ + 63722 + ], + "signal": [ + "abnormal", + "no_data" + ], + "options": { + "converge_config": { + "is_enabled": true, + "converge_func": "collect", + "timedelta": 60, + "count": 1, + "condition": [ + { + "dimension": "strategy_id", + "value": [ + "self" + ] + }, + { + "dimension": "dimensions", + "value": [ + "self" + ] + }, + { + "dimension": "alert_level", + "value": [ + "self" + ] + }, + { + "dimension": "signal", + "value": [ + "self" + ] + }, + { + "dimension": "bk_biz_id", + "value": [ + "self" + ] + }, + { + "dimension": "notice_receiver", + "value": [ + "self" + ] + }, + { + "dimension": "notice_way", + "value": [ + "self" + ] + } + ], + "need_biz_converge": true, + "sub_converge_config": { + "timedelta": 60, + "count": 2, + "condition": [ + { + "dimension": "bk_biz_id", + "value": [ + "self" + ] + }, + { + "dimension": "notice_receiver", + "value": [ + "self" + ] + }, + { + "dimension": "notice_way", + "value": [ + "self" + ] + }, + { + "dimension": "alert_level", + "value": [ + "self" + ] + }, + { + "dimension": "signal", + "value": [ + "self" + ] + } + ], + "converge_func": "collect_alarm" + } + }, + "start_time": "00:00:00", + "end_time": "23:59:59" + }, + "relate_type": "NOTICE", + "config": { + "need_poll": true, + "notify_interval": 7200, + "interval_notify_mode": "standard", + "template": [ + { + "signal": "abnormal", + "message_tmpl": "{{content.level}}\n{{content.begin_time}}\n{{content.time}}\n{{content.duration}}\n{{content.target_type}}\n{{content.data_source}}\n{{content.content}}\n{{content.current_value}}\n{{content.biz}}\n{{content.target}}\n{{content.dimension}}\n{{content.detail}}\n{{content.related_info}}", + "title_tmpl": "{{business.bk_biz_name}} - {{alarm.name}}{{alarm.display_type}}" + }, + { + "signal": "recovered", + "message_tmpl": "{{content.level}}\n{{content.begin_time}}\n{{content.time}}\n{{content.duration}}\n{{content.target_type}}\n{{content.data_source}}\n{{content.content}}\n{{content.current_value}}\n{{content.biz}}\n{{content.target}}\n{{content.dimension}}\n{{content.detail}}\n{{content.related_info}}", + "title_tmpl": "{{business.bk_biz_name}} - {{alarm.name}}{{alarm.display_type}}" + }, + { + "signal": "closed", + "message_tmpl": "{{content.level}}\n{{content.begin_time}}\n{{content.time}}\n{{content.duration}}\n{{content.target_type}}\n{{content.data_source}}\n{{content.content}}\n{{content.current_value}}\n{{content.biz}}\n{{content.target}}\n{{content.dimension}}\n{{content.detail}}\n{{content.related_info}}", + "title_tmpl": "{{business.bk_biz_name}} - {{alarm.name}}{{alarm.display_type}}" + } + ] + }, + "user_group_list": [ + { + "id": 63722, + "name": "", + "bk_biz_id": 100147, + "desc": "", + "update_user": "", + "update_time": "2021-11-24 15:52:07+0800", + "create_user": "", + "create_time": "2021-11-24 15:52:07+0800", + "users": [ + { + "id": "", + "display_name": "", + "type": "user" + } + ], + "strategy_count": 5, + "delete_allowed": false, + "edit_allowed": true + } + ] + }, + "is_enabled": false, + "update_time": "2021-12-10 10:15:27+0800", + "update_user": "", + "create_time": "2021-11-07 20:35:32+0800", + "create_user": "", + "labels": [], + "alert_count": 0, + "shield_info": { + "is_shielded": false + }, + "add_allowed": true, + "data_source_type": "监控采集指标" + } + ], + "notice_group_list": [ + { + "notice_group_id": 11, + "notice_group_name": "主备负责人", + "count": 1 + } + ], + "data_source_list": [ + { + "type": "bk_monitor_time_series", + "name": "监控采集指标", + "data_type_label": "time_series", + "data_source_label": "bk_monitor", + "count": 1 + } + ], + "strategy_label_list": [] + } +} +``` diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_alarm_strategy_without_biz.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_alarm_strategy_without_biz.md new file mode 100644 index 000000000..a135c67a5 --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_alarm_strategy_without_biz.md @@ -0,0 +1,1030 @@ +### 功能描述 + +查询告警策略列表 + +### 接口参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段 | 类型 | 必选 | 描述 | +|-------------------|---------|-----|-----------| +| page | int | 否 | 页码，默认1 | +| page_size | int | 否 | 每页条数，默认10 | +| conditions | list | 否 | 查询条件Condition | +| bk_biz_id | int | 否 | 业务ID，不传则查全业务 | +| scenario | char | 否 | 监控场景 | +| with_notice_group | Boolean | 否 | 是否补充通知组信息 | +| with_user_group_detail | Boolean | 否 | 补充通知组详细信息 | + + +#### Condition + +| 字段 | 类型 | 必选 | 描述 | +|-------|--------|------|--------------| +| key | string | 是 | 筛选条件关键字 | +| value | list | 是 | 筛选条件值 | + +#### Condition.key +| 字段 | value类型 | 描述 | +|:------------------------|---------|--------| +| algorithm_type | string | 算法类型 | +| user_group_name | string | 告警组名 | +| user_group_id | int | 告警组id | +| strategy_status | string | 策略状态 | +| data_source_list | string | 数据来源 | +| label_name | string | 标签 | +| bk_cloud_id | int | 云区域ID | +| strategy_id | int | 策略ID | +| strategy_name | string | 策略名 | +| service_category | string | 服务分类 | +| task_id | int | 拨测任务ID | +| time_series_group_id | int | 自定义事件分组ID | +| time_series_group_id | int | 自定义指标分组ID | +| plugin_id | int | 插件ID | +| metric_id | string | 指标ID | +| metric_alias | string | 指标别名 | +| metric_name | string | 指标名 | +| updaters | string | 创建人 | +| updaters | string | 修改人 | +| scenario | string | 监控对象 | +| action_name | string | 套餐名 | +| result_table_id | string | 结果表 | +| invalid_type | string | 失效类型 | + +#### invalid_type选项 + "invalid_metric", + "invalid_target", + "invalid_related_strategy", + "deleted_related_strategy" + +#### algorithm_type选项 + "Threshold", + "SimpleRingRatio", + "AdvancedRingRatio", + "SimpleYearRound", + "AdvancedYearRound", + "PartialNodes", + "OsRestart", + "ProcPort", + "PingUnreachable", + "YearRoundAmplitude", + "YearRoundRange", + "RingRatioAmplitude", + "IntelligentDetect" + +#### strategy_status选项 + "ALERT", + "INVALID", + "OFF", + "ON" + +#### data_source_list选项 + "bk_monitor_time_series", + "log_time_series", + "bk_monitor_event", + "bk_data_time_series", + "custom_event", + "custom_time_series", + "bk_log_search_log", + "bk_monitor_log", + "bk_fta_event", + "bk_fta_alert", + "bk_monitor_alert" + +#### strategy_status选项 + "uptimecheck", + "application_check", + "service_module", + "component", + "host_process", + "os", + "host_device", + "kubernetes", + "hardware_device", + "other_rt" + + +#### 示例数据 + +```json +{ + "type": "monitor", + "page": 1, + "page_size": 10, + "conditions": [ + { + "key": "strategy_status", + "value": [ + "ON" + ] + }, + { + "key": "data_source_list", + "value": [ + "bk_monitor_time_series" + ] + }, + { + "key": "label_name", + "value": [ + "/系统内置/" + ] + }, + { + "key": "bk_cloud_id", + "value": [ + "0" + ] + }, + { + "key": "service_category", + "value": [ + "1" + ] + }, + { + "key": "task_id", + "value": [ + "1" + ] + }, + { + "key": "strategy_id", + "value": [ + "1" + ] + }, + { + "key": "strategy_name", + "value": [ + "1" + ] + }, + { + "key": "bk_event_group_id", + "value": [ + "1" + ] + }, + { + "key": "time_series_group_id", + "value": [ + "1" + ] + }, + { + "key": "plugin_id", + "value": [ + "1" + ] + }, + { + "key": "metric_id", + "value": [ + "1" + ] + }, + { + "key": "metric_alias", + "value": [ + "1" + ] + }, + { + "key": "metric_name", + "value": [ + "1" + ] + }, + { + "key": "creators", + "value": [ + "1" + ] + }, + { + "key": "updaters", + "value": [ + "1" + ] + }, + { + "key": "scenario", + "value": [ + "uptimecheck" + ] + }, + { + "key": "action_name", + "value": [ + "" + ] + }, + { + "key": "result_table_id", + "value": [ + "1" + ] + }, + { + "key": "invalid_type", + "value": [ + "invalid_metric", + "invalid_target", + "invalid_related_strategy", + "deleted_related_strategy" + ] + }, + { + "key": "algorithm_type", + "value": [ + "Threshold", + "SimpleRingRatio", + "AdvancedRingRatio", + "SimpleYearRound", + "AdvancedYearRound", + "PartialNodes", + "OsRestart", + "ProcPort", + "PingUnreachable", + "YearRoundAmplitude", + "YearRoundRange", + "RingRatioAmplitude", + "IntelligentDetect" + ] + } + ], + "order_by": "-update_time", + "with_user_group": true, + "bk_biz_id": 1 +} +``` + +### 响应参数 + +| 字段 | 类型 | 描述 | +|:------------------------|---------|--------| +| list | list | 策略列表(StrategyConfig) | +| total | int | 策略总数 | + +#### StrategyConfig + +| 字段 | 类型 | 描述 | +|:------------------------|---------|--------| +| actions | list | 处理套餐列表(ActionRelation) | +| notice | object | 通知套餐列表(NoticeRelation) | +| source | string | 策略来源 | +| detects | list | 检测配置列表(Detect) | +| id | int | 策略ID | +| items | list | 监控项表(Item) | +| labels | list | 策略标签列表 | +| name | string | 策略名称 | +| scenario | string | 监控对象 | +| is_enabled | Boolean | 是否开启 | +| update_time | string | 创建策略时间 | +| create_time | string | 创建策略时间 | +| update_user | string | 创建策略者 | +| create_user | string | 创建策略者 | +| alert_count | int | 告警次数 | +| type | string | 策略类型 | +| shield_info | dict | 屏蔽配置信息 | +| shield_info.is_shielded | Boolean | 是否屏蔽 | +| add_allowed | Boolean | 允许添加 | +| data_source_type | string | 数据源类型 | +| bk_biz_id | int | 业务ID | + +#### ActionRelation + +| 字段 | 类型 | 必选 | 描述 | +|-----------------------------------|--------|-----|--------------| +| config_id | int | 否 | 套餐ID | +| user_groups | list | 否 | 通知组ID列表 | +| signal | list | 是 | 处理信号，允许为空, ACTION_SIGNAL多选 | +| options | string | 是 | 处理套餐配置 | +| options.converge_config | object | 是 | 收敛配置 | + + +#### NoticeRelation + +| 字段 | 类型 | 必选 | 描述 | +|-----------------------------------|--------|-----|--------------| +| options | dict | 是 | 通知套餐配置 | +| options.converge_config | string | 是 | 收敛配置 | +| options.start_time | string | 是 | 生效开始时间（格式：00:00:00） | +| options.end_time | string | 是 | 生效结束时间（格式：23:59:59) | +| config | string | 是 | | +| config.template | list | 是 | 通知模板配置 | +| config.template.signal | string | 是 | 触发信号，NOTICE_SIGNAL单选 | +| config.template.message_tmpl | string | 否 | 通知信息模板 | +| config.template.title_tmpl | string | 否 | 通知标题模板 | + +#### ConvergeConfig + +| 字段 | 类型 | 必选 | 描述 | +|-----------------------------------|--------|-----|--------------| +| need_biz_converge | boolean | 否 | 是否需要业务汇总 | + + +#### 相关选项 +##### NOTICE_SIGNAL +| 字段 | 标签 | +|-----------------------------------|--------| +|MANUAL|手动| +|ABNORMAL|告警触发时| +|RECOVERED|告警恢复时| +|CLOSED|告警关闭时| +|NO_DATA|无数据时| +|COLLECT|汇总| +|EXECUTE|执行动作时| +|EXECUTE_SUCCESS|执行成功时| +|EXECUTE_FAILED|执行失败时| +|DEMO|调试| + +##### ACTION_SIGNAL +| 字段 | 标签 | +|-----------------------------------|--------| +|ABNORMAL|告警触发时| +|RECOVERED|告警恢复时| +|CLOSED|告警关闭时| +|NO_DATA|无数据时| +|COLLECT|汇总| +|EXECUTE|执行动作时| +|EXECUTE_SUCCESS|执行成功时| +|EXECUTE_FAILED|执行失败时| + +##### CONVERGE_FUNCTION +| 字段 | 标签 | +|-----------------------------------|--------| + |SKIP_WHEN_SUCCESS|成功后跳过| + |SKIP_WHEN_PROCEED|执行中跳过| + |WAIT_WHEN_PROCEED|执行中等待| + |SKIP_WHEN_EXCEED|超出后忽略| + |DEFENSE|异常防御审批| + |COLLECT|超出后汇总| + |COLLECT_ALARM|汇总通知| + + +#### Detect + +| 字段 | 类型 | 必选 | 描述 | +|------------------------------|--------|-----|----------| +| id | int | 是 | 检测id | +| level | int | 是 | 告警级别 | +| expression | string | 是 | 计算公式 | +| trigger_config | dict | 是 | 触发条件配置 | +| trigger_config.count | int | 是 | 触发次数 | +| trigger_config.check_window | int | 是 | 触发周期 | +| recovery_config | dict | 是 | 恢复条件配置 | +| recovery_config.check_window | int | 是 | 恢复周期 | +| connector | string | 是 | 同级别算法连接符 | + +#### Item + +| 字段 | 类型 | 必选 | 描述 | +|---------------------------|--------|-----|---------------------| +| query_configs | list | 是 | 指标查询配置(QueryConfig) | +| id | string | 是 | 监控项配置id | +| name | string | 是 | 监控项名称 | +| expression | string | 是 | 计算公式 | +| origin_sql | string | 是 | 源sql | +| algorithms | list | 是 | 算法配置列表(Algorithm) | +| no_data_config | dict | 是 | 无数据配置 | +| no_data_config.is_enabled | bool | 是 | 是否开启无数据告警 | +| no_data_config.continuous | int | 否 | 无数据告警检测周期数 | +| target | list | 是 | 监控目标 | + +#### Target + +| 字段 | 类型 | 必选 | 描述 | +|--------|--------|-----|---------| +| field | string | 是 | 监控目标类型 | +| value | dict | 是 | 监控目标数据项 | +| method | string | 是 | 监控目标方法 | + +```json +{ + "target": [ + [ + { + "field": "host_topo_node", + "method": "eq", + "value": [ + { + "bk_inst_id": 7, + "bk_obj_id": "biz" + } + ] + } + ] + ] +} +``` + +#### QueryConfig + +| 字段 | 类型 | 必选 | 描述 | +|-------------------|--------|-----|--------| +| alias | string | 是 | 别名 | +| data_source_label | string | 是 | 数据源标签 | +| data_type_label | string | 是 | 数据类型标签 | + +##### BkMonitorTimeSeries类型 + +```json +{ + "data_source_label": "bk_monitor", + "data_type_label": "time_series" +} +``` + +| 字段 | 类型 | 必选 | 描述 | +|-----------------|--------|-----|-------| +| metric_field | string | 是 | 指标 | +| unit | string | 是 | 单位 | +| agg_condition | list | 是 | 查询条件 | +| agg_dimension | list | 是 | 聚合维度 | +| agg_method | string | 是 | 聚合方法 | +| agg_interval | int | 是 | 聚合周期 | +| result_table_id | string | 是 | 结果表ID | + +##### BkMonitorLog类型 + +```json +{ + "data_source_label": "bk_monitor", + "data_type_label": "log" +} +``` + +| 字段 | 类型 | 必选 | 描述 | +|-----------------|--------|-----|------| +| agg_method | string | 是 | 聚合方法 | +| agg_condition | list | 是 | 查询条件 | +| result_table_id | string | 是 | 结果表 | +| agg_interval | int | 是 | 聚合周期 | + +##### BkMonitorEvent类型 + +```json +{ + "data_source_label": "bk_monitor", + "data_type_label": "event" +} +``` + +| 字段 | 类型 | 必选 | 描述 | +|-----------------|--------|-----|------| +| metric_field | string | 是 | 指标 | +| agg_condition | list | 是 | 查询条件 | +| result_table_id | string | 是 | 结果表 | + +##### BkLogSearchTimeSeries类型 + +```json +{ + "data_source_label": "bk_log_search", + "data_type_label": "time_series" +} +``` + +| 字段 | 类型 | 必选 | 描述 | +|-----------------|--------|-----|-------| +| metric_field | string | 是 | 指标 | +| index_set_id | int | 是 | 索引集ID | +| agg_condition | list | 是 | 查询条件 | +| agg_dimension | list | 是 | 聚合维度 | +| agg_method | string | 是 | 聚合方法 | +| result_table_id | string | 是 | 索引 | +| agg_interval | int | 是 | 聚合周期 | +| time_field | string | 是 | 时间字段 | +| unit | string | 是 | 单位 | + +##### BkLogSearchLog类型 + +```json +{ + "data_source_label": "bk_log_search", + "data_type_label": "log" +} +``` + +| 字段 | 类型 | 必选 | 描述 | +|-----------------|--------|-----|-------| +| index_set_id | int | 是 | 索引集ID | +| agg_condition | list | 是 | 查询条件 | +| query_string | int | 是 | 查询语句 | +| agg_dimension | list | 是 | 聚合维度 | +| result_table_id | string | 是 | 索引 | +| agg_interval | int | 是 | 聚合周期 | +| time_field | string | 是 | 时间字段 | + +##### CustomEvent类型 + +```json +{ + "data_source_label": "custom", + "data_type_label": "event" +} +``` + +| 字段 | 类型 | 必选 | 描述 | +|-------------------|--------|-----|---------| +| custom_event_name | string | 是 | 自定义事件名称 | +| agg_condition | list | 是 | 查询条件 | +| agg_interval | int | 是 | 聚合周期 | +| agg_dimension | list | 是 | 查询维度 | +| agg_method | string | 是 | 聚合方法 | +| result_table_id | string | 是 | 结果表ID | + +##### CustomTimeSeries类型 + +```json +{ + "data_source_label": "custom", + "data_type_label": "time_series" +} +``` + | 字段 | 类型 | 必选 | 描述 | +|-----------------|--------|-----|-------| +| metric_field | string | 是 | 指标 | +| unit | string | 是 | 单位 | +| agg_condition | list | 是 | 查询条件 | +| agg_dimension | list | 是 | 聚合维度 | +| agg_method | string | 是 | 聚合方法 | +| agg_interval | int | 是 | 聚合周期 | +| result_table_id | string | 是 | 结果表ID | + +##### BkDataTimeSeries类型 + +```json +{ + "data_source_label": "bk_data", + "data_type_label": "time_series" +} +``` + +| 字段 | 类型 | 必选 | 描述 | +|-----------------|--------|-----|------| +| metric_field | string | 是 | 指标 | +| unit | string | 是 | 单位 | +| agg_condition | list | 是 | 查询条件 | +| agg_dimension | list | 是 | 聚合维度 | +| agg_method | string | 是 | 聚合方法 | +| agg_interval | int | 是 | 聚合周期 | +| result_table_id | string | 是 | 结果表 | +| time_field | string | 是 | 时间字段 | + + + +#### Algorithm + +| 字段 | 类型 | 必选 | 描述 | +|-------------|--------|-----|--------| +| config | list | 是 | 算法配置列表 | +| level | int | 是 | 告警级别 | +| type | string | 是 | 算法类型 | +| unit_prefix | string | 否 | 算法单位前缀 | + +#### 算法配置config + +##### 静态阈值Threshold + +```json +[ + { + "method": "gt", // gt,gte,lt,lte,eq,neq + "threshold": "1" + } +] +``` + +##### 简单环比SimpleRingRatio + +```json +{ + "floor": "1", + "ceil": "1" +} +``` + +##### 简单同比SimpleYearRound + +```json +{ + "floor": "1", + "ceil": "1" +} +``` + +##### 高级环比AdvancedRingRatio + +```json +{ + "floor": "1", + "ceil": "1", + "floor_interval": 1, + "ceil_interval": 1 +} +``` + +##### 高级同比AdvancedYearRound + +与高级环比检测算法配置格式一致 + +##### 智能异常检测IntelligentDetect + +```json +{ + "sensitivity_value": 1 // 0-100 + "anomaly_detect_direct": "ceil" // "ceil", "floor", "all"(default) +} +``` + +##### 同比振幅YearRoundAmplitude + +```json +{ + "ratio": 1, + "shock": 1, + "days": 1, + "method": "gte" // gt,gte,lt,lte,eq,neq +} +``` + +##### 同比区间YearRoundRange + +与同比振幅配置格式一致 + +##### 环比振幅RingRatioAmplitude + +```json +{ + "ratio": 1, + "shock": 1, + "days": 1, + "threshold": 1 +} +``` + + +#### 示例数据 + +```json +{ + "result": true, + "code": 200, + "message": "OK", + "data": { + "list": [ + { + "id": 38297, + "version": "v2", + "bk_biz_id": 1, + "name": "测试", + "source": "bkmonitorv3", + "scenario": "os", + "type": "monitor", + "items": [ + { + "id": 40972, + "name": "AVG(CPU使用率)", + "no_data_config": { + "level": 2, + "continuous": 10, + "is_enabled": false, + "agg_dimension": [ + "bk_target_ip", + "bk_target_cloud_id" + ] + }, + "target": [ + [ + { + "field": "host_topo_node", + "value": [ + { + "bk_obj_id": "set", + "bk_inst_id": 68255 + } + ], + "method": "eq" + } + ] + ], + "expression": "a", + "origin_sql": "", + "query_configs": [ + { + "data_source_label": "bk_monitor", + "data_type_label": "time_series", + "alias": "a", + "metric_id": "bk_monitor.system.cpu_summary.usage", + "id": 34425, + "functions": [], + "result_table_id": "system.cpu_summary", + "agg_method": "AVG", + "agg_interval": 60, + "agg_dimension": [ + "bk_target_cloud_id", + "bk_target_ip" + ], + "agg_condition": [], + "metric_field": "usage", + "unit": "percent", + "name": "CPU使用率" + } + ], + "algorithms": [ + { + "id": 38108, + "type": "Threshold", + "level": 1, + "config": [ + [ + { + "method": "gte", + "threshold": 0 + } + ] + ], + "unit_prefix": "%" + } + ] + } + ], + "detects": [ + { + "id": 37609, + "level": 1, + "expression": "", + "trigger_config": { + "count": 1, + "check_window": 5 + }, + "recovery_config": { + "check_window": 5, + "status_setter": "recovery" + }, + "connector": "and" + } + ], + "actions": [ + { + "id": 46103, + "config_id": 33375, + "user_groups": [ + 63722 + ], + "signal": [ + "abnormal", + "closed", + "no_data", + "recovered" + ], + "options": { + "converge_config": { + "is_enabled": true, + "converge_func": "skip_when_success", + "timedelta": 60, + "count": 1, + "condition": [ + { + "dimension": "action_info", + "value": [ + "self" + ] + } + ], + "need_biz_converge": true + }, + "start_time": "00:00:00", + "end_time": "23:59:59" + }, + "relate_type": "ACTION", + "config": { + "id": 33375, + "name": "", + "desc": "", + "bk_biz_id": "100147", + "plugin_id": "2", + "execute_config": { + "template_detail": { + "need_poll": true, + "notify_interval": 3600, + "interval_notify_mode": "standard", + "method": "POST", + "url": "", + "headers": [], + "authorize": { + "auth_type": "none", + "auth_config": {} + }, + "body": { + "data_type": "raw", + "params": [], + "content": "{{alarm.callback_message}}", + "content_type": "text" + }, + "query_params": [], + "failed_retry": { + "is_enabled": true, + "timeout": 10, + "max_retry_times": 2, + "retry_interval": 2 + } + }, + "timeout": 600 + } + }, + "user_group_list": [ + { + "id": 63722, + "name": "", + "bk_biz_id": 100147, + "desc": "", + "update_user": "", + "update_time": "2021-11-24 15:52:07+0800", + "create_user": "", + "create_time": "2021-11-24 15:52:07+0800", + "users": [ + { + "id": "", + "display_name": "", + "type": "user" + } + ], + "strategy_count": 5, + "delete_allowed": false, + "edit_allowed": true + } + ] + } + ], + "notice": { + "id": 45035, + "config_id": 32676, + "user_groups": [ + 63722 + ], + "signal": [ + "abnormal", + "no_data" + ], + "options": { + "converge_config": { + "is_enabled": true, + "converge_func": "collect", + "timedelta": 60, + "count": 1, + "condition": [ + { + "dimension": "strategy_id", + "value": [ + "self" + ] + }, + { + "dimension": "dimensions", + "value": [ + "self" + ] + }, + { + "dimension": "alert_level", + "value": [ + "self" + ] + }, + { + "dimension": "signal", + "value": [ + "self" + ] + }, + { + "dimension": "bk_biz_id", + "value": [ + "self" + ] + }, + { + "dimension": "notice_receiver", + "value": [ + "self" + ] + }, + { + "dimension": "notice_way", + "value": [ + "self" + ] + } + ], + "need_biz_converge": true, + "sub_converge_config": { + "timedelta": 60, + "count": 2, + "condition": [ + { + "dimension": "bk_biz_id", + "value": [ + "self" + ] + }, + { + "dimension": "notice_receiver", + "value": [ + "self" + ] + }, + { + "dimension": "notice_way", + "value": [ + "self" + ] + }, + { + "dimension": "alert_level", + "value": [ + "self" + ] + }, + { + "dimension": "signal", + "value": [ + "self" + ] + } + ], + "converge_func": "collect_alarm" + } + }, + "start_time": "00:00:00", + "end_time": "23:59:59" + }, + "relate_type": "NOTICE", + "config": { + "need_poll": true, + "notify_interval": 7200, + "interval_notify_mode": "standard", + "template": [ + { + "signal": "abnormal", + "message_tmpl": "{{content.level}}\n{{content.begin_time}}\n{{content.time}}\n{{content.duration}}\n{{content.target_type}}\n{{content.data_source}}\n{{content.content}}\n{{content.current_value}}\n{{content.biz}}\n{{content.target}}\n{{content.dimension}}\n{{content.detail}}\n{{content.related_info}}", + "title_tmpl": "{{business.bk_biz_name}} - {{alarm.name}}{{alarm.display_type}}" + }, + { + "signal": "recovered", + "message_tmpl": "{{content.level}}\n{{content.begin_time}}\n{{content.time}}\n{{content.duration}}\n{{content.target_type}}\n{{content.data_source}}\n{{content.content}}\n{{content.current_value}}\n{{content.biz}}\n{{content.target}}\n{{content.dimension}}\n{{content.detail}}\n{{content.related_info}}", + "title_tmpl": "{{business.bk_biz_name}} - {{alarm.name}}{{alarm.display_type}}" + }, + { + "signal": "closed", + "message_tmpl": "{{content.level}}\n{{content.begin_time}}\n{{content.time}}\n{{content.duration}}\n{{content.target_type}}\n{{content.data_source}}\n{{content.content}}\n{{content.current_value}}\n{{content.biz}}\n{{content.target}}\n{{content.dimension}}\n{{content.detail}}\n{{content.related_info}}", + "title_tmpl": "{{business.bk_biz_name}} - {{alarm.name}}{{alarm.display_type}}" + } + ] + }, + "user_group_list": [ + { + "id": 63722, + "name": "", + "bk_biz_id": 100147, + "desc": "", + "update_user": "", + "update_time": "2021-11-24 15:52:07+0800", + "create_user": "", + "create_time": "2021-11-24 15:52:07+0800", + "users": [ + { + "id": "", + "display_name": "", + "type": "user" + } + ], + "strategy_count": 5, + "delete_allowed": false, + "edit_allowed": true + } + ] + }, + "is_enabled": false, + "update_time": "2021-12-10 10:15:27+0800", + "update_user": "", + "create_time": "2021-11-07 20:35:32+0800", + "create_user": "", + "labels": [], + "alert_count": 0, + "shield_info": { + "is_shielded": false + }, + "add_allowed": true, + "data_source_type": "监控采集指标" + } + ], + "total": 5 + } +} +``` diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_alert.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_alert.md new file mode 100644 index 000000000..107becf70 --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_alert.md @@ -0,0 +1,395 @@ +### 功能描述 + +查询告警列表 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段 | 类型 | 必选 | 描述 | +| ------------- | -------------- | ---- | ------------------------------------------------------------ | +| bk_biz_ids | List[int] | 是 | 业务ID列表 | +| status | List[string] | 否 | 状态，可选 `MINE`, `ABNORMAL`, `CLOSED`, `RECOVERED` | +| conditions | List[Condtion] | 否 | 过滤条件 | +| query_string | string | 否 | 查询字符串，语法：https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-query-notes | +| ordering | list[string] | 否 | 排序字段，字段前面加 "-" 代表倒序 | +| start_time | int | 是 | 开始时间 | +| end_time | int | 是 | 结束时间 | +| page | int | 是 | 页数 | +| page_size | int | 是 | 每页条数（最大5000） | +| show_overview | bool | 否 | 是否返回总览统计信息，默认 true | +| show_aggs | bool | 否 | 是否返回聚合统计信息，默认 true | +| show_dsl | Bool | 否 | 是否返回DSL，默认False | + +#### 过滤条件（conditions） + +| 字段 | 类型 | 必须 | 描述 | +| :-------- | :----- | :--- | :----------------------------------------------------------- | +| key | string | 是 | 字段名 | +| value | List | 是 | 可取值的列表。当 `method = eq`，则满足其一即可；当`method = neq`，则全都不满足 | +| method | string | 是 | 匹配方式，可选 `eq`, `neq`，默认 `eq` | +| condition | string | 否 | 可选 `and`, `or` | + +#### 示例数据 + + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx", + "bk_biz_ids": [5000140], + "conditions": [], + "end_time": 1645669385, + "ordering": [], + "page": 1, + "page_size": 10, + "query_string": "", + "show_aggs": true, + "show_overview": false, + "start_time": 1645665785, + "status": [] +} +``` + +### 响应参数 + +| 字段 | 类型 | 描述 | +| ------- | ------ | ------------------ | +| result | bool | 请求是否成功 | +| code | int | 返回的状态码 | +| message | string | 描述信息 | +| data | dict | 相关的告警列表数据 | + +#### data字段说明 + +| 字段 | 类型 | 描述 | +| ------ | ---- | ------------------ | +| alerts | List | 所有的告警列表 | +| total | int | 返回告警列表的条数 | +| aggs | List | 返回的聚合统计信息 | + +#### data.alerts字段说明 + +| 字段 | 类型 | 描述 | +| ---------------------- | ------------ | -------------- | +| id | String | 告警id | +| alert_name | String | 告警名称 | +| assignee | List(string) | 负责人列表 | +| begin_time | Int | 开始时间 | +| bk_biz_id | Int | 业务id | +| bk_biz_name | String | 业务名称 | +| bk_cloud_id | Int | 云区域id | +| bk_service_instance_id | Int | 服务实例ID | +| bk_topo_node | List | 目标节点 | +| category | String | 分类 | +| category_display | String | 分类名称 | +| converge_id | String | 收敛记录ID | +| create_time | Int | 创建时间 | +| data_type | String | 数据类型 | +| dedupe_keys | List | 告警去重字段 | +| dedupe_md5 | String | 告警去重MD5 | +| description | String | 告警内容 | +| dimension_message | String | 维度信息 | +| dimensions | List | 维度 | +| duration | String | 持续时间 | +| end_time | String | 结束时间 | +| event_id | String | 事件ID | +| first_anomaly_time | Int | 首次异常事件 | +| ip | String | 目标ip | +| is_ack | Bool | 是否确认 | +| is_handled | Bool | 是否已处理 | +| is_shielded | Bool | 是否已屏蔽 | +| latest_time | Int | 最新事件时间 | +| metric | List | 指标 | +| metric_display | List | 指标信息 | +| plugin_id | String | 插件ID | +| seq_id | Int | 告警序列ID | +| severity | Int | 级别 | +| shield_id | List（int） | 屏蔽配置ID列表 | +| shield_left_time | String | 屏蔽剩余时间 | +| stage_display | String | 处理阶段 | +| status | String | 状态 | +| strategy_id | Int | 策略ID | +| strategy_name | String | 策略名称 | +| tags | List | 标签 | +| target | String | 告警目标 | +| target_key | String | 告警目标信息 | +| target_type | String | 告警目标类型 | +| update_time | Int | 更新时间 | + +#### data.aggs字段说明（over_view结构与之类似） + +| 字段 | 类型 | 描述 | +| -------- | ----------- | ------------------ | +| id | String | 聚合统计ID | +| name | String | 聚合统计名称 | +| count | Int | 相关数量 | +| children | List（agg） | 该聚合统计可选内容 | + +#### 示例数据 + +```json +{ + "message": "OK", + "code": 200, + "data": { + "alerts": [ + { + "id": "16424876305819837", + "alert_name": "CPU使用率告警", + "status": "ABNORMAL", + "description": "AVG(CPU使用率) >= 0.0%, 当前值4.72973%", + "severity": 3, + "metric": [ + "bk_monitor.system.cpu_summary.usage" + ], + "bk_biz_id": 5000140, + "ip": "10.0.0.1", + "bk_cloud_id": "0", + "bk_service_instance_id": null, + "bk_topo_node": [ + "biz|5000140", + "module|5004200", + "set|5001626", + "module|5004201" + ], + "assignee": [ + "xxxx" + ], + "is_ack": null, + "is_shielded": false, + "shield_left_time": "0s", + "shield_id": [ + 11888 + ], + "is_handled": true, + "strategy_id": 41868, + "create_time": 1642487630, + "update_time": 1645669311, + "begin_time": 1642487460, + "end_time": null, + "latest_time": 1645669200, + "first_anomaly_time": 1642487460, + "target_type": "HOST", + "target": "10.0.0.1|0", + "category": "os", + "tags": [], + "category_display": "主机-操作系统", + "duration": "36d 19h", + "ack_duration": 7882, + "data_type": "time_series", + "converge_id": "16424876305819837", + "event_id": "c9c6e6781f39dc85e0888cf980b3f892.1645669200.41868.44543.3", + "plugin_id": "bkmonitor", + "stage_display": "已处理", + "dimensions": [ + { + "display_value": "10.0.0.1", + "display_key": "目标IP", + "value": "10.0.0.1", + "key": "ip" + }, + { + "display_value": 0, + "display_key": "云区域ID", + "value": 124, + "key": "bk_cloud_id" + } + ], + "seq_id": 5819837, + "dedupe_md5": "xxxxxxx", + "dedupe_keys": [ + "strategy_id", + "target_type", + "target", + "bk_biz_id" + ], + "dimension_message": "目标IP(10.0.0.1) - 云区域ID(0)", + "metric_display": [ + { + "id": "bk_monitor.system.cpu_summary.usage", + "name": "CPU使用率" + } + ], + "target_key": "主机 10.0.0.1", + "strategy_name": "CPU使用率告警", + "bk_biz_name": "demo" + } + ], + "total": 1, + "aggs": [ + { + "id": "severity", + "name": "级别", + "count": 3, + "children": [ + { + "id": 1, + "name": "致命", + "count": 0 + }, + { + "id": 2, + "name": "预警", + "count": 0 + }, + { + "id": 3, + "name": "提醒", + "count": 3 + } + ] + }, + { + "id": "stage", + "name": "处理阶段", + "count": 3, + "children": [ + { + "id": "is_handled", + "name": "已处理", + "count": 1 + }, + { + "id": "is_ack", + "name": "已确认", + "count": 2 + }, + { + "id": "is_shielded", + "name": "已屏蔽", + "count": 0 + } + ] + }, + { + "id": "data_type", + "name": "数据类型", + "count": 3, + "children": [ + { + "id": "time_series", + "name": "时序数据", + "count": 3 + }, + { + "id": "event", + "name": "事件", + "count": 0 + }, + { + "id": "log", + "name": "日志", + "count": 0 + } + ] + }, + { + "id": "category", + "name": "分类", + "count": 3, + "children": [ + { + "id": "applications", + "name": "用户体验", + "index": 1, + "children": [ + { + "id": "uptimecheck", + "name": "服务拨测", + "index": 1, + "count": 0 + }, + { + "id": "application_check", + "name": "业务应用", + "index": 2, + "count": 0 + } + ], + "count": 0 + }, + { + "id": "services", + "name": "服务", + "index": 2, + "children": [ + { + "id": "service_module", + "name": "服务模块", + "index": 1, + "count": 0 + }, + { + "id": "component", + "name": "组件", + "index": 2, + "count": 0 + } + ], + "count": 0 + }, + { + "id": "hosts", + "name": "主机", + "index": 3, + "children": [ + { + "id": "host_process", + "name": "进程", + "index": 1, + "count": 0 + }, + { + "id": "os", + "name": "操作系统", + "index": 2, + "count": 3 + }, + { + "id": "host_device", + "name": "主机设备", + "index": 3, + "count": 0 + } + ], + "count": 3 + }, + { + "id": "data_center", + "name": "数据中心", + "index": 4, + "children": [ + { + "id": "hardware_device", + "name": "硬件设备", + "index": 1, + "count": 0 + } + ], + "count": 0 + }, + { + "id": "others", + "name": "其他", + "index": 5, + "children": [ + { + "id": "other_rt", + "name": "其他", + "index": 2, + "count": 0 + } + ], + "count": 0 + } + ] + } + ] + }, + "result": true +} +``` \ No newline at end of file diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_event.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_event.md index 7207990ee..f6def1eb9 100644 --- a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_event.md +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_event.md @@ -227,22 +227,14 @@ conditions用于按事件相关的其他字段过滤事件，由key,value组成 "trigger": { "level": "1", "anomaly_ids": [ - "d751713988987e9331980363e24189ce.1574439660.88.118.1", - "d751713988987e9331980363e24189ce.1574439720.88.118.1", - "d751713988987e9331980363e24189ce.1574439780.88.118.1", - "d751713988987e9331980363e24189ce.1574439840.88.118.1", - "d751713988987e9331980363e24189ce.1574439900.88.118.1", - "d751713988987e9331980363e24189ce.1574439960.88.118.1", - "d751713988987e9331980363e24189ce.1574440020.88.118.1", - "d751713988987e9331980363e24189ce.1574440080.88.118.1", - "d751713988987e9331980363e24189ce.1574440140.88.118.1" + "d751713988987e9331980363e24189ce.1574439660.0.0.0" ] }, "anomaly": { "1": { "anomaly_message": "count >= 1.0, 当前值10.0", "anomaly_time": "2019-11-22 16:31:06", - "anomaly_id": "d751713988987e9331980363e24189ce.1574439900.88.118.1" + "anomaly_id": "d751713988987e9331980363e24189ce.1574439900.0.0.0" } }, "dimension_translation": {}, @@ -252,7 +244,7 @@ conditions用于按事件相关的其他字段过滤事件，由key,value组成 "strategy_id": 88, "id": 1364253, "is_shielded": false, - "event_id": "d751713988987e9331980363e24189ce.1574439660.88.118.1", + "event_id": "d751713988987e9331980363e24189ce.1574439660.0.0.0", "create_time": "2019-11-22 16:31:07", "end_time": null, "begin_time": "2019-11-22 16:25:00", diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/update_partial_strategy_v3.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/update_partial_strategy_v3.md new file mode 100644 index 000000000..9cf671010 --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/update_partial_strategy_v3.md @@ -0,0 +1,134 @@ +### 功能描述 + +批量更新策略局部配置 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 +| 字段 | 类型 | 必选 | 描述 | +|:----------|------|-----|--------| +| edit_data | dict | 是 | 待修改数据 | +| ids | int | 是 | 策略ID列表 | +| bk_biz_id | int | 是 | 业务ID | + +####edit_data +| 字段 | 类型 | 描述 | +|:--------------------|---------|-------| +| is_enabled | boolean | 启用状态 | +| notice_group_list | list | 告警组配置 | +| labels | list | 策略标签 | +| trigger_config | dict | 触发条件 | +| recovery_config | dict | 恢复条件 | +| alarm_interval | int | 通知间隔 | +| send_recovery_alarm | bool | 恢复通知 | +| message_template | string | 通知模板 | +| no_data_config | dict | 无数据配置 | +| target | list | 监控目标 | +| actions | list | 处理套餐(ActionRelation) | +| notice | object | 通知套餐(NoticeRelation) | + +#### ActionRelation + +| 字段 | 类型 | 必选 | 描述 | +|-----------------------------------|--------|-----|--------------| +| config_id | int | 否 | 套餐ID | +| user_groups | list | 否 | 通知组ID列表 | +| signal | list | 是 | 处理信号，允许为空, ACTION_SIGNAL多选 | +| options | string | 是 | 处理套餐配置 | +| options.converge_config | object | 是 | 收敛配置 | + + +#### NoticeRelation + +| 字段 | 类型 | 必选 | 描述 | +|-----------------------------------|--------|-----|--------------| +| options | dict | 是 | 通知套餐配置 | +| options.converge_config | string | 是 | 收敛配置 | +| options.start_time | string | 是 | 生效开始时间（格式：00:00:00） | +| options.end_time | string | 是 | 生效结束时间（格式：23:59:59) | +| config | string | 是 | | +| config.template | list | 是 | 通知模板配置 | +| config.template.signal | string | 是 | 触发信号，NOTICE_SIGNAL单选 | +| config.template.message_tmpl | string | 否 | 通知信息模板 | +| config.template.title_tmpl | string | 否 | 通知标题模板 | + +#### ConvergeConfig + +| 字段 | 类型 | 必选 | 描述 | +|-----------------------------------|--------|-----|--------------| +| need_biz_converge | boolean | 否 | 是否需要业务汇总 | + + +#### 相关选项 +##### NOTICE_SIGNAL +| 字段 | 标签 | +|-----------------------------------|--------| +|MANUAL|手动| +|ABNORMAL|告警触发时| +|RECOVERED|告警恢复时| +|CLOSED|告警关闭时| +|NO_DATA|无数据时| +|COLLECT|汇总| +|EXECUTE|执行动作时| +|EXECUTE_SUCCESS|执行成功时| +|EXECUTE_FAILED|执行失败时| +|DEMO|调试| + +##### ACTION_SIGNAL +| 字段 | 标签 | +|-----------------------------------|--------| +|ABNORMAL|告警触发时| +|RECOVERED|告警恢复时| +|CLOSED|告警关闭时| +|NO_DATA|无数据时| +|COLLECT|汇总| +|EXECUTE|执行动作时| +|EXECUTE_SUCCESS|执行成功时| +|EXECUTE_FAILED|执行失败时| + +##### CONVERGE_FUNCTION +| 字段 | 标签 | +|-----------------------------------|--------| + |SKIP_WHEN_SUCCESS|成功后跳过| + |SKIP_WHEN_PROCEED|执行中跳过| + |WAIT_WHEN_PROCEED|执行中等待| + |SKIP_WHEN_EXCEED|超出后忽略| + |DEFENSE|异常防御审批| + |COLLECT|超出后汇总| + |COLLECT_ALARM|汇总通知| + + +#### 示例数据 + +```json +{ + "ids": [ + 23121 + ], + "edit_data": { + "notice_group_list": [ + 4644 + ] + }, + "bk_biz_id": 883 +} +``` + +### 响应参数 + +data返回更新成功的策略id表 + +#### 示例数据 + +```json +{ + "result": true, + "code": 200, + "message": "OK", + "data": [ + 23121 + ] +} +``` diff --git a/paas2/esb/components/confapis/monitor_v3/monitor_v3.yaml b/paas2/esb/components/confapis/monitor_v3/monitor_v3.yaml index ff049cb55..07f2fc829 100644 --- a/paas2/esb/components/confapis/monitor_v3/monitor_v3.yaml +++ b/paas2/esb/components/confapis/monitor_v3/monitor_v3.yaml @@ -1757,6 +1757,7 @@ label_en: delete apm app config name: delete_apm_app_config path: /v2/monitor_v3/delete_apm_delete_app_config/ + method: POST - api_type: operate comp_codename: generic.v2.monitor_v3.monitor_v3_component @@ -1768,3 +1769,14 @@ name: get_action_params_by_config path: /v2/monitor_v3/get_action_params_by_config/ method: POST + +- api_type: operate + comp_codename: generic.v2.monitor_v3.monitor_v3_component + dest_http_method: GET + dest_path: /api/v4/bcs/get_bcs_gray_cluster_list/ + is_hidden: true + label: 获取BCS集群灰度ID名单 + label_en: null + name: get_bcs_gray_cluster_list + path: /v2/monitor_v3/get_bcs_gray_cluster_list/ + method: GET diff --git a/paas2/release.md b/paas2/release.md index 9966140c8..f4f5e21ac 100644 --- a/paas2/release.md +++ b/paas2/release.md @@ -1,5 +1,8 @@ Release Log =============================== +# 2.14.16 + - update: esb update data/monitor_v3 confapis + # 2.14.15 - update: esb cc set default bk_supplier_account for component dest_path - update: esb gse compatible with gse 2.0 interface protocol