核心 API 速查
本文从 myapp/views/ 派生。绝大多数业务 API 继承 myapp/views/baseApi.py 的 MyappModelRestApi(基于 flask_appbuilder 的 ModelRestApi),统一提供标准 CRUD;自定义业务端点用 expose_api(description=..., url=...) 装饰,description 多为中文。
URL 前缀架构(浏览器侧带
/backend、nginx strip)见『01-架构原理』段;MyappModelRestApi扩展方式与鉴权见『06-二次开发』段。 本速查为代码派生总览,端点/参数以myapp/views源码为准,仅供导航。
1. 标准 CRUD 约定(每个 route_base 都有,不再逐一重复)
以下端点由 baseApi.py 的 MyappModelRestApi 统一提供(<route_base> 为各资源前缀),均已在 baseApi.py 用 @expose 核对:
| 方法 | 路径 | 作用 |
|---|---|---|
| GET | /_info |
元信息 / 字段配置(前端 ADUGTemplate 据此渲染列表与表单) |
| GET | / |
列表(分页 / 过滤 / 排序) |
| GET | /<pk> |
单条详情 |
| POST | / |
新增 |
| PUT | /<pk> |
修改 |
| DELETE | /<pk> |
删除 |
| GET | /action/<name>/<pk> |
单条自定义动作 |
| POST | /multi_action/<name> |
批量自定义动作 |
| GET | /download_template/ |
下载导入模板 |
| GET | /echart |
图表数据 |
| POST | /upload/ |
上传(批量导入) |
| POST | /upload_files/ |
上传文件 |
| GET | /download/ |
下载 / 导出 |
| POST·DELETE | /favorite/<pk> |
收藏 / 取消收藏 |
2. 资源路由表(各 route_base,已核对)
| 业务域 | route_base |
|---|---|
| 任务流 | /pipeline_modelview/api,另有 /pipeline_modelview/home/api |
| 任务 / 运行记录 / workflow | /task_modelview/api、/runhistory_modelview/api、/workflow_modelview/api |
| 任务模板 / 镜像 / 仓库 / 在线构建 | /job_template_modelview/api、/images_modelview/api、/repository_modelview/api、/docker_modelview/api |
| Notebook | /notebook_modelview/api,SDK:/notebook_modelview/sdk |
| 在线服务 / 推理服务 | /service_modelview/api、/inferenceservice_modelview/api |
| 数据集 | /dataset_modelview/api |
| AIHub 模型市场 | /model_market/visual/api、/voice/api、/language/api、/multimodal/api、/aigc/api、/all/api(均在 /model_market/<type>/api) |
| 对话 / LLM 网关 | /aitalk_modelview/api(Chat)、/llm/api(Ingress) |
| ETL | /etl_pipeline_modelview/api、/etl_pipeline_run_modelview/api、/etl_task_modelview/api |
| 超参搜索 | /nni_modelview/api |
| 训练模型 | /training_model_modelview/api,另有 /training_model_modelview/web/api |
| 元数据 / 指标 / 维表 | /metadata_table_modelview/api、/metadata_metric_modelview/api、/dimension_table_modelview/api(另有 /dimension_remote_table_modelview) |
| 资源 节点 / 存储 / Pod / 全局资源 | /node_modelview/api、/storage_modelview/api、/pod_modelview/api、/total_resource/api |
| 项目组 / 成员 | /project_modelview/api(另有 /project_modelview/job_template/api、/project_modelview/org/api)、/project_user_modelview/api |
| 用户 / 角色 | /users/api、/userinfo/api、/roles/api |
| 审批 / 账单 / 发票 / 消息 / 日志 | /approval_modelview/api、/bill_modelview/api、/invoice_modelview/api、/message_modelview/api、/log_modelview/api |
| 算力租赁 | /rental_instance_modelview/api |
| 仪表盘 | /dashboard/api |
注意:
service_pipeline_modelview/api(view_service_pipeline.py)与model_define_modelview/api(view_model_define.py)的视图在myapp/views/__init__.py:27,48中被注释未 import(# from . import view_service_pipeline、# from . import view_model_define),其appbuilder.add_api(...)仅在模块 import 时执行,因此默认构建下这两个视图未注册、对应 API 不可用。
3. 代表性自定义业务端点(expose_api,最有价值)
任务流 view_pipeline.py(前缀 /pipeline_modelview/api,已核对)
| 方法 | 路径 | description |
|---|---|---|
| GET | /my/list/ |
我的 pipeline 列表 |
| GET | /demo/list/ |
示例 pipeline 列表 |
| GET·POST | /run_pipeline/<pipeline_id> |
运行指定 pipeline |
| GET | /web/<pipeline_id> |
打开任务流编排界面 |
| GET | /web/log/<pipeline_id> |
打开任务流调试跟踪界面 |
| GET | /web/monitoring/<pipeline_id> |
打开任务流资源监控界面 |
| GET | /web/pod/<pipeline_id> |
打开任务流的 pod 界面 |
| GET | /web/runhistory/<pipeline_id> |
打开任务流定时记录界面 |
| GET | /web/workflow/<pipeline_id> |
打开任务流调试跟踪界面 |
| GET·POST | /labelstudio/run_pipeline/<pipeline_id> |
标注后 webhook 触发自动化训练 |
| GET·POST | /copy_pipeline/<pipeline_id> |
复制任务流 |
| POST | /upload/ |
任务流批量上传 |
| GET | /download/ |
任务流批量下载 |
| GET | /download_template/ |
下载上传模板 |
前端导航 home.py(类 Myapp,前缀 /myapp,已核对)
| 路径 | description |
|---|---|
/myapp/navbar_right |
顶部右侧导航按钮 |
/myapp/navbar_left |
左侧平台导航栏 |
/myapp/navbar_bottom |
底部智能助手按钮 |
/myapp/menu |
顶部菜单 / 侧边子菜单(驱动前端动态路由) |
/myapp/feature/check |
每页弹窗接口 |
K8s 资源 view_k8s.py(前缀 /k8s,已核对)
GET /read/log/<cluster_name>/<namespace>/<pod_name>[/<container>[/<tail>]]:读取 pod 日志GET /read/pod/<cluster_name>/<namespace>/<pod_name>、GET /read/pod/yaml/...:pod 信息 / yamlGET /read/pod/terminating[/<namespace>]:查 terminating 卡住的 podDELETE /delete/pod/...、/web/delete/pod/...:强制删除 pod/web/log/...、/web/debug/...:打开 pod 日志 / 命令行界面/web/search/<cluster_name>/<namespace>/<search>:搜索 pod 和服务
登录 view_login.py(多种登录方式,已核对前缀)
各方式独立前缀,常见子路由 GET·POST /(登录入口)、GET /callback(回调)、/logout:
/login/db(数据库密码登录,另有/config/)、/login/oauth2、/login/cas、/login/feishu、/login/wecom、/login/dingtalk、/login/wechat/register(注册),短信验证码POST /send_sms_code
其他高自定义量 view(按 description 摘核心)
- 数据集
view_dataset.py(/dataset_modelview/api):POST /upload/<dataset_id>(上传)、GET /download/<dataset_id>[/<partition>]、/download_archive/<dataset_id>/<path_index>、/preview/dataset/<dataset_id>、/explore/<dataset_id>、/detail/page/<dataset_id>,以及/action/feature_engineering|image_process|train|label_images/<dataset_id>(从数据集创建特征工程/图片处理/训练任务流、进入标注)。 - Notebook
view_notebook.py(/notebook_modelview/api):/entry/jupyter(创建并打开)、/reset/<id>、/renew/<id>(续期)、/stop/<id>、/save/<id>。 - 推理服务
view_inferenceserving.py(/inferenceservice_modelview/api):/clear/<id>、/deploy/debug|test|prod/<id>(部署到调试/测试/生产)、/deploy/update/、/test/<id>。 - 对话
view_chat.py(/aitalk_modelview/api):/chat/<chat_name>(对话智能体)、/models/<chat_name>(可用模型)、/message_feedback/<chat_name>(反馈)、/file/<chat_name>/<file_name>。
4. 非 ModelRestApi 的功能视图
| 视图 | route_base | 作用 |
|---|---|---|
view_blood.py |
/blood |
数据血缘 |
view_k8s.py |
/k8s |
K8s 资源查看 / 日志 / 调试(见上) |
view_labelstudio.py |
/proxy/labelstudio |
LabelStudio 标注反向代理 |
view_sqllab.py |
/idex |
SQL 查询(SQLLab / IDEX) |
view_chat_dingtalk.py |
/dingtalk |
钉钉机器人 webhook |
view_chat_wechat.py |
/wechat |
微信机器人 webhook |
view_chat_wework.py |
/wework |
企业微信机器人 webhook |
本速查为代码派生总览,端点 / 参数以 myapp/views 源码为准,仅供导航。