diff --git a/paas2/VERSION b/paas2/VERSION index 023f329b4..2663e5e96 100644 --- a/paas2/VERSION +++ b/paas2/VERSION @@ -1 +1 @@ -2.14.62 +2.14.63 diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/preview_duty_rule.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/preview_duty_rule.md new file mode 100644 index 000000000..e46158aab --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/preview_duty_rule.md @@ -0,0 +1,118 @@ +### 功能描述 + +保存轮值规则 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段 | 类型 | 必须 | 描述 | +|----------------|--------|------|---------------------------------| +| id | int | 否 | 轮值规则ID（source_type为DB的时候必填） | +| bk_biz_id | int | 是 | 业务ID | +| begin_time | string | 是 | 预览生效开始时间（日期时间格式） | +| days | int | 否 | 默认生效时间开始30天 | +| source_type | string | 否 | 数据来源类型 `API（接口参数）` `DB（DB存储内容）` | +| config | dict | 否 | 数据来源类型为API的时候必填，格式参考保存轮值规则 | + + +#### DB数据预览示例数据 + +```json +{ + "source_type": "DB", + "id": 2, + "begin_time": "2023-12-01 00:00:00", + "days": 7, + "bk_biz_id": 2 +} +``` + +# 通过API获取 +```json +{ + "source_type": "API", + "id": 2, + "begin_time": "2023-12-01 00:00:00", + "days": 7, + "bk_biz_id": 2, + "config": { + "name": "handoff duty", + "bk_biz_id": 2, + "effective_time": "2023-07-25 11:00:00", + "end_time": "", + "labels": ["mysql", "redis", "business"], + "enabled": true, + "category": "handoff", + "duty_arranges": [ + { + "duty_time": [{"work_type": "daily", + "work_days": [], + "work_time_type": "time_range", + "work_time": ["00:00--23:59"], + "period_settings": { + "window_unit": "day", + "duration": 2 + } + }], + "duty_users": [ + [ + { + "id": "admin", + "type": "user" + }, + { + "id": "admin1", + "type": "user" + }, + { + "id": "admin2", + "type": "user" + }, { + "id": "admin3", + "type": "user" + }, { + "id": "admin4", + "type": "user" + }, { + "id": "admin5", + "type": "user" + } + ] + ], + "group_type": "auto", + "group_number": 2, + "backups": [] + } + ] + } +} +``` + +### 响应参数 + +| 字段 | 类型 | 描述 | +|------------|--------------|-----------| +| result | bool | 请求是否成功 | +| code | int | 返回的状态码 | +| message | string | 描述信息 | +| data | list[object] | 预览数据 | +| request_id | str | ESB记录请求ID | + +#### data 格式说明： +| 字段 | 类型 | 描述 | +|-------|------------|--| +| users | list[user] | 值班用户，格式参考用户 | +| work_times | list[work_time] | 值班时间 | + + +#### work_time 格式说明： +| 字段 | 类型 | 描述 | +|-------|------------|--| +| start_time | string | 时间格式 `2023-12-01 00:00`| +| end_time | string | 时间格式 `2023-12-01 23:59`| + + + diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/preview_user_group.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/preview_user_group.md new file mode 100644 index 000000000..6b077cc5f --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/preview_user_group.md @@ -0,0 +1,70 @@ +### 功能描述 + +保存轮值规则 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段 | 类型 | 必须 | 描述 | +|-------------|--------|--|-----------------------------------------------| +| id | int | 否 | 轮值规则ID（source_type为DB的时候必填） | +| bk_biz_id | int | 是 | 业务ID | +| begin_time | string | 是 | 预览生效开始时间（日期时间格式） | +| days | int | 否 | 默认生效时间开始30天 | +| source_type | string | 否 | 数据来源类型 `API（接口参数）` `DB（DB存储内容）` | +| config | dict | 否 | 数据来源类型为API的时候必填，格式为 `{"duty_rules": [1,2,3]}` | + + +#### DB数据预览示例数据 + +```json +{ + "source_type": "DB", + "id": 2, + "begin_time": "2023-12-01 00:00:00", + "days": 7, + "bk_biz_id": 2 +} +``` + +# 通过API获取 +```json +{ + "source_type": "API", + "begin_time": "2023-12-01 00:00:00", + "days": 7, + "bk_biz_id": 2, + "config":{ + "duty_rules": [2, 3] + } +} +``` + +### 响应参数 + +| 字段 | 类型 | 描述 | +|------------|--------------|-----------| +| result | bool | 请求是否成功 | +| code | int | 返回的状态码 | +| message | string | 描述信息 | +| data | list[object] | 预览数据 | +| request_id | str | ESB记录请求ID | + +#### data 格式说明： +| 字段 | 类型 | 描述 | +|-------|------------|--| +| users | list[user] | 值班用户，格式参考用户 | +| work_times | list[work_time] | 值班时间 | + + +#### work_time 格式说明： +| 字段 | 类型 | 描述 | +|-------|------------|--| +| start_time | string | 时间格式 `2023-12-01 00:00`| +| end_time | string | 时间格式 `2023-12-01 23:59`| + + + diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_duty_rule.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_duty_rule.md new file mode 100644 index 000000000..e05907858 --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_duty_rule.md @@ -0,0 +1,199 @@ +### 功能描述 + +保存轮值规则 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段 | 类型 | 必须 | 描述 | +|----------------|-----------|-----|--------------------------------------| +| id | int | 是 | 告警组ID（没有表示新建） | +| bk_biz_id | int | 是 | 业务ID | +| name | string | 是 | 名称 | +| category | string | 是 | 轮值类型 `regular(日常值班)` `handoff(交替轮值)` | +| labels | list[str] | 是 | 规则标签 | +| enabled | bool | 否 | 是否开启，默认为否 | +| duty_arranges | list | 是 | 轮值人员设置 | +| effective_time | string | 是 | 生效时间， 格式 `2022-03-11 00:00:00` | +| end_time | string | 否 | 截止时间， 格式 `2022-03-11 00:00:00` | + +### `duty_arranges` 数据格式 + +| 字段 | 类型 | 必须 | 描述 | +|----------------|------------------|-----|---------------------------------| +| id | int | 否 | 轮值ID，保存时有id表示更新，没有id表示新增 | +| need_rotation | bool | 否 | 是否需要交接班 | +| duty_time | list[object] | 否 | 工作时间配置，默认为每天 24小时工作 | +| group_type | string | 否 | `specified(手动指定)` `auto(自动分配)` | +| group_number | int | 否 | `auto(自动分配)` 情况下每组人数 | +| duty_users | list[list[user]] | 是 | 值班人员组, 当为自动分组的时候，默认取第一组 | + +#### `user` 选项说明 + +| 字段 | 类型 | 必须 | 描述 | +|------|--------|-----|-------------------| +| id | string | 是 | 用户英文名或者角色代号 | +| type | string | 是 | `group` or `user` | + +#### `duty_time` 内元素选项说明 + +| 字段 | 类型 | 必须 | 描述 | +|-----------------|--------------|-----|--------------------------------------------------------------------------------------| +| is_custom | bool | 否 | 是否为自定义类型, 默认为`false` | +| work_type | string | 是 | 轮值类型，默认 `daily`， 可选项 `daily`，`weekly`, `monthly`, `work_day` `weekend` `date_range` | +| work_days | list[int] | 否 | 工作日期， 选项根据`work_type`, 排列在第一位的表示起始日期 | +| work_date_range | list[string] | 否 | 工作日期范围， 选项根据`work_type`, 格式为["2019-10-01--2019-12-31"] | +| work_time_type | string | 否 | 工作时间类型 默认 `time_range` ,可选项`time_range` `datetime_range` | +| work_time | list[string] | 是 | 工作时间段 格式 `time_range`：[`00:00--23:59`] `datetime_range`：[`01 00:00--02 23:59`] | +| period_settings | object | 否 | 自定义周期 {'window_unit': "`day` `hour`", "duration":1} | + +`work_type` 类型对应日期`work_days`选择说明 + +| 轮值类型 | 对应选项说明 | +|---------|------------------------------------------------------| +| daily | 为空，不需要设置 | +| weekly | 1，2，3，4，5，6，7 代表周一 至 周日， 如有全部选项，则设置为 [1,2,3,4,5,6,7] | +| monthly | 1-31号之间选择，如有全部选项，则设置为 [1,2,3,4,5,6,7...31] | + +#### users 格式说明 + +| 字段 | 类型 | 描述 | +|--------------|--------|----------------------| +| id | string | 角色key或者用户ID | +| display_name | string | 显示名 | +| type | string | 类型，可选项`group`，`user` | +| members | list | 对应的人员信息（针对group类型） | + +#### 请求示例数据 + +```json +{ + "name": "name", + "bk_biz_id": 2, + "effective_time": "2023-07-25 11:00:00", + "end_time": "", + "labels": [ + "mysql", + "redis", + "business" + ], + "enabled": true, + "category": "regular", + "duty_arranges": [ + { + "duty_time": [ + { + "work_type": "daily", + "work_days": [], + "work_time": [ + "00:00--23:59" + ] + } + ], + "duty_users": [ + [ + { + "id": "bk_biz_maintainer", + "type": "group", + } + ] + ], + "backups": [] + }, + { + "duty_time": [ + { + "work_type": "weekly", + "work_days": [1,2,3,4,5], + "work_time": [ + "00:00--23:59" + ] + } + ], + "duty_users": [ + [ + { + "id": "admin", + "type": "user", + }, + { + "id": "admin1", + "type": "user", + } + ] + ], + "backups": [] + } + ] +} +``` + +# 周期轮值自定义方案 +```json +{ + "name": "handoff duty", + "bk_biz_id": 2, + "effective_time": "2023-07-25 11:00:00", + "end_time": "", + "labels": ["mysql", "redis", "business"], + "enabled": true, + "category": "handoff", + "duty_arranges": [ + { + "duty_time": [{"work_type": "daily", + "work_days": [], + "work_time_type": "time_range", + "work_time": ["00:00--23:59"], + "period_settings": { + "window_unit": "day", + "duration": 2 + } + }], + "duty_users": [ + [ + { + "id": "admin", + "type": "user" + }, + { + "id": "admin1", + "type": "user" + }, + { + "id": "admin2", + "type": "user" + }, { + "id": "admin3", + "type": "user" + }, { + "id": "admin4", + "type": "user" + }, { + "id": "admin5", + "type": "user" + } + ] + ], + "group_type": "auto", + "group_number": 2, + "backups": [] + } + ] + } + +``` + +### 响应参数 + +| 字段 | 类型 | 描述 | +|------------|--------|-----------| +| result | bool | 请求是否成功 | +| code | int | 返回的状态码 | +| message | string | 描述信息 | +| data | dict | 数据 | +| request_id | str | ESB记录请求ID | + +#### data 格式说明： 参考获取告警组详情接口 diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_user_group.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_user_group.md index 83016e466..a31c47121 100644 --- a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_user_group.md +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_user_group.md @@ -1,109 +1,104 @@ ### 功能描述 -查询告警组 +保存告警组 ### 请求参数 {{ common_args_desc }} - #### 接口参数 -| 字段 | 类型 | 必须 | 描述 | -|------------|--------| ---- |--------------------------------| -| id | int | 是 | 告警组ID（没有表示新建） | -| bk_biz_id | int | 是| 业务ID | -| name | string | 是| 名称 | -| need_duty | bool | 是| 是否轮值 | -| channels | list | 是| 通知渠道 可选项 `user(内部用户)`, `wxwork-bot(企业微信机器人)` | -| desc | string | 是| 说明 | -| alert_notice | list | 是| 告警通知方式 | -| action_notice | list | 是| 告警处理通知配置 | -| duty_arranges | list | 是| 通知接收人员 | +| 字段 | 类型 | 必须 | 描述 | +|---------------|--------------------|-----|----------------------------------------------| +| id | int | 是 | 告警组ID（没有表示新建） | +| bk_biz_id | int | 是 | 业务ID | +| name | string | 是 | 名称 | +| timezone | string | 是 | 时区，默认`utc` | +| need_duty | bool | 是 | 是否轮值 | +| channels | list | 是 | 通知渠道 可选项 `user(内部用户)`, `wxwork-bot(企业微信机器人)` | +| desc | string | 是 | 说明 | +| alert_notice | list | 是 | 告警通知方式 | +| action_notice | list | 是 | 告警处理通知配置 | +| duty_arranges | list[duty_arrange] | 否 | 非轮值情况下通知接收人员 | +| duty_rules | list[int] | 否 | 轮值对应的规则组 need_duty 情况下必填 | +| duty_notice | dict | 否 | 轮值相关的通知设置 | ### `alert_notice` 数据格式 -| 字段 | 类型 | 必须 | 描述 | -|------------|--------| ---- |--------------------------------| -| time_range | string | 是 | 生效时间范围 | -| notify_config | list[alert_notice_config] | 是 | 生效时间范围 | +| 字段 | 类型 | 必须 | 描述 | +|---------------|---------------------------|-----|--------| +| time_range | string | 是 | 生效时间范围 | +| notify_config | list[alert_notice_config] | 是 | 生效时间范围 | ### `action_notice` 数据格式 -| 字段 | 类型 | 必须 | 描述 | -|------------|----------------------------| ---- |--------------------------------| -| time_range | string | 是 | 生效时间范围 | -| notify_config | list[action_notice_config] | 是 | 生效时间范围 | + +| 字段 | 类型 | 必须 | 描述 | +|---------------|----------------------------|-----|--------| +| time_range | string | 是 | 生效时间范围 | +| notify_config | list[action_notice_config] | 是 | 生效时间范围 | ### `alert_notice_config` 数据格式 -| 字段 | 类型 | 必须 | 描述 | -|------------|--------|------|--------------------------------| -| level | int | 是 | 1(致命)，2(预警)，3(提醒) | -| notice_ways | list[notice_way] | 是 | 通知方式 | + +| 字段 | 类型 | 必须 | 描述 | +|-------------|------------------|-----|-------------------| +| level | int | 是 | 1(致命)，2(预警)，3(提醒) | +| notice_ways | list[notice_way] | 是 | 通知方式 | ### `action_notice_config` 数据格式 -| 字段 | 类型 | 必须 | 描述 | -|------------|--------|------|--------------------------------| -| phase | int | 是 | 1(失败时)，2(成功时)，3(执行前) | -| notice_ways | list[notice_way] | 是 | 通知方式 | +| 字段 | 类型 | 必须 | 描述 | +|-------------|------------------|-----|----------------------| +| phase | int | 是 | 1(失败时)，2(成功时)，3(执行前) | +| notice_ways | list[notice_way] | 是 | 通知方式 | ### `notice_way` 数据格式 -| 字段 | 类型 | 必须 | 描述 | +| 字段 | 类型 | 必须 | 描述 | |------------|--------|--|--------------------------------| | name | string | 是 | `weixin（微信）`, `sms(短信)`, `voice(语音通知)`, `wxwork-bot(企业微信机器人)` | | receivers | list[str] | 否 | 通知接收人员：企业微信机器人为chatID， bkchat为对应的选项ID | +### `duty_notice` 数据格式 + +| 字段 | 类型 | 必须 | 描述 | +|-----------------|------|-----|----------| +| plan_notice | dict | 否 | 轮值计划通知配置 | +| personal_notice | dict | 否 | 值班人员通知配置 | + +### `plan_notice` 数据格式 + +| 字段 | 类型 | 必须 | 描述 | +|----------|-----------|-----|---------------------------------| +| enabled | bool | 否 | 是否发送 | +| days | int | 是 | 发送多久以后的 | +| chat_ids | list[str] | 是 | 企业微信ID列表 | +| type | string | 是 | 周期类型，`daily` `weekly` `monthly` | +| date | list[int] | 否 | 发送日期，数字表示， `daily`的情况下可为空 | +| time | string | 是 | 交班时间， 格式 `08:00` | + +### `personal_notice` 数据格式 + +| 字段 | 类型 | 必须 | 描述 | +|------------|-----------|-----|------------| +| enabled | bool | 否 | 是否发送 | +| hours_ago | int | 是 | 单位小时，值班前多久 | +| duty_rules | list[int] | 是 | 指定轮值规则 | ### `duty_arranges` 数据格式 -| 字段 | 类型 | 必须 | 描述 | -|----------------| ---- | ---- |--------------------------------| -| id |int|否| 轮值ID，保存时有id表示更新，没有id表示新增 | -| need_rotation | bool | 否| 是否需要交接班 | -| handoff_time |object|否| `need_rotation` 为`True`，此字段必填 | -| effective_time |string|是| 生效时间， 格式 `2022-03-11 00:00:00` | -| duty_time |list[object]|否| 工作时间配置，默认为每天 24小时工作 | -| duty_users |list[list[user]]|否| 值班人员组 | -| users |list[user]|否| 值班人员兼容老接口，不需要轮值的时候可以保留该字段 | -| duty_plans |list[user]|否| 参考生效参数表，格式可以下参考示例 | - -#### `user` 选项说明 -| 字段 | 类型 | 必须 | 描述 | -| ----- | ---- | ---- | ------------------ | -| id|string|是| 用户英文名或者角色代号 | -| type | string | 是| `group` or `user`| - -#### `handoff_time` 选项说明 -| 字段 | 类型 | 必须 | 描述 | -| ----- | ---- | ---- | ------------------ | -| rotation_type|string|是| 轮值类型，默认 `daily` | -| date | int | 否| 交班日期 | -| time | string | 是| 交班时间， 格式 `08:00` | - -`rotation_type`类型对应日期选择说明 - -| 轮值类型 | 对应选项说明 | -| ----- | ---- | -| daily | 为空，不需要设置 | -| weekly | 1，2，3，4，5，6，7 代表周一 至 周日， 如有全部选项，则设置为 [1,2,3,4,5,6,7]| -| monthly | 1-31号之间选择，如有全部选项，则设置为 [1,2,3,4,5,6,7...31] | - -#### `duty_time` 内元素选项说明 -| 字段 | 类型 | 必须 | 描述 | -| ----- | ---- | ---- | ------------------ | -| work_type|string|是| 轮值类型，默认 `daily`， 可选项 `daily`，`weekly`, `monthly` | -| work_days | list[int] | 否| 工作日期， 选项根据`work_type`,参考rotation_type的对应日期选项说明 | -| work_time | string | 是| 工作时间段 格式 `00:00--23:59` | +| 字段 | 类型 | 必须 | 描述 | +|-------|------------|-----|---------------------------| +| id | int | 否 | 轮值ID，保存时有id表示更新，没有id表示新增 | +| users | list[user] | 否 | 值班人员兼容老接口，不需要轮值的时候可以保留该字段 | #### users 格式说明 -| 字段 | 类型 | 描述 | -|--------------|--------|--------------------| -| id | string | 角色key或者用户ID | -| display_name | string | 显示名 | +| 字段 | 类型 | 描述 | +|--------------|--------|----------------------| +| id | string | 角色key或者用户ID | +| display_name | string | 显示名 | | type | string | 类型，可选项`group`，`user` | -| members | list | 对应的人员信息（针对group类型） | +| members | list | 对应的人员信息（针对group类型） | #### 请求示例数据 @@ -233,13 +228,13 @@ ### 响应参数 -| 字段 | 类型 | 描述 | -| ------- | ------ | ------------ | -| result | bool | 请求是否成功 | -| code | int | 返回的状态码 | -| message | string | 描述信息 | -| data | dict | 数据 | -| request_id | str | ESB记录请求ID | +| 字段 | 类型 | 描述 | +|------------|--------|-----------| +| result | bool | 请求是否成功 | +| code | int | 返回的状态码 | +| message | string | 描述信息 | +| data | dict | 数据 | +| request_id | str | ESB记录请求ID | #### data 格式说明： 参考获取告警组详情接口 diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_duty_rule_detail.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_duty_rule_detail.md new file mode 100644 index 000000000..c77a2f7e2 --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_duty_rule_detail.md @@ -0,0 +1,272 @@ +### 功能描述 + +查询告警组 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段 | 类型 | 必选 | 描述 | +|-----|------|-----|-------| +| id | list | 否 | 通知组ID | + +#### 示例数据 + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx", + "id": 77 +} +``` + +### 响应参数 + +| 字段 | 类型 | 描述 | +|------------|--------|-----------| +| result | bool | 请求是否成功 | +| code | int | 返回的状态码 | +| message | string | 描述信息 | +| data | dict | 数据 | +| request_id | str | ESB记录请求ID | + +#### data字段说明 + +| 字段 | 类型 | 描述 | +|----------------|--------|----------------------------------------------| +| bk_biz_id | int | 业务ID | +| name | string | 名称 | +| need_duty | bool | 是否轮值 | +| channels | list | 通知渠道 可选项 `user(内部用户)`, `wxwork-bot(企业微信机器人)` | +| id | int | 告警组ID | +| desc | string | 说明 | +| duty_arranges | list | 通知接收人员 | +| delete_allowed | bool | 是否可删除 | +| edit_allowed | bool | 是否可编辑 | +| update_time | string | 更新时间 | +| update_user | string | 更新人 | +| create_time | string | 创建时间 | +| create_user | string | 创建人 | + +### `duty_arranges` 数据格式 + +| 字段 | 类型 | 必须 | 描述 | +|----------------|------------------|-----|--------------------------------| +| id | int | 否 | 轮值ID，保存时有id表示更新，没有id表示新增 | +| need_rotation | bool | 否 | 是否需要交接班 | +| handoff_time | object | 否 | `need_rotation` 为`True`，此字段必填 | +| effective_time | string | 是 | 生效时间， 格式 `2022-03-11 00:00:00` | +| duty_time | list[object] | 否 | 工作时间配置，默认为每天 24小时工作 | +| duty_users | list[list[user]] | 否 | 值班人员组 | +| users | list[user] | 否 | 值班人员兼容老接口，不需要轮值的时候可以保留该字段 | +| duty_plans | list[user] | 否 | 参考生效参数表，格式可以下参考示例 | + +#### `user` 选项说明 + +| 字段 | 类型 | 必须 | 描述 | +|------|--------|-----|-------------------| +| id | string | 是 | 用户英文名或者角色代号 | +| type | string | 是 | `group` or `user` | + +#### `handoff_time` 选项说明 + +| 字段 | 类型 | 必须 | 描述 | +|---------------|--------|-----|------------------| +| rotation_type | string | 是 | 轮值类型，默认 `daily` | +| date | int | 否 | 交班日期 | +| time | string | 是 | 交班时间， 格式 `08:00` | + +`rotation_type`类型对应日期选择说明 + +| 轮值类型 | 对应选项说明 | +|---------|------------------------------------------------------| +| daily | 为空，不需要设置 | +| weekly | 1，2，3，4，5，6，7 代表周一 至 周日， 如有全部选项，则设置为 [1,2,3,4,5,6,7] | +| monthly | 1-31号之间选择，如有全部选项，则设置为 [1,2,3,4,5,6,7...31] | + +#### `duty_time` 内元素选项说明 + +| 字段 | 类型 | 必须 | 描述 | +|-----------|-----------|-----|--------------------------------------------------| +| work_type | string | 是 | 轮值类型，默认 `daily`， 可选项 `daily`，`weekly`, `monthly` | +| work_days | list[int] | 否 | 工作日期， 选项根据`work_type`,参考rotation_type的对应日期选项说明 | +| work_time | string | 是 | 工作时间段 格式 `00:00--23:59` | + +#### users 格式说明 + +| 字段 | 类型 | 描述 | +|--------------|--------|----------------------| +| id | string | 角色key或者用户ID | +| display_name | string | 显示名 | +| type | string | 类型，可选项`group`，`user` | +| members | list | 对应的人员信息（针对group类型） | + +#### 示例数据 + +```json +{ + "result": true, + "code": 200, + "message": "OK", + "data": { + "id": 69, + "name": "lunzhi", + "bk_biz_id": 2, + "desc": "", + "update_user": "admin", + "update_time": "2023-07-25 11:48:19+0800", + "create_user": "admin", + "create_time": "2023-07-25 11:48:19+0800", + "duty_arranges": [ + { + "id": 90, + "user_group_id": 69, + "need_rotation": false, + "duty_time": [ + { + "work_type": "daily", + "work_days": [], + "work_time": "00:00--23:59" + } + ], + "effective_time": "2023-07-25T11:48:00+08:00", + "handoff_time": { + "date": 1, + "time": "00:00", + "rotation_type": "daily" + }, + "duty_users": [ + [ + { + "id": "bk_biz_maintainer", + "display_name": "运维人员", + "logo": "", + "type": "group", + "members": [] + } + ] + ], + "backups": [], + "order": 1 + } + ], + "alert_notice": [ + { + "time_range": "00:00:00--23:59:00", + "notify_config": [ + { + "type": [], + "notice_ways": [ + { + "name": "weixin", + "receivers": [] + } + ], + "level": 3 + }, + { + "type": [], + "notice_ways": [ + { + "name": "weixin", + "receivers": [] + } + ], + "level": 2 + }, + { + "type": [], + "notice_ways": [ + { + "name": "weixin", + "receivers": [] + } + ], + "level": 1 + } + ] + } + ], + "action_notice": [ + { + "time_range": "00:00:00--23:59:00", + "notify_config": [ + { + "type": [], + "notice_ways": [ + { + "name": "weixin", + "receivers": [] + } + ], + "phase": 3 + }, + { + "type": [], + "notice_ways": [ + { + "name": "weixin", + "receivers": [] + } + ], + "phase": 2 + }, + { + "type": [], + "notice_ways": [ + { + "name": "weixin", + "receivers": [] + } + ], + "phase": 1 + } + ] + } + ], + "need_duty": true, + "path": "", + "channels": [ + "user", + "wxwork-bot" + ], + "users": [], + "strategy_count": 1, + "delete_allowed": false, + "edit_allowed": true, + "config_source": "UI", + "duty_plans": [ + { + "id": 1, + "user_group_id": 69, + "duty_arrange_id": 90, + "duty_time": [ + { + "work_days": [], + "work_time": "00:00--23:59", + "work_type": "daily" + } + ], + "begin_time": "2023-07-25 11:49:00+0800", + "end_time": null, + "users": [ + { + "id": "bk_biz_maintainer", + "display_name": "运维人员", + "logo": "", + "type": "group", + "members": [] + } + ], + "order": 1, + "is_active": true + } + ], + "rule_count": 0 + }, + "request_id": "496391f5c8a247709dc5a7184ddf9ab5" +} +``` diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_duty_rules.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_duty_rules.md new file mode 100644 index 000000000..a662b9716 --- /dev/null +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_duty_rules.md @@ -0,0 +1,82 @@ +### 功能描述 + +查询轮值规则列表 + +### 请求参数 + +{{ common_args_desc }} + +#### 接口参数 + +| 字段 | 类型 | 必选 | 描述 | +|------------|------|-----|--------| +| bk_biz_ids | list | 否 | 业务ID | +| ids | list | 否 | 轮值规则ID | + +#### 示例数据 + +```json +{ + "bk_app_code": "xxx", + "bk_app_secret": "xxxxx", + "bk_token": "xxxx", + "bk_biz_ids": [ + 2 + ], + "ids": [1], + "page_size":10 +} +``` + +### 响应参数 + +| 字段 | 类型 | 描述 | +|------------|--------------|-----------| +| result | bool | 请求是否成功 | +| code | int | 返回的状态码 | +| message | string | 描述信息 | +| data | list[object] | 数据 | +| request_id | str | ESB记录请求ID | + +#### data字段元素说明 + +| 字段 | 类型 | 必须 | 描述 | +|----------------|-----------|-----|--------------------------------------| +| id | int | 是 | 告警组ID（没有表示新建） | +| bk_biz_id | int | 是 | 业务ID | +| name | string | 是 | 名称 | +| enabled | bool | 是 | 是否开启 | +| category | string | 是 | 轮值类型 `regular(日常值班)` `handoff(交替轮值)` | +| labels | list[str] | 是 | 规则标签 | +| effective_time | string | 是 | 生效时间， 格式 `2022-03-11 00:00:00` | +| end_time | string | 否 | 截止时间， 格式 `2022-03-11 00:00:00` | +| delete_allowed | bool | 是 | 是否可删除 | +| edit_allowed | bool | 是 | 是否可编辑 | + + + +#### 示例数据 + +```json +{ + "result": true, + "code": 200, + "message": "OK", + "data": [ + { + "id": 62, + "name": "企业微信机器人1234", + "bk_biz_id": 2, + "enabled": true, + "labels": ["123"], + "update_user": "admin", + "update_time": "2023-09-08 17:54:31+0800", + "create_user": "admin", + "create_time": "2023-04-07 12:52:50+0800", + "delete_allowed": false, + "edit_allowed": true, + } + ], + "request_id": "6b439ff5729b4e15b4b94b138b5f0fc1" +} +``` diff --git a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_user_group_detail.md b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_user_group_detail.md index cf2496ab7..e1f39b9b3 100644 --- a/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_user_group_detail.md +++ b/paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/search_user_group_detail.md @@ -35,27 +35,61 @@ #### data字段说明 -| 字段 | 类型 | 描述 | -|----------------|--------|------------------------------------------| -| bk_biz_id | int | 业务ID | -| name | string | 名称 | -| need_duty | bool | 是否轮值 | -| channels | list | 通知渠道 可选项 `user(内部用户)`, `wxwork-bot(企业微信机器人)` | -| id | int | 告警组ID | -| desc | string | 说明 | -| duty_arranges | list | 通知接收人员 | -| alert_notice | list | 告警通知方式 | -| action_notice | list | 告警处理通知配置 | -| strategy_count | int | 关联的告警策略数量 | -| delete_allowed | bool | 是否可删除 | -| edit_allowed | bool | 是否可编辑 | -| config_source | string | 配置来源 | -| update_time | string | 更新时间 | -| update_user | string | 更新人 | -| create_time | string | 创建时间 | -| create_user | string | 创建人 | +| 字段 | 类型 | 描述 | +|----------------|-----------|----------------------------------------------| +| bk_biz_id | int | 业务ID | +| name | string | 名称 | +| need_duty | bool | 是否轮值 | +| channels | list | 通知渠道 可选项 `user(内部用户)`, `wxwork-bot(企业微信机器人)` | +| id | int | 告警组ID | +| desc | string | 说明 | +| duty_rules | list[int] | 轮值规则 | +| duty_arranges | list | 通知接收人员 | +| alert_notice | list | 告警通知方式 | +| action_notice | list | 告警处理通知配置 | +| duty_notice | dict | 轮值计划通知 | +| strategy_count | int | 关联的告警策略数量 | +| delete_allowed | bool | 是否可删除 | +| edit_allowed | bool | 是否可编辑 | +| config_source | string | 配置来源 | +| update_time | string | 更新时间 | +| update_user | string | 更新人 | +| create_time | string | 创建时间 | +| create_user | string | 创建人 | +### `duty_notice` 数据格式 + +| 字段 | 类型 | 必须 | 描述 | +|-----------------|------|-----|----------| +| plan_notice | dict | 否 | 轮值计划通知配置 | +| personal_notice | dict | 否 | 值班人员通知配置 | + +### `plan_notice` 数据格式 + +| 字段 | 类型 | 必须 | 描述 | +|----------|-----------|-----|----------| +| enabled | bool | 否 | 是否发送 | +| period | dict | 否 | 发送时间配置 | +| days | int | 是 | 发送多久以后的 | +| chat_ids | list[str] | 是 | 企业微信ID列表 | + +### `period` 数据格式 + +| 字段 | 类型 | 必须 | 描述 | +|------|-----------|-----|---------------------------------| +| type | string | 是 | 周期类型，`daily` `weekly` `monthly` | +| date | list[int] | 否 | 发送日期，数字表示， `daily`的情况下可为空 | +| time | string | 是 | 交班时间， 格式 `08:00` | + +### `personal_notice` 数据格式 + +| 字段 | 类型 | 必须 | 描述 | +|------------|-----------|-----|------------| +| enabled | bool | 否 | 是否发送 | +| hours_ago | int | 是 | 单位小时，值班前多久 | +| duty_rules | list[int] | 是 | 指定轮值规则 | + ### `duty_arranges` 数据格式 | 字段 | 类型 | 必须 | 描述 | |----------------| ---- | ---- |--------------------------------| diff --git a/paas2/esb/components/confapis/monitor_v3/monitor_v3.yaml b/paas2/esb/components/confapis/monitor_v3/monitor_v3.yaml index f01e51cad..fb961645b 100644 --- a/paas2/esb/components/confapis/monitor_v3/monitor_v3.yaml +++ b/paas2/esb/components/confapis/monitor_v3/monitor_v3.yaml @@ -672,6 +672,7 @@ name: delete_user_groups path: /v2/monitor_v3/delete_user_groups/ suggest_method: POST + - api_type: operate comp_codename: generic.v2.monitor_v3.monitor_v3_component dest_http_method: POST @@ -682,6 +683,73 @@ name: save_user_group path: /v2/monitor_v3/save_user_group/ suggest_method: POST + +- api_type: operate + comp_codename: generic.v2.monitor_v3.monitor_v3_component + dest_http_method: POST + dest_path: /api/v4/user_group/preview/ + is_hidden: false + label: 预览一个组的轮值规则 + label_en: preview duty user group + name: preview_user_group + path: /v2/monitor_v3/preview_user_group/ + suggest_method: POST + +- api_type: query + comp_codename: generic.v2.monitor_v3.monitor_v3_component + dest_http_method: POST + dest_path: /api/v4/duty_rule/search/ + is_hidden: false + label: 查询轮值规则组 + label_en: search user group latest + name: search_duty_rules + path: /v2/monitor_v3/search_duty_rules/ + suggest_method: POST + +- api_type: query + comp_codename: generic.v2.monitor_v3.monitor_v3_component + dest_http_method: POST + dest_path: /api/v4/duty_rule/search_detail/ + is_hidden: false + label: 查询单个轮值规则的详情 + label_en: search duty rule detail + name: search_duty_rule_detail + path: /v2/monitor_v3/search_duty_rule_detail/ + suggest_method: POST + +- api_type: operate + comp_codename: generic.v2.monitor_v3.monitor_v3_component + dest_http_method: POST + dest_path: /api/v4/duty_rule/delete/ + is_hidden: false + label: 批量删除轮值规则 + label_en: delete duty rules + name: delete_duty_rules + path: /v2/monitor_v3/delete_duty_rules/ + suggest_method: POST + +- api_type: operate + comp_codename: generic.v2.monitor_v3.monitor_v3_component + dest_http_method: POST + dest_path: /api/v4/duty_rule/save/ + is_hidden: false + label: 保存轮值规则 + label_en: save duty rule + name: save_duty_rule + path: /v2/monitor_v3/save_duty_rule/ + suggest_method: POST + +- api_type: operate + comp_codename: generic.v2.monitor_v3.monitor_v3_component + dest_http_method: POST + dest_path: /api/v4/duty_rule/preview/ + is_hidden: false + label: 预览轮值规则 + label_en: preview duty rule + name: preview_duty_rule + path: /v2/monitor_v3/preview_duty_rule/ + suggest_method: POST + - api_type: operate comp_codename: generic.v2.monitor_v3.monitor_v3_component dest_http_method: POST diff --git a/paas2/release.md b/paas2/release.md index 27c8ce396..6824d5b55 100644 --- a/paas2/release.md +++ b/paas2/release.md @@ -1,5 +1,8 @@ Release Log =============================== +# 2.14.63 + - esb: update monitor_v3 confapis + # 2.14.62 - esb: update monitor_v3 confapis