'param_type': '参数类型: 0.全部, 1.静态参数, 2.SQL参数, 3.上下文参数',
'param_name': '参数名称',
'source_id': '数据源id',
'param_value': '参数值: 静态值,SQL查询,上下文参数以$开始',
'is_deleted': '是否使用: 0.全部, 1.使用, 2.失效',
'index_id': '参数目录id: 0为全部',
'page': '页码',
'limit': '条数'
})
# 参数新增请求
params_add_request = api.doc(body=api.model(
'params_add_request', {
'param_type': fields.Integer(description='参数类型: 0.静态参数, 1.SQL参数'),
'param_name': fields.String(description='参数名称'),
'param_index': fields.String(description='参数目录'),
'source_id': fields.Integer(description='数据源id'),
'param_value': fields.String(description='参数值: 静态值或SQL查询'),
'param_desc': fields.String(description='描述')
},
description='参数新增请求'))
# 参数修改请求
params_update_request = api.doc(body=api.model(
'params_update_request', {
'param_type': fields.Integer(description='参数类型: 0.静态参数, 1.SQL参数'),
'param_name': fields.String(description='参数名称'),
'param_index': fields.String(description='参数目录'),
'source_id': fields.Integer(description='数据源id'),
'param_value': fields.String(description='参数值: 静态值或SQL查询'),
'param_desc': fields.String(description='描述'),
'is_deleted': fields.Integer(description='是否失效: 0.正常, 1.失效')
# 获取执行服务器请求
exec_host_request = api.doc(
params={
'server_name': '服务器名称',
'server_host': '服务器IP',
'is_deleted': '是否删除: 0全部, 1正常, 2删除',
'page': '页码',
'limit': '条数'
})
# 执行服务器修改请求
exec_host_update_request = api.doc(
body=api.model('exec_host_update_request', {
'server_id': fields.Integer(description='执行服务器id'),
'server_host': fields.String(description='执行服务器ip'),
'server_name': fields.String(description='执行服务器名称'),
'is_deleted': fields.Integer(description='是否失效: 0正常, 1失效')
},
description='执行服务器修改请求'))
# 预警配置列表请求值
alert_conf_list_request = api.doc(
params={
'alert_channel': '预警渠道:0.全部,1.邮件,2.钉钉',
'conf_name': '配置名称',
'is_deleted': '是否删除: 0全部, 1正常, 2删除',
'page': '页码',
'limit': '条数'
})
# 预警配置列表返回值
# !/usr/bin/env python
# -*- coding: utf-8 -*-
from configs import api
from flask_restplus import fields
# 登陆
login_data_request = api.doc(
body=api.model('login_data_request', {
'username': fields.String(description='用户名'),
'password': fields.String(description='密码')
},
description='用户登录请求参数'))
# 登陆返回值
login_data_response_success = api.response(
200, '成功',
api.model(
'login_response_success', {
'state': fields.Integer(description=200),
'msg': fields.String(description='成功')
}))
# ftp配置列表请求值
ftp_list_request = api.doc(params={
'ftp_name': 'ftp配置名称',
'ftp_type': 'ftp类型: 0.全部, 1.ftp, 2.sftp',
'ftp_host': 'ftp域名',
'is_deleted': '是否失效: 0.全部, 1.使用, 2.失效',
'page': '页码',
'limit': '条数'
})
# 测试ftp连接请求
ftp_test_request = api.doc(body=api.model('ftp_test_request', {
'ftp_id': fields.String(description='FTP配置id'),
'ftp_type': fields.Integer(description='ftp类型: 1.ftp, 2.sftp'),
'ftp_host': fields.String(description='ftp域名'),
'ftp_port': fields.Integer(description='ftp端口'),
'ftp_user': fields.String(description='ftp用户名'),
'ftp_passwd': fields.String(description='ftp密码')
}, description='测试ftp连接请求'))
# 新增ftp详情请求
ftp_add_detail_request = api.doc(body=api.model('ftp_add_detail_request', {
'ftp_name': fields.String(description='ftp名称'),
'ftp_desc': fields.String(description='ftp描述'),
'ftp_type': fields.Integer(description='ftp类型: 1.ftp, 2.sftp'),
'ftp_host': fields.String(description='ftp域名'),
'ftp_port': fields.Integer(description='ftp端口'),
'ftp_user': fields.String(description='ftp用户名'),
'ftp_passwd': fields.String(description='ftp密码')
}, description='新增ftp详情请求'))
# !/usr/bin/env python
# -*- coding: utf-8 -*-
from configs import api
from flask_restplus import fields
# 新增调度任务
scheduler_add_request = api.doc(
body=api.model('scheduler_add_request', {
'id': fields.String(description='调度id'),
'func': fields.String(description='调度函数'),
'args': fields.String(description='调度参数'),
'trigger': fields.String(description='调度器类型'),
'minute': fields.String(description='分'),
'hour': fields.String(description='时'),
'day': fields.String(description='天'),
'month': fields.String(description='月'),
'week': fields.Integer(description='周')
},
description='新增调度任务'))
'interface_name': '任务流名称',
'interface_index': '任务流目录',
'start_time': '开始创建时间',
'end_time': '结束创建时间',
'is_deleted': '是否使用: 0全部, 1正常, 2删除',
'page': '页码',
'limit': '条数'
})
# 任务流列表返回值
interface_list_response_success = api.response(200, '成功', api.model('interface_list_response_success', {
'state': fields.Integer(description=200),
'msg': fields.String(description='成功'),
'data': fields.Nested(model=api.model('job_list_response_data', {
'interface_id': fields.String(description='任务流id'),
'user_name': fields.String(description='创建者'),
'interface_name': fields.String(description='任务流名称'),
'interface_desc': fields.String(description='任务流描述'),
'is_deleted': fields.Integer(description='是否失效: 0.正常, 1.失效'),
}), description='任务流列表返回值')
}))
# 任务流图请求
interface_graph = api.doc(params={
'graph_type': '图表类型: 1.任务流中任务依赖, 2.局部-任务流依赖, 3.全局-任务流依赖'
})
# 任务流修改请求
interface_update_request = api.doc(body=api.model('interface_update_request', {
'interface_name': fields.String(description='任务流名称'),
'interface_desc': fields.String(description='任务流描述'),
from flask_restplus import fields
# 血缘关系请求值
graph_data_request = api.doc(params={
'schedule_id': '调度id',
'schedule_status': '调度状态: 0: 全部; 1: 正常; 2: 停止; 3: 运行中',
'dependent_status': '调度依赖状态: 0: 全部; 1: 正常; 2: 停止',
'show_type': '展示类型: 1: 关系图; 2:和弦图'
})
# 血缘关系返回值
graph_data_response_success = api.response(200, '成功', api.model('interface_response_success', {
'state': fields.Integer(description=200),
'msg': fields.String(description='成功'),
'data': fields.Nested(model=api.model('response_data', {
'data': fields.List(fields.Nested(model=api.model('data_response', {
'id': fields.String(description='排序id'),
'name': fields.Integer(description='调度id'),
'category': fields.Integer(description='分组'),
'symbolSize': fields.Integer(description='权重'),
'x': fields.Integer(description='x轴坐标'),
'y': fields.Integer(description='y轴坐标')
}))),
'links': fields.List(fields.Nested(model=api.model('links_response', {
'source': fields.String(description='初始点'),
'target': fields.Integer(description='结束点'),
'lineStyle': fields.String(description='边样式')
}))),
'layout': fields.String('展示类型')
}), description='关系数据')
}))
# 获取执行服务器请求
exec_host_request = api.doc(
params={
'server_name': '服务器名称',
'server_host': '服务器IP',
'is_deleted': '是否删除: 0全部, 1正常, 2删除',
'page': '页码',
'limit': '条数'
})
# 执行服务器修改请求
exec_host_update_request = api.doc(
body=api.model('exec_host_update_request', {
'server_id': fields.Integer(description='执行服务器id'),
'server_host': fields.Integer(description='执行服务器ip'),
'server_name': fields.String(description='执行服务器名称'),
'is_deleted': fields.Integer(description='是否失效: 0正常, 1失效')
},
description='执行服务器修改请求'))
# 预警配置列表请求值
alert_conf_list_request = api.doc(
params={
'alert_channel': '预警渠道:0.全部,1.邮件,2.钉钉',
'conf_name': '配置名称',
'is_deleted': '是否删除: 0全部, 1正常, 2删除',
'page': '页码',
'limit': '条数'
})
# 预警配置列表返回值
# 执行日志请求
execute_log_request = api.doc(params={
'exec_id': '执行id',
'job_id': '任务id: 0.全部日志列表, 其他: 具体任务日志'
})
# 执行拓扑结构请求
execute_graph_request = api.doc(params={
'exec_id': '执行id',
'interface_id': '任务流id: 0.全部, 其他:其他任务流内拓扑'
})
# 中止执行任务请求
execute_stop_requests = api.doc(body=api.model(
'execute_stop_requests', {
'exec_id': fields.List(fields.Integer, description='执行ID列表'),
},
description='中止执行任务请求'))
# 断点重跑请求
execute_restart_requests = api.doc(body=api.model(
'execute_restart_requests',
{'exec_id': fields.List(fields.Integer, description='执行ID列表')},
description='断点重跑请求参数'))
# 重置执行任务请求
execute_reset_requests = api.doc(body=api.model(
'execute_reset_requests', {
'exec_id': fields.List(fields.Integer, description='执行ID列表'),
},
description='重置执行任务请求'))
# 文件事件列表请求值
ftp_event_list_request = api.doc(params={
'event_name': '文件事件名称',
'status': '调度状态:0全部, 1失效, 2运行中, 3暂停',
'page': '页码',
'limit': '条数'
})
# 文件事件修改请求值
ftp_event_update_request = api.doc(body=api.model('ftp_event_update_request', {
'ftp_event_id': fields.Integer(description='文件事件id'),
'event_name': fields.String(description='事件名称'),
'event_desc': fields.String(description='事件描述'),
'ftp_id': fields.Integer(description='FTP配置id'),
'data_path': fields.String(description='文件路径'),
'file_name': fields.String(description='文件名称'),
'interface_id': fields.String(description='任务流id列表'),
'start_time': fields.String(description='开始时间: 默认00:00'),
'end_time': fields.String(description='结束时间: 默认23:59'),
'interval_value': fields.Integer(description='间隔值: 单位(分钟)'),
'old_status': fields.Integer(description='旧调度状态: 0.失效, 1.运行中, 2.暂停'),
'new_status': fields.Integer(description='新调度状态: 0.失效, 1.运行中, 2.暂停')
}, description='调度修改请求参数'))
# 文件事件新增请求值
ftp_event_add_request = api.doc(body=api.model('ftp_event_add_request', {
'event_name': fields.String(description='事件名称'),
'event_desc': fields.String(description='事件描述'),
'ftp_id': fields.Integer(description='FTP配置id'),
'data_path': fields.String(description='文件路径'),
'file_name': fields.String(description='文件名称'),
'interface_id': fields.String(description='任务流id列表'),
from flask_restplus import fields
# 接口列表请求值
interface_list_request = api.doc(params={
'interface_id': '接口ID',
'interface_type': '接口类型',
'run_times': '运行次数',
'total_times': '运行总次数',
'run_type': '账期类型',
'status': '接口状态'
})
# 接口状态返回值
interface_status_response_success = api.response(200, '成功', api.model('interface_response_success', {
'state': fields.Integer(description=200),
'msg': fields.String(description='成功'),
'data': fields.Nested(model=api.model('response_data', {
's': fields.List(fields.Nested(model=api.model('status_response', {
'name': fields.String(description='描述'),
'value': fields.Integer(description='数值')
}))),
'd': fields.List(fields.Nested(model=api.model('status_response', {
'name': fields.String(description='描述'),
'value': fields.Integer(description='数值')
}))),
'm': fields.List(fields.Nested(model=api.model('status_response', {
'name': fields.String(description='描述'),
'value': fields.Integer(description='数值')
})))
}), description='圆环图')
}))
# 任务列表返回值
job_list_response_success = api.response(
200, '成功',
api.model(
'job_list_response_success', {
'state':
fields.Integer(description=200),
'msg':
fields.String(description='成功'),
'data':
fields.Nested(model=api.model(
'job_list_response_data', {
'job_id': fields.String(description='任务id'),
'user_name': fields.String(description='创建者'),
'job_name': fields.String(description='任务名称'),
'description': fields.String(description='任务描述'),
'server_host': fields.String(description='服务器域名'),
'server_user': fields.String(description='服务器用户'),
'server_dir': fields.String(description='服务器目录'),
'server_script': fields.String(description='脚本命令'),
'is_deleted': fields.Integer(description='是否失效'),
'retry': fields.Integer(description='重试次数'),
'update_time': fields.String(description='修改时间')
}),
description='任务列表返回值')
}))
# 任务修改请求
job_update_request = api.doc(
body=api.model('job_update_request', {
# cron运行次数
cron_request = api.doc(params={
'sched': 'cron表达式',
'timeFormat': '时间格式',
'queryTimes': '运行次数'
})
# 调度新增请求
dispatch_add_request = api.doc(
body=api.model('dispatch_add_request', {
'interface_id': fields.Integer(description='接口id'),
'dispatch_name': fields.String(description='调度名称'),
'dispatch_desc': fields.String(description='调度描述'),
'minute': fields.String(description='分: 0-59'),
'hour': fields.String(description='时: 0-23'),
'day': fields.String(description='日: 1-31'),
'month': fields.String(description='月: 1-12'),
'week': fields.String(description='周: mon-sun')
},
description='调度新增请求参数'))
# 调度预警新增请求
dispatch_alert_add_request = api.doc(
body=api.model('dispatch_alert_add_request', {
'dispatch_id':
fields.Integer(description='调度id'),
'alert_s':
fields.Integer(description='执行流成功开关: 0.关闭,1.开启'),
'alert_f':
fields.Integer(description='执行流失败开关: 0.关闭,1.开启'),
'page': '页码',
'limit': '条数'
})
# 测试数据源连接请求
datasource_test_request = api.doc(body=api.model('datasource_test_request', {
'source_id':
fields.String(description='数据源id'),
'source_type':
fields.String(
description='数据库类型: 1.mysql, 2.mongo, 3.mssql, 4.hive, 5.impala'),
'auth_type':
fields.Integer(
description='认证方式(仅hive和impala使用):0.无,1.NOSASL,2.PLAIN,3.GSSAPI,4.LDAP'
),
'source_host':
fields.String(description='数据库ip或域名'),
'source_port':
fields.Integer(description='数据库端口'),
'source_database':
fields.String(description='数据库库名'),
'source_user':
fields.String(description='用户名'),
'source_password':
fields.String(description='密码'),
},
description='测试数据源连接请求'))
# 新增数据源详情请求
datasource_add_detail_request = api.doc(
body=api.model('datasource_add_detail_request', {
'source_name':
# 任务列表返回值
job_list_response_success = api.response(
200, '成功',
api.model(
'job_list_response_success', {
'state':
fields.Integer(description=200),
'msg':
fields.String(description='成功'),
'data':
fields.Nested(model=api.model(
'job_list_response_data', {
'job_id': fields.String(description='任务id'),
'user_name': fields.String(description='创建者'),
'job_name': fields.String(description='任务名称'),
'description': fields.String(description='任务描述'),
'server_host': fields.String(description='服务器域名'),
'server_user': fields.String(description='服务器用户'),
'server_dir': fields.String(description='服务器目录'),
'server_script': fields.String(description='脚本命令'),
'is_deleted':
fields.Integer(description='是否失效: 0.正常, 1.失效'),
'retry': fields.Integer(description='重试次数'),
'update_time': fields.String(description='修改时间')
}),
description='任务列表返回值')
}))
# 任务修改请求
job_update_request = api.doc(
body=api.model('job_update_request', {
interface_list_request = api.doc(params={
'interface_name': '项目名称',
'start_time': '开始创建时间',
'end_time': '结束创建时间',
'is_deleted': '是否使用: 0全部, 1正常, 2删除',
'page': '页码',
'limit': '条数'
})
# 接口列表返回值
interface_list_response_success = api.response(200, '成功', api.model('interface_list_response_success', {
'state': fields.Integer(description=200),
'msg': fields.String(description='成功'),
'data': fields.Nested(model=api.model('job_list_response_data', {
'interface_id': fields.String(description='接口id'),
'user_name': fields.String(description='创建者'),
'interface_name': fields.String(description='接口名称'),
'interface_desc': fields.String(description='接口描述'),
'run_period': fields.String(description='账期'),
'is_deleted': fields.Integer(description='是否删除: 0否, 1是'),
}), description='接口列表返回值')
}))
# 接口修改请求
interface_update_request = api.doc(body=api.model('interface_update_request', {
'interface_name': fields.String(description='接口名称'),
'interface_desc': fields.String(description='接口描述'),
'retry': fields.Integer(description='重试次数'),
'is_deleted': fields.Integer(description='是否删除: 0否, 1是')
}, description='接口修改请求参数'))
# 新增接口请求