Skip to content

Commit 9bb1002

Browse files
zhu327zhu327
authored
feat: update bk-monitor components docs (#1113)
1 parent f5a1c6e commit 9bb1002

File tree

10 files changed

+941
-100
lines changed

10 files changed

+941
-100
lines changed

‎paas2/VERSION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2.14.62
1+
2.14.63

‎paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/preview_duty_rule.md‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
### 功能描述
2+
3+
保存轮值规则
4+
5+
### 请求参数
6+
7+
{{ common_args_desc }}
8+
9+
#### 接口参数
10+
11+
| 字段 | 类型 | 必须 | 描述 |
12+
|----------------|--------|------|---------------------------------|
13+
| id | int | 否 | 轮值规则ID（source_type为DB的时候必填） |
14+
| bk_biz_id | int | 是 | 业务ID |
15+
| begin_time | string | 是 | 预览生效开始时间（日期时间格式） |
16+
| days | int | 否 | 默认生效时间开始30天 |
17+
| source_type | string | 否 | 数据来源类型 `API（接口参数）` `DB（DB存储内容）` |
18+
| config | dict | 否 | 数据来源类型为API的时候必填，格式参考保存轮值规则 |
19+
20+
21+
#### DB数据预览示例数据
22+
23+
```json
24+
{
25+
"source_type": "DB",
26+
"id": 2,
27+
"begin_time": "2023-12-01 00:00:00",
28+
"days": 7,
29+
"bk_biz_id": 2
30+
}
31+
```
32+
33+
# 通过API获取
34+
```json
35+
{
36+
"source_type": "API",
37+
"id": 2,
38+
"begin_time": "2023-12-01 00:00:00",
39+
"days": 7,
40+
"bk_biz_id": 2,
41+
"config": {
42+
"name": "handoff duty",
43+
"bk_biz_id": 2,
44+
"effective_time": "2023-07-25 11:00:00",
45+
"end_time": "",
46+
"labels": ["mysql", "redis", "business"],
47+
"enabled": true,
48+
"category": "handoff",
49+
"duty_arranges": [
50+
{
51+
"duty_time": [{"work_type": "daily",
52+
"work_days": [],
53+
"work_time_type": "time_range",
54+
"work_time": ["00:00--23:59"],
55+
"period_settings": {
56+
"window_unit": "day",
57+
"duration": 2
58+
}
59+
}],
60+
"duty_users": [
61+
[
62+
{
63+
"id": "admin",
64+
"type": "user"
65+
},
66+
{
67+
"id": "admin1",
68+
"type": "user"
69+
},
70+
{
71+
"id": "admin2",
72+
"type": "user"
73+
}, {
74+
"id": "admin3",
75+
"type": "user"
76+
}, {
77+
"id": "admin4",
78+
"type": "user"
79+
}, {
80+
"id": "admin5",
81+
"type": "user"
82+
}
83+
]
84+
],
85+
"group_type": "auto",
86+
"group_number": 2,
87+
"backups": []
88+
}
89+
]
90+
}
91+
}
92+
```
93+
94+
### 响应参数
95+
96+
| 字段 | 类型 | 描述 |
97+
|------------|--------------|-----------|
98+
| result | bool | 请求是否成功 |
99+
| code | int | 返回的状态码 |
100+
| message | string | 描述信息 |
101+
| data | list[object] | 预览数据 |
102+
| request_id | str | ESB记录请求ID |
103+
104+
#### data 格式说明：
105+
| 字段 | 类型 | 描述 |
106+
|-------|------------|--|
107+
| users | list[user] | 值班用户，格式参考用户 |
108+
| work_times | list[work_time] | 值班时间 |
109+
110+
111+
#### work_time 格式说明：
112+
| 字段 | 类型 | 描述 |
113+
|-------|------------|--|
114+
| start_time | string | 时间格式 `2023-12-01 00:00`|
115+
| end_time | string | 时间格式 `2023-12-01 23:59`|
116+
117+
118+

‎paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/preview_user_group.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
### 功能描述
2+
3+
保存轮值规则
4+
5+
### 请求参数
6+
7+
{{ common_args_desc }}
8+
9+
#### 接口参数
10+
11+
| 字段 | 类型 | 必须 | 描述 |
12+
|-------------|--------|--|-----------------------------------------------|
13+
| id | int | 否 | 轮值规则ID（source_type为DB的时候必填） |
14+
| bk_biz_id | int | 是 | 业务ID |
15+
| begin_time | string | 是 | 预览生效开始时间（日期时间格式） |
16+
| days | int | 否 | 默认生效时间开始30天 |
17+
| source_type | string | 否 | 数据来源类型 `API（接口参数）` `DB（DB存储内容）` |
18+
| config | dict | 否 | 数据来源类型为API的时候必填，格式为 `{"duty_rules": [1,2,3]}` |
19+
20+
21+
#### DB数据预览示例数据
22+
23+
```json
24+
{
25+
"source_type": "DB",
26+
"id": 2,
27+
"begin_time": "2023-12-01 00:00:00",
28+
"days": 7,
29+
"bk_biz_id": 2
30+
}
31+
```
32+
33+
# 通过API获取
34+
```json
35+
{
36+
"source_type": "API",
37+
"begin_time": "2023-12-01 00:00:00",
38+
"days": 7,
39+
"bk_biz_id": 2,
40+
"config":{
41+
"duty_rules": [2, 3]
42+
}
43+
}
44+
```
45+
46+
### 响应参数
47+
48+
| 字段 | 类型 | 描述 |
49+
|------------|--------------|-----------|
50+
| result | bool | 请求是否成功 |
51+
| code | int | 返回的状态码 |
52+
| message | string | 描述信息 |
53+
| data | list[object] | 预览数据 |
54+
| request_id | str | ESB记录请求ID |
55+
56+
#### data 格式说明：
57+
| 字段 | 类型 | 描述 |
58+
|-------|------------|--|
59+
| users | list[user] | 值班用户，格式参考用户 |
60+
| work_times | list[work_time] | 值班时间 |
61+
62+
63+
#### work_time 格式说明：
64+
| 字段 | 类型 | 描述 |
65+
|-------|------------|--|
66+
| start_time | string | 时间格式 `2023-12-01 00:00`|
67+
| end_time | string | 时间格式 `2023-12-01 23:59`|
68+
69+
70+

‎paas2/esb/components/confapis/monitor_v3/apidocs/zh_hans/save_duty_rule.md‎

Lines changed: 199 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,199 @@
1+
### 功能描述
2+
3+
保存轮值规则
4+
5+
### 请求参数
6+
7+
{{ common_args_desc }}
8+
9+
#### 接口参数
10+
11+
| 字段 | 类型 | 必须 | 描述 |
12+
|----------------|-----------|-----|--------------------------------------|
13+
| id | int | 是 | 告警组ID（没有表示新建） |
14+
| bk_biz_id | int | 是 | 业务ID |
15+
| name | string | 是 | 名称 |
16+
| category | string | 是 | 轮值类型 `regular(日常值班)` `handoff(交替轮值)` |
17+
| labels | list[str] | 是 | 规则标签 |
18+
| enabled | bool | 否 | 是否开启，默认为否 |
19+
| duty_arranges | list | 是 | 轮值人员设置 |
20+
| effective_time | string | 是 | 生效时间， 格式 `2022-03-11 00:00:00` |
21+
| end_time | string | 否 | 截止时间， 格式 `2022-03-11 00:00:00` |
22+
23+
### `duty_arranges` 数据格式
24+
25+
| 字段 | 类型 | 必须 | 描述 |
26+
|----------------|------------------|-----|---------------------------------|
27+
| id | int | 否 | 轮值ID，保存时有id表示更新，没有id表示新增 |
28+
| need_rotation | bool | 否 | 是否需要交接班 |
29+
| duty_time | list[object] | 否 | 工作时间配置，默认为每天 24小时工作 |
30+
| group_type | string | 否 | `specified(手动指定)` `auto(自动分配)` |
31+
| group_number | int | 否 | `auto(自动分配)` 情况下每组人数 |
32+
| duty_users | list[list[user]] | 是 | 值班人员组, 当为自动分组的时候，默认取第一组 |
33+
34+
#### `user` 选项说明
35+
36+
| 字段 | 类型 | 必须 | 描述 |
37+
|------|--------|-----|-------------------|
38+
| id | string | 是 | 用户英文名或者角色代号 |
39+
| type | string | 是 | `group` or `user` |
40+
41+
#### `duty_time` 内元素选项说明
42+
43+
| 字段 | 类型 | 必须 | 描述 |
44+
|-----------------|--------------|-----|--------------------------------------------------------------------------------------|
45+
| is_custom | bool | 否 | 是否为自定义类型, 默认为`false` |
46+
| work_type | string | 是 | 轮值类型，默认 `daily`， 可选项 `daily`，`weekly`, `monthly`, `work_day` `weekend` `date_range` |
47+
| work_days | list[int] | 否 | 工作日期， 选项根据`work_type`, 排列在第一位的表示起始日期 |
48+
| work_date_range | list[string] | 否 | 工作日期范围， 选项根据`work_type`, 格式为["2019-10-01--2019-12-31"] |
49+
| work_time_type | string | 否 | 工作时间类型 默认 `time_range` ,可选项`time_range` `datetime_range` |
50+
| work_time | list[string] | 是 | 工作时间段 格式 `time_range`：[`00:00--23:59`] `datetime_range`：[`01 00:00--02 23:59`] |
51+
| period_settings | object | 否 | 自定义周期 {'window_unit': "`day` `hour`", "duration":1} |
52+
53+
`work_type` 类型对应日期`work_days`选择说明
54+
55+
| 轮值类型 | 对应选项说明 |
56+
|---------|------------------------------------------------------|
57+
| daily | 为空，不需要设置 |
58+
| weekly | 1，2，3，4，5，6，7 代表周一 至 周日， 如有全部选项，则设置为 [1,2,3,4,5,6,7] |
59+
| monthly | 1-31号之间选择，如有全部选项，则设置为 [1,2,3,4,5,6,7...31] |
60+
61+
#### users 格式说明
62+
63+
| 字段 | 类型 | 描述 |
64+
|--------------|--------|----------------------|
65+
| id | string | 角色key或者用户ID |
66+
| display_name | string | 显示名 |
67+
| type | string | 类型，可选项`group`，`user` |
68+
| members | list | 对应的人员信息（针对group类型） |
69+
70+
#### 请求示例数据
71+
72+
```json
73+
{
74+
"name": "name",
75+
"bk_biz_id": 2,
76+
"effective_time": "2023-07-25 11:00:00",
77+
"end_time": "",
78+
"labels": [
79+
"mysql",
80+
"redis",
81+
"business"
82+
],
83+
"enabled": true,
84+
"category": "regular",
85+
"duty_arranges": [
86+
{
87+
"duty_time": [
88+
{
89+
"work_type": "daily",
90+
"work_days": [],
91+
"work_time": [
92+
"00:00--23:59"
93+
]
94+
}
95+
],
96+
"duty_users": [
97+
[
98+
{
99+
"id": "bk_biz_maintainer",
100+
"type": "group",
101+
}
102+
]
103+
],
104+
"backups": []
105+
},
106+
{
107+
"duty_time": [
108+
{
109+
"work_type": "weekly",
110+
"work_days": [1,2,3,4,5],
111+
"work_time": [
112+
"00:00--23:59"
113+
]
114+
}
115+
],
116+
"duty_users": [
117+
[
118+
{
119+
"id": "admin",
120+
"type": "user",
121+
},
122+
{
123+
"id": "admin1",
124+
"type": "user",
125+
}
126+
]
127+
],
128+
"backups": []
129+
}
130+
]
131+
}
132+
```
133+
134+
# 周期轮值自定义方案
135+
```json
136+
{
137+
"name": "handoff duty",
138+
"bk_biz_id": 2,
139+
"effective_time": "2023-07-25 11:00:00",
140+
"end_time": "",
141+
"labels": ["mysql", "redis", "business"],
142+
"enabled": true,
143+
"category": "handoff",
144+
"duty_arranges": [
145+
{
146+
"duty_time": [{"work_type": "daily",
147+
"work_days": [],
148+
"work_time_type": "time_range",
149+
"work_time": ["00:00--23:59"],
150+
"period_settings": {
151+
"window_unit": "day",
152+
"duration": 2
153+
}
154+
}],
155+
"duty_users": [
156+
[
157+
{
158+
"id": "admin",
159+
"type": "user"
160+
},
161+
{
162+
"id": "admin1",
163+
"type": "user"
164+
},
165+
{
166+
"id": "admin2",
167+
"type": "user"
168+
}, {
169+
"id": "admin3",
170+
"type": "user"
171+
}, {
172+
"id": "admin4",
173+
"type": "user"
174+
}, {
175+
"id": "admin5",
176+
"type": "user"
177+
}
178+
]
179+
],
180+
"group_type": "auto",
181+
"group_number": 2,
182+
"backups": []
183+
}
184+
]
185+
}
186+
187+
```
188+
189+
### 响应参数
190+
191+
| 字段 | 类型 | 描述 |
192+
|------------|--------|-----------|
193+
| result | bool | 请求是否成功 |
194+
| code | int | 返回的状态码 |
195+
| message | string | 描述信息 |
196+
| data | dict | 数据 |
197+
| request_id | str | ESB记录请求ID |
198+
199+
#### data 格式说明： 参考获取告警组详情接口

0 commit comments

Comments
 (0)