Skip to content

Commit

Permalink
feat: update bk-monitor components docs (#1113)
Browse files Browse the repository at this point in the history
  • Loading branch information
@zhu327
zhu327 authored Jan 11, 2024
1 parent f5a1c6e commit 9bb1002
Show file tree
Hide file tree
Showing 10 changed files with 941 additions and 100 deletions.
2 changes: 1 addition & 1 deletion paas2/VERSION
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.14.62
2.14.63
118 changes: 118 additions & 0 deletions paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/preview_duty_rule.md
View file
Original file line number Diff line number Diff line change
@@ -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`|



70 changes: 70 additions & 0 deletions paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/preview_user_group.md
View file
Original file line number Diff line number Diff line change
@@ -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`|



199 changes: 199 additions & 0 deletions paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_duty_rule.md
View file
Original file line number Diff line number Diff line change
@@ -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 格式说明： 参考获取告警组详情接口
Loading

0 comments on commit 9bb1002

Please sign in to comment.