forked from TencentBlueKing/bk-job
-
Notifications
You must be signed in to change notification settings - Fork 0
/
job.yaml
575 lines (519 loc) · 17.6 KB
/
job.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
- path: /v2/jobv3/execute_job_plan/
name: execute_job_plan
label: 执行作业执行方案
label_en: Execute job plan
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-execute/execute_job_plan/
dest_http_method: POST
- path: /v2/jobv3/fast_execute_script/
name: fast_execute_script
label: 快速执行脚本
label_en: Fast execute script
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-execute/fast_execute_script/
dest_http_method: POST
- path: /v2/jobv3/fast_execute_sql/
name: fast_execute_sql
label: 快速执行SQL
label_en: Fast execute SQL
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-execute/fast_execute_sql/
dest_http_method: POST
- path: /v2/jobv3/fast_transfer_file/
name: fast_transfer_file
label: 快速分发文件
label_en: Fast transfer file
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-execute/fast_transfer_file/
dest_http_method: POST
- path: /v2/jobv3/push_config_file/
name: push_config_file
label: 分发配置文件
label_en: Distribute config file
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-execute/push_config_file/
dest_http_method: POST
is_hidden: True
- path: /v2/jobv3/operate_step_instance/
name: operate_step_instance
label: 步骤实例操作
label_en: Operate step instance
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-execute/operate_step_instance/
dest_http_method: POST
- path: /v2/jobv3/operate_job_instance/
name: operate_job_instance
label: 作业实例操作
label_en: Operate job instance
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-execute/operate_job_instance/
dest_http_method: POST
- path: /v2/jobv3/get_job_instance_status/
name: get_job_instance_status
label: 根据作业实例 ID 查询作业执行状态
label_en: Get the job execution status based on the job instance ID
suggest_method: POST
api_type: query
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-execute/get_job_instance_status/
dest_http_method: POST
- path: /v2/jobv3/get_job_instance_ip_log/
name: get_job_instance_ip_log
label: 根据作业实例ID查询作业执行日志
label_en: Get job instance ip log
suggest_method: POST
api_type: query
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-execute/get_job_instance_ip_log/
dest_http_method: POST
- path: /v2/jobv3/batch_get_job_instance_ip_log/
name: batch_get_job_instance_ip_log
label: 根据ip列表批量查询作业执行日志
label_en: Batch get job instance ip log
suggest_method: POST
api_type: query
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-execute/batch_get_job_instance_ip_log/
dest_http_method: POST
- path: /v2/jobv3/get_job_instance_list/
name: get_job_instance_list
label: 查询作业实例列表(执行历史)
label_en: Get job instance list
suggest_method: POST
api_type: query
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-execute/get_job_instance_list/
dest_http_method: POST
- path: /v2/jobv3/get_job_instance_global_var_value/
name: get_job_instance_global_var_value
label: 获取作业实例全局变量值
label_en: Get job instance global variable value
suggest_method: POST
api_type: query
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-execute/get_job_instance_global_var_value/
dest_http_method: POST
- path: /v2/jobv3/get_job_template_list/
name: get_job_template_list
label: 查询作业模版列表
label_en: Get job template list
suggest_method: POST
api_type: query
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/get_job_template_list/
dest_http_method: POST
- path: /v2/jobv3/get_job_plan_list/
name: get_job_plan_list
label: 查询执行方案列表
label_en: Get job execution plan list
suggest_method: POST
api_type: query
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/get_job_plan_list/
dest_http_method: POST
- path: /v2/jobv3/get_job_plan_detail/
name: get_job_plan_detail
label: 查询执行方案详情
label_en: Get job execution plan detail
suggest_method: POST
api_type: query
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/get_job_plan_detail/
dest_http_method: POST
- path: /v2/jobv3/get_account_list/
name: get_account_list
label: 查询业务下的执行账号
label_en: Get accounts
suggest_method: POST
api_type: query
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/get_account_list/
dest_http_method: POST
- path: /v2/jobv3/get_public_script_list/
name: get_public_script_list
label: 查询公共脚本列表
label_en: Get public script list
suggest_method: POST
api_type: query
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/get_public_script_list/
dest_http_method: POST
- path: /v2/jobv3/get_public_script_version_list/
name: get_public_script_version_list
label: 查询公共脚本版本列表
label_en: Get public script version list
suggest_method: POST
api_type: query
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/get_public_script_version_list/
dest_http_method: POST
- path: /v2/jobv3/get_public_script_version_detail/
name: get_public_script_version_detail
label: 查询公共脚本详情
label_en: Get public script detail
suggest_method: POST
api_type: query
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/get_public_script_version_detail/
dest_http_method: POST
- path: /v2/jobv3/get_script_list/
name: get_script_list
label: 查询脚本列表
label_en: Get script list
suggest_method: POST
api_type: query
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/get_script_list/
dest_http_method: POST
- path: /v2/jobv3/get_script_version_list/
name: get_script_version_list
label: 查询脚本版本列表
label_en: Get script version list
suggest_method: POST
api_type: query
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/get_script_version_list/
dest_http_method: POST
- path: /v2/jobv3/get_script_version_detail/
name: get_script_version_detail
label: 查询脚本详情
label_en: Get script version detail
suggest_method: POST
api_type: query
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/get_script_version_detail/
dest_http_method: POST
- path: /v2/jobv3/get_cron_list/
name: get_cron_list
label: 查询业务下定时作业信息
label_en: Get crontab job list
suggest_method: POST
api_type: query
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-crontab/get_cron_list/
dest_http_method: POST
- path: /v2/jobv3/get_cron_detail/
name: get_cron_detail
label: 查询定时作业详情
label_en: Get crontab job detail
suggest_method: POST
api_type: query
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-crontab/get_cron_detail/
dest_http_method: POST
- path: /v2/jobv3/save_cron/
name: save_cron
label: 新建或保存定时作业
label_en: Create or update crontab job
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-crontab/save_cron/
dest_http_method: POST
- path: /v2/jobv3/update_cron_status/
name: update_cron_status
label: 更新定时作业状态,如启动或暂停
label_en: Update crontab job status, such as startup or stop
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-crontab/update_cron_status/
dest_http_method: POST
- path: /v2/jobv3/delete_cron/
name: delete_cron
label: 删除定时任务
label_en: Delete cron
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-crontab/delete_cron/
dest_http_method: POST
- path: /v2/jobv3/create_credential/
name: create_credential
label: 新建凭据
label_en: Create credential
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/create_credential/
dest_http_method: POST
is_hidden: True
- path: /v2/jobv3/update_credential/
name: update_credential
label: 更新凭据
label_en: Update credential
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/update_credential/
dest_http_method: POST
is_hidden: True
- path: /v2/jobv3/create_file_source/
name: create_file_source
label: 新建文件源
label_en: Create file source
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-file-gateway/create_file_source/
dest_http_method: POST
is_hidden: True
- path: /v2/jobv3/update_file_source/
name: update_file_source
label: 更新文件源
label_en: Update file source
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-file-gateway/update_file_source/
dest_http_method: POST
is_hidden: True
- path: /v2/jobv3/generate_local_file_upload_url/
name: generate_local_file_upload_url
label: 生成本地文件上传URL
label_en: Generate local file upload url
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/generate_local_file_upload_url/
dest_http_method: POST
is_hidden: True
- path: /v2/jobv3/create_public_script/
name: create_public_script
label: 创建公共脚本
label_en: Save public script
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/create_public_script/
dest_http_method: POST
- path: /v2/jobv3/update_public_script_basic/
name: update_public_script_basic
label: 更新公共脚本基础信息
label_en: Update public script
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/update_public_script_basic/
dest_http_method: POST
- path: /v2/jobv3/delete_public_script_version/
name: delete_public_script_version
label: 删除公共脚本版本
label_en: Delete public script version
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/delete_public_script_version/
dest_http_method: POST
- path: /v2/jobv3/create_public_script_version/
name: create_public_script_version
label: 新建公共脚本版本
label_en: Save public script version
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/create_public_script_version/
dest_http_method: POST
- path: /v2/jobv3/update_public_script_version/
name: update_public_script_version
label: 修改公共脚本版本
label_en: Update public script version
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/update_public_script_version/
dest_http_method: POST
- path: /v2/jobv3/publish_public_script_version/
name: publish_public_script_version
label: 发布公共脚本版本
label_en: Publish public script version
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/publish_public_script_version/
dest_http_method: POST
- path: /v2/jobv3/disable_public_script_version/
name: disable_public_script_version
label: 禁用公共脚本版本
label_en: Disable public script version
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/disable_public_script_version/
dest_http_method: POST
- path: /v2/jobv3/delete_public_script/
name: delete_public_script
label: 删除公共脚本
label_en: Delete public script
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/delete_public_script/
dest_http_method: POST
- path: /v2/jobv3/create_script/
name: create_script
label: 创建脚本
label_en: Save script
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/create_script/
dest_http_method: POST
- path: /v2/jobv3/update_script_basic/
name: update_script_basic
label: 更新脚本基础信息
label_en: Update script basic
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/update_script_basic/
dest_http_method: POST
- path: /v2/jobv3/delete_script_version/
name: delete_script_version
label: 删除脚本版本
label_en: Delete script version
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/delete_script_version/
dest_http_method: POST
- path: /v2/jobv3/create_script_version/
name: create_script_version
label: 新建脚本版本
label_en: Save script version
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/create_script_version/
dest_http_method: POST
- path: /v2/jobv3/update_script_version/
name: update_script_version
label: 修改脚本版本信息
label_en: Update script version
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/update_script_version/
dest_http_method: POST
- path: /v2/jobv3/publish_script_version/
name: publish_script_version
label: 发布脚本版本
label_en: Publish script version
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/publish_script_version/
dest_http_method: POST
- path: /v2/jobv3/disable_script_version/
name: disable_script_version
label: 禁用脚本版本
label_en: Disable script version
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/disable_script_version/
dest_http_method: POST
- path: /v2/jobv3/delete_script/
name: delete_script
label: 删除脚本
label_en: Delete script
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/delete_script/
dest_http_method: POST
- path: /v2/jobv3/create_account/
name: create_account
label: 创建账号
label_en: Create account
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/create_account/
dest_http_method: POST
- path: /v2/jobv3/delete_account/
name: delete_account
label: 删除账号
label_en: Delete account
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/delete_account/
dest_http_method: POST
- path: /v2/jobv3/create_dangerous_rule/
name: create_dangerous_rule
label: 创建高危语句规则
label_en: Create dangerous rule
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/create_dangerous_rule/
dest_http_method: POST
- path: /v2/jobv3/update_dangerous_rule/
name: update_dangerous_rule
label: 修改高危语句规则
label_en: Update dangerous rule
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/update_dangerous_rule/
dest_http_method: POST
- path: /v2/jobv3/delete_dangerous_rule/
name: delete_dangerous_rule
label: 删除高危语句规则
label_en: Delete dangerous rule
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/delete_dangerous_rule/
dest_http_method: POST
- path: /v2/jobv3/get_dangerous_rule_list/
name: get_dangerous_rule_list
label: 查看高危语句规则列表
label_en: Get dangerous rule list
suggest_method: POST
api_type: query
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/get_dangerous_rule_list/
dest_http_method: POST
- path: /v2/jobv3/enable_dangerous_rule/
name: enable_dangerous_rule
label: 启用高危语句规则
label_en: Enable dangerous rule
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/enable_dangerous_rule/
dest_http_method: POST
- path: /v2/jobv3/disable_dangerous_rule/
name: disable_dangerous_rule
label: 停用高危语句规则
label_en: Disable dangerous rule
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/disable_dangerous_rule/
dest_http_method: POST
- path: /v2/jobv3/check_script/
name: check_script
label: 高危脚本检测
label_en: Check script
suggest_method: POST
api_type: operate
comp_codename: generic.v2.jobv3.job_component
dest_path: /api/job/v3/job-manage/check_script/
dest_http_method: POST