177 lines
8.8 KiB
Python
177 lines
8.8 KiB
Python
# +======================================================================
|
||
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
||
# +----------------------------------------------------------------------
|
||
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
|
||
# +----------------------------------------------------------------------
|
||
# | 开源协议: Apache-2.0
|
||
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
||
# +----------------------------------------------------------------------
|
||
# | 官方网站: https://www.djangoadmin.cn
|
||
# +----------------------------------------------------------------------
|
||
# | 研发团队: 小蚂蚁云团队 荣誉出品
|
||
# +======================================================================
|
||
# | 版权和免责声明:
|
||
# | 一、知识产权声明
|
||
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
|
||
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
|
||
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
||
# | 二、使用限制与禁止条款
|
||
# | 您理解并同意，禁止将本产品用于以下任何行为：
|
||
# | 1. 任何违反中华人民共和国法律法规的用途；
|
||
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
|
||
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
||
# | 三、责任豁免
|
||
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
|
||
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
||
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
|
||
# | 四、违约与法律责任
|
||
# | 如发现任何违反本声明的行为，本团队有权：
|
||
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
|
||
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
|
||
# | 3. 保留进一步采取刑事控告等法律措施的权利。
|
||
# | 五、许可范围说明
|
||
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
|
||
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
||
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
||
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
|
||
# | 成的一切经济损失及商誉损害。
|
||
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
|
||
# | 许可协议》附件为准。
|
||
# +======================================================================
|
||
|
||
"""
|
||
定时任务管理模块路由配置
|
||
=============================================================
|
||
|
||
URL端点概览：
|
||
------------------------------------------------------------------------
|
||
| 功能说明 | 请求方法 | URL路径 | 视图类 |
|
||
|-----------------|----------|-----------------------------|---------------------|
|
||
| 分页查询 | GET | /job/page | JobPageView |
|
||
| 详情查询 | GET | /job/detail/<id> | JobDetailView |
|
||
| 添加任务 | POST | /job/add | JobAddView |
|
||
| 更新任务 | PUT | /job/update | JobUpdateView |
|
||
| 删除任务 | DELETE | /job/delete/<ids> | JobDeleteView |
|
||
| 设置状态 | PUT | /job/status | JobStatusView |
|
||
| 暂停任务 | PUT | /job/pause/<id> | JobPauseView |
|
||
| 恢复任务 | PUT | /job/resume/<id> | JobResumeView |
|
||
| 立即执行 | POST | /job/runOnce/<id> | JobRunOnceView |
|
||
| 短信测试 | POST | /job/sendSms | JobSendSmsView |
|
||
------------------------------------------------------------------------
|
||
|
||
URL参数说明：
|
||
- job_id: int类型，定时任务ID（用于查询详情、暂停、恢复、立即执行）
|
||
- job_id: str类型，逗号分隔的任务ID字符串（用于批量删除）
|
||
|
||
使用示例：
|
||
1. 分页查询：GET /api/job/page?pageNo=1&pageSize=10&name=同步
|
||
2. 详情查询：GET /api/job/detail/5
|
||
3. 添加任务：POST /api/job/add
|
||
4. 更新任务：PUT /api/job/update
|
||
5. 删除任务：DELETE /api/job/delete/1,2,3
|
||
6. 设置状态：PUT /api/job/status
|
||
7. 暂停任务：PUT /api/job/pause/5
|
||
8. 恢复任务：PUT /api/job/resume/5
|
||
9. 立即执行：POST /api/job/runOnce/5
|
||
10. 短信测试：POST /api/job/sendSms
|
||
|
||
URL命名规范：
|
||
- page：分页查询
|
||
- detail：详情查询（带ID参数）
|
||
- add：添加操作
|
||
- update：更新操作
|
||
- delete：删除操作（带ID参数）
|
||
- status：状态设置操作
|
||
- pause：暂停任务操作
|
||
- resume：恢复任务操作
|
||
- runOnce：立即执行操作
|
||
- sendSms：短信测试操作
|
||
"""
|
||
|
||
from django.urls import path # 导入Django URL路由配置模块
|
||
|
||
# 导入定时任务模块的视图层
|
||
# views模块包含了所有定时任务相关的视图类，如分页查询、详情查询、增删改查、状态控制等
|
||
from application.job import views
|
||
|
||
# 定时任务模块URL路由配置列表
|
||
# 每个路径都映射到对应的视图类，通过.as_view()方法将类视图转换为函数视图
|
||
urlpatterns = [
|
||
# ============================ 查询操作 ============================
|
||
|
||
# 查询定时任务分页列表
|
||
# URL: /job/page
|
||
# 请求方法: GET
|
||
# 功能: 获取定时任务分页数据，支持按任务名称、状态、执行器等条件筛选
|
||
path('page', views.JobPageView.as_view()),
|
||
|
||
# 查询定时任务详情
|
||
# URL: /job/detail/<int:job_id>
|
||
# 请求方法: GET
|
||
# URL参数: job_id - 定时任务ID（整数类型）
|
||
# 功能: 根据ID获取指定定时任务的详细信息
|
||
path('detail/<int:job_id>', views.JobDetailView.as_view()),
|
||
|
||
# ============================ 新增操作 ============================
|
||
|
||
# 添加定时任务
|
||
# URL: /job/add
|
||
# 请求方法: POST
|
||
# 功能: 创建新的定时任务记录，请求体需包含任务信息（名称、执行器、Cron表达式、状态等）
|
||
path('add', views.JobAddView.as_view()),
|
||
|
||
# ============================ 修改操作 ============================
|
||
|
||
# 更新定时任务
|
||
# URL: /job/update
|
||
# 请求方法: PUT
|
||
# 功能: 更新现有定时任务信息，请求体需包含任务ID和更新内容
|
||
path('update', views.JobUpdateView.as_view()),
|
||
|
||
# 设置任务状态
|
||
# URL: /job/status
|
||
# 请求方法: PUT
|
||
# 功能: 启用或禁用定时任务，请求体需包含任务ID和目标状态
|
||
path('status', views.JobStatusView.as_view()),
|
||
|
||
# ============================ 删除操作 ============================
|
||
|
||
# 删除定时任务
|
||
# URL: /job/delete/<str:job_id>
|
||
# 请求方法: DELETE
|
||
# URL参数: job_id - 任务ID字符串，支持单个ID或逗号分隔的多个ID（如 "1,2,3"）
|
||
# 功能: 删除指定定时任务（物理删除或逻辑删除）
|
||
path('delete/<str:job_id>', views.JobDeleteView.as_view()),
|
||
|
||
# ============================ 任务控制操作 ============================
|
||
|
||
# 暂停任务
|
||
# URL: /job/pause/<int:job_id>
|
||
# 请求方法: PUT
|
||
# URL参数: job_id - 定时任务ID（整数类型）
|
||
# 功能: 暂停正在运行的定时任务，任务将不再按计划执行
|
||
path('pause/<int:job_id>', views.JobPauseView.as_view()),
|
||
|
||
# 恢复任务
|
||
# URL: /job/resume/<int:job_id>
|
||
# 请求方法: PUT
|
||
# URL参数: job_id - 定时任务ID（整数类型）
|
||
# 功能: 恢复已暂停的定时任务，按原有Cron表达式继续执行
|
||
path('resume/<int:job_id>', views.JobResumeView.as_view()),
|
||
|
||
# 立即执行任务
|
||
# URL: /job/runOnce/<int:job_id>
|
||
# 请求方法: POST
|
||
# URL参数: job_id - 定时任务ID（整数类型）
|
||
# 功能: 立即执行一次定时任务，不影响原有的调度计划
|
||
path('runOnce/<int:job_id>', views.JobRunOnceView.as_view()),
|
||
|
||
# ============================ 测试操作 ============================
|
||
|
||
# 短信测试
|
||
# URL: /job/sendSms
|
||
# 请求方法: POST
|
||
# 功能: 测试短信发送功能，用于验证短信配置是否正确
|
||
path('sendSms', views.JobSendSmsView.as_view()),
|
||
]
|