API 接口总览

想快速查"某个功能/模块对应哪个接口路由前缀、有哪些非标准CRUD的特殊接口"时读这篇

06-二次开发 / API参考
API接口列表路由前缀route_base特殊接口RESTCRUDMyappModelRestApi视图viewendpoint接口总览接口索引

API 接口总览

本页是平台全部视图的接口扁平索引:先给出所有视图共有的标准 CRUD 路径,再按视图逐个列出各自的特殊接口(非标准 CRUD)。用于"按功能模块快速定位接口路由前缀"。

  • 标准 CRUD 接口的请求/响应细节见 标准化接口
  • 各模型新增/修改/查看字段见 标准化接口参数详情
  • 路由前缀(route_base)均定义在对应 myapp/views/view_*.py 中。

标准 CRUD 接口(所有继承 MyappModelRestApi 的视图自动拥有)

完整 URL = 路由前缀 + 下列路径。

方法 路径 说明
GET /_info 获取模型元信息(字段、过滤器、权限等)
GET / 列表查询(支持分页、过滤、排序)
GET /<int:pk> 获取单条记录
POST / 新增记录
PUT /<int:pk> 更新记录
DELETE /<int:pk> 删除记录
GET /action/<name>/<int:pk> 单条记录执行 action
POST /multi_action/<name> 批量执行 action
GET /echart 图表数据
POST /upload/ 批量上传/导入(CSV/JSON)
POST /upload_files/ 通用分块文件上传
GET /download/ 批量下载/导出
GET /download_template/ 下载上传模板
POST / DELETE /favorite/<pk> 收藏 / 取消收藏(POST 收藏,DELETE 取消)

以上路由均在 myapp/views/baseApi.py 中通过 @expose 定义(_info 行 991、列表行 1150、新增行 1366、更新行 1440、删除行 1538、action 行 1578、multi_action 行 1609、download_template 行 1640、echart 行 1656、upload 行 1684、upload_files 行 1776、download 行 1827、favorite 行 1893)。

以下仅列出各视图的特殊接口。


home(首页/导航)

  • 代码文件:myapp/views/home.py
  • 路由前缀:/myapp
特殊接口 说明
/myapp/navbar_right 顶部右侧导航按钮
/myapp/navbar_left 左侧平台导航栏
/myapp/navbar_bottom 底部智能助手按钮
/myapp/menu 顶部菜单/侧边子菜单
/myapp/feature/check 每一页的弹窗接口

用户与角色

  • 代码文件:myapp/views/view_user_role.py
  • 路由前缀:/users/api(用户管理)、/userinfo/api(个人信息)、/roles/api(角色管理)
特殊接口 说明
/userinfo/api/current/userinfo 个人信息查看与编辑

项目组(团队)

  • 代码文件:myapp/views/view_team.py
  • 路由前缀:/project_modelview/api(项目组管理)、/project_user_modelview/api(项目组成员管理)、/project_modelview/job_template/api(项目组任务模板管理)、/project_modelview/org/api(项目组组织架构管理)
特殊接口 说明
/project_modelview/api/my/project 我有权限的项目组

审批

  • 代码文件:myapp/views/view_approval.py
  • 路由前缀:/approval_modelview/api
特殊接口 说明
/approval_modelview/api/approve/<int:approval_id> 审批:同意或拒绝
/approval_modelview/api/cancel/<int:approval_id> 审批:申请人撤销
/approval_modelview/api/my_pending 审批:待我审批列表
/approval_modelview/api/apply_quota/<int:project_id> 申请资源提额

镜像仓库与镜像

  • 代码文件:myapp/views/view_images.py
  • 路由前缀:/repository_modelview/api(镜像仓库管理)、/images_modelview/api(镜像管理)
特殊接口 说明
/images_modelview/api/build/<image_id> 镜像在线构建

Notebook(在线 IDE)

  • 代码文件:myapp/views/view_notebook.py
  • 路由前缀:/notebook_modelview/api(在线 IDE 管理)、/notebook_modelview/sdk(在线 IDE SDK 接口)
特殊接口 说明
/notebook_modelview/api/entry/jupyter 创建打开 jupyter
/notebook_modelview/api/reset/<notebook_id> 重置在线 IDE
/notebook_modelview/api/renew/<notebook_id> 在线 IDE 续期
/notebook_modelview/api/stop/<notebook_id> 停止在线 IDE
/notebook_modelview/api/save/<notebook_id> 保存在线 IDE

Docker 在线构建调试

  • 代码文件:myapp/views/view_docker.py
  • 路由前缀:/docker_modelview/api
特殊接口 说明
/docker_modelview/api/debug/<docker_id> 容器 debug
/docker_modelview/api/delete_pod/<docker_id> 清理在线调试镜像
/docker_modelview/api/save/<docker_id> 保存在线调试镜像
/docker_modelview/api/entry/docker 创建在线调试镜像

Job 模板

  • 代码文件:myapp/views/view_job_template.py
  • 路由前缀:/job_template_modelview/api(任务模板管理,仅标准 CRUD)

Pipeline(ML 任务流)

  • 代码文件:myapp/views/view_pipeline.py
  • 路由前缀:/pipeline_modelview/api(ML 任务流管理)、/pipeline_modelview/home/api(首页任务流展示)
特殊接口 说明
/pipeline_modelview/api/my/list/ 我的 pipeline 列表
/pipeline_modelview/api/demo/list/ 示例 pipeline 列表
/pipeline_modelview/api/run_pipeline/<pipeline_id> 运行指定 pipeline
/pipeline_modelview/api/web/<pipeline_id> 打开任务流编排界面
/pipeline_modelview/api/web/log/<pipeline_id> 打开任务流调试跟踪界面
/pipeline_modelview/api/web/monitoring/<pipeline_id> 打开任务流资源监控界面
/pipeline_modelview/api/web/pod/<pipeline_id> 打开任务流的 pod 界面
/pipeline_modelview/api/web/runhistory/<pipeline_id> 打开任务流的定时记录界面
/pipeline_modelview/api/web/workflow/<pipeline_id> 打开任务流的调试跟踪界面
/pipeline_modelview/api/labelstudio/run_pipeline/<pipeline_id> labelstudio 标注后 webhook 触发自动化训练
/pipeline_modelview/api/copy_pipeline/<pipeline_id> 复制任务流
/pipeline_modelview/api/upload/ 任务流的批量上传
/pipeline_modelview/api/download/ 任务流的批量下载
/pipeline_modelview/api/download_template/ 下载任务流的上传模板

固化任务流

  • 代码文件:myapp/views/view_pipeline_immutable.py
  • 路由前缀:/pipeline_immutable_modelview(固化任务流管理,动态注册 route_base)
特殊接口 说明
/pipeline_immutable_modelview/ 新增固化任务流
/pipeline_immutable_modelview/<int:pk> 查看/更新固化任务流
/pipeline_immutable_modelview/<pipeline_id>/api/_info 获取固化任务流子任务的元信息
/pipeline_immutable_modelview/<pipeline_id>/api/ 固化任务流子任务列表 / 新增
/pipeline_immutable_modelview/<pipeline_id>/api/<int:pk> 查看固化任务流子任务
/pipeline_immutable_modelview/<pipeline_id>/api/<pk> 更新/删除固化任务流子任务

Task(任务)

  • 代码文件:myapp/views/view_task.py
  • 路由前缀:/task_modelview/api
特殊接口 说明
/task_modelview/api/debug/<task_id> 单个任务 debug
/task_modelview/api/run/<task_id> 单个任务 run
/task_modelview/api/clear/<task_id> 单个任务 clear
/task_modelview/api/log/<task_id> 单个任务查看日志

Workflow(运行实例)

  • 代码文件:myapp/views/view_workflow.py
  • 路由前缀:/workflow_modelview/api
特殊接口 说明
/workflow_modelview/api/pause/<crd_id> 暂停 workflow
/workflow_modelview/api/recover/<crd_id> 恢复 workflow
/workflow_modelview/api/stop/<crd_id> 停止 workflow
/workflow_modelview/api/web/log/<cluster_name>/<namespace>/<workflow_name>/<pod_name> workflow 的执行进度
/workflow_modelview/api/web/log_node/<cluster_name>/<namespace>/<workflow_name>/<pod_name> workflow 的执行进度
/workflow_modelview/api/web/log/<cluster_name>/<namespace>/<workflow_name>/<pod_name>/<file_name> workflow 的执行进度
/workflow_modelview/api/web/node_detail/<cluster_name>/<namespace>/<workflow_name>/<node_name> 任务实例的信息
/workflow_modelview/api/web/dag/<cluster_name>/<namespace>/<workflow_name> 任务流实例的信息
/workflow_modelview/api/web/layout/<cluster_name>/<namespace>/<workflow_name> workflow 实例运行进度

定时调度运行历史

  • 代码文件:myapp/views/view_runhistory.py
  • 路由前缀:/runhistory_modelview/api(任务流运行历史,仅标准 CRUD)

NNI(超参搜索)

  • 代码文件:myapp/views/view_nni.py
  • 路由前缀:/nni_modelview/api
特殊接口 说明
/nni_modelview/api/stop/<nni_id> 停止超参搜索
/nni_modelview/api/run/<nni_id> 启动超参搜索
/nni_modelview/api/log/<nni_id> 查看超参搜索 pod 日志
/nni_modelview/api/web/<nni_id> 查看超参搜索运行界面

ETL 数据开发任务流

  • 代码文件:myapp/views/view_etl_pipeline.py
  • 路由前缀:/etl_task_modelview/api(ETL 任务管理)、/etl_pipeline_modelview/api(ETL 任务流管理)
特殊接口 说明
/etl_pipeline_modelview/api/config/<etl_pipeline_id> 获取 pipeline 配置信息
/etl_pipeline_modelview/api/template/list/ etl 的模板列表
/etl_pipeline_modelview/api/template/list/<etl_pipeline_id> etl 的某个任务流的模板列表
/etl_pipeline_modelview/api/submit_etl_pipeline/<etl_pipeline_id> 提交 etl 任务
/etl_pipeline_modelview/api/web/<etl_pipeline_id> etl 编排界面
/etl_pipeline_modelview/api/download/ 任务流的批量下载
/etl_pipeline_modelview/api/download/<int:etl_pipeline_id> 单个任务流的下载
/etl_pipeline_modelview/api/upload/ 任务流的批量上传
/etl_pipeline_modelview/api/download_template/ 下载任务流的上传模板

ETL 任务流运行实例

  • 代码文件:myapp/views/view_etl_pipeline_run.py
  • 路由前缀:/etl_pipeline_run_modelview/api(ETL 任务流运行实例)
特殊接口 说明
/etl_pipeline_run_modelview/api/<run_id>/alerts run 平台告警列表
/etl_pipeline_run_modelview/api/<run_id>/preview run 全节点预览汇总
/etl_pipeline_run_modelview/api/<run_id>/preview/<task_id> 单节点预览
/etl_pipeline_run_modelview/api/preview_latest/<int:pipeline_id>/<task_id> 查看最近一次运行的某节点预览
/etl_pipeline_run_modelview/api/<run_id>/log run 主日志
/etl_pipeline_run_modelview/api/<run_id>/stop 停止 run
/etl_pipeline_run_modelview/api/<run_id>/status run 当前状态

服务化任务流

  • 代码文件:myapp/views/view_service_pipeline.py
  • 路由前缀:/service_pipeline_modelview/api(服务化任务流管理)
特殊接口 说明
/service_pipeline_modelview/api/my/list/ 我的服务化任务流列表
/service_pipeline_modelview/api/run_service_pipeline/<service_pipeline_id> 运行服务化任务流
/service_pipeline_modelview/api/web/<service_pipeline_id> 打开服务化任务流编排界面
/service_pipeline_modelview/api/web/log/<service_pipeline_id> 打开服务化任务流日志界面
/service_pipeline_modelview/api/web/monitoring/<service_pipeline_id> 打开服务化任务流监控界面
/service_pipeline_modelview/api/web/pod/<service_pipeline_id> 打开服务化任务流 pod 界面
/service_pipeline_modelview/api/clear/<service_id> 清理服务化任务流
/service_pipeline_modelview/api/config/<service_pipeline_id> 获取服务化任务流配置
/service_pipeline_modelview/api/template/list/ 服务化任务流模板列表

模型定义

  • 代码文件:myapp/views/view_model_define.py
  • 路由前缀:/model_define_modelview/api(模型定义管理)
特殊接口 说明
/model_define_modelview/api/config/<model_define_id> 获取模型定义的配置信息
/model_define_modelview/api/template/list/ 模型定义模板列表
/model_define_modelview/api/template/list/<model_define_id> 指定模型定义的模板列表
/model_define_modelview/api/submit_model_define/<model_define_id> 提交模型定义
/model_define_modelview/api/web/<model_define_id> 打开模型定义编排界面

训练模型管理

  • 代码文件:myapp/views/view_train_model.py
  • 路由前缀:/training_model_modelview/web/api(训练模型-页面接口)、/training_model_modelview/api(训练模型-通用接口)
特殊接口 说明
/training_model_modelview/web/api/download/<model_id> 下载模型
/training_model_modelview/web/api/deploy/<model_id> 部署模型
/training_model_modelview/web/api/metric/<model_id> 获取模型指标

推理服务

  • 代码文件:myapp/views/view_inferenceserving.py
  • 路由前缀:/inferenceservice_modelview/api
特殊接口 说明
/inferenceservice_modelview/api/clear/<service_id> 清理推理服务
/inferenceservice_modelview/api/deploy/debug/<service_id> 部署推理服务调试环境
/inferenceservice_modelview/api/deploy/test/<service_id> 部署推理服务测试环境
/inferenceservice_modelview/api/deploy/prod/<service_id> 部署推理服务生产环境
/inferenceservice_modelview/api/deploy/update/ 推理服务升级
/inferenceservice_modelview/api/test/<service_id> 推理服务测试

内部服务

  • 代码文件:myapp/views/view_serving.py
  • 路由前缀:/service_modelview/api
特殊接口 说明
/service_modelview/api/clear/<service_id> 清理内部服务
/service_modelview/api/deploy/<service_id> 部署内部服务

AIHub(模型市场)

  • 代码文件:myapp/views/view_aihub.py
  • 路由前缀:/model_market/visual/api(视觉)、/model_market/voice/api(语音)、/model_market/language/api(语言)、/model_market/multimodal/api(多模态)、/model_market/aigc/api(AIGC)、/model_market/all/api(全部)

各类别共用一套接口,下表 {类别}visual / voice / language / multimodal / aigc / all

特殊接口 说明
/model_market/{类别}/api/notebook/<aihub_id> aihub 一键开发
/model_market/{类别}/api/train/<aihub_id> aihub 应用一键微调
/model_market/{类别}/api/service/delete/<aihub_id> aihub 应用卸载 web
/model_market/{类别}/api/service/<aihub_id> aihub 应用部署 web
/model_market/{类别}/api/web/<aihub_id> 打开 aihub 应用体验界面

智能体对话(站内)

  • 代码文件:myapp/views/view_chat.py
  • 路由前缀:/aitalk_modelview/api
特殊接口 说明
/aitalk_modelview/api/chat/<chat_name> 对话智能体
/aitalk_modelview/api/models/<chat_name> 可用模型查询
/aitalk_modelview/api/message_feedback/<chat_name> 对话反馈
/aitalk_modelview/api/file/<chat_name>/<file_name> 对话文件上传/下载

智能体对话(钉钉/微信/企微)

  • 钉钉:myapp/views/view_chat_dingtalk.py,前缀 /dingtalk
    • /dingtalk/chatgpt/<chat_name>,钉钉机器人对话入口
  • 微信公众号:myapp/views/view_chat_wechat.py,前缀 /wechat
    • /wechat/token,微信公众号 token 验证
    • /wechat/jsapi,微信 JSAPI 签名
    • /wechat/chatgpt/<chat_name>,微信公众号对话入口
  • 企业微信:myapp/views/view_chat_wework.py,前缀 /wework
    • /wework/chatgpt/<chat_name>,企业微信对话入口

LLM 网关

  • 代码文件:myapp/views/view_llm_ingress.py
  • 路由前缀:/llm/api
特殊接口 说明
/llm/api/<ingress_id>/v1/models 网关服务,大模型列表接口
/llm/api/<ingress_id>/v1/models/<model> 网关服务,大模型详情接口
/llm/api/<ingress_id>/v1/embeddings 网关服务,大模型向量化接口
/llm/api/<ingress_id>/v1/completions 网关服务,大模型补全接口
/llm/api/<ingress_id>/v1/chat/completions 网关服务,大模型对话接口
/llm/api/test/<ingress_id> 网关测试弹窗
/llm/api/monitoring/<ingress_id> 网关服务,指标监控弹窗

数据集

  • 代码文件:myapp/views/view_dataset.py
  • 路由前缀:/dataset_modelview/api
特殊接口 说明
/dataset_modelview/api/upload/<dataset_id> 上传数据集(view_dataset.py:366
/dataset_modelview/api/download_file/<dataset_id> 数据集下载(多文件打包下载,path 与 download_url 合并处理,view_dataset.py:427
/dataset_modelview/api/download_archive/<dataset_id>/<path_index> 下载数据集目录归档(view_dataset.py:462
/dataset_modelview/api/download/<dataset_id> 下载指定数据集(view_dataset.py:481
/dataset_modelview/api/download/<dataset_id>/<partition> 下载指定数据集指定分片(view_dataset.py:482
/dataset_modelview/api/action/feature_engineering/<dataset_id> 特征工程(view_dataset.py:837
/dataset_modelview/api/action/image_process/<dataset_id> 图像处理(view_dataset.py:864
/dataset_modelview/api/action/train/<dataset_id> 训练(view_dataset.py:873
/dataset_modelview/api/action/label_images/<dataset_id> 图像标注(view_dataset.py:880
/dataset_modelview/api/detail/page/<dataset_id> 数据集详情页(view_dataset.py:896
/dataset_modelview/api/preview/dataset/<dataset_id> 预览指定数据集(view_dataset.py:1168
/dataset_modelview/api/explore/<dataset_id> 探索数据集(view_dataset.py:1255

⚠️ 已按代码改正:原文档列出的 /alert/info/<dataset_id> 以及按名称预览的 /preview/<dataset_name>/preview/<dataset_name>/<dataset_version>/preview/<dataset_name>/<dataset_version>/<dataset_segment> 在当前 myapp/views/view_dataset.py 中已不存在(grep 未命中),故移除;同时补充了代码中新增的 download_archive、若干 action/*detail/page 接口。

维表

  • 代码文件:myapp/views/view_dimension.py
  • 路由前缀:/dimension_table_modelview/api(维表管理)
特殊接口 说明
/dimension_table_modelview/api/clear/<dim_id> 清空维表数据
/dimension_table_modelview/api/create_remote_table/<dim_id> 更新远程表
/dimension_table_modelview/api/upload/ 批量上传维表数据
  • 路由前缀:/dimension_remote_table_modelview(远程维表管理,按维表 ID 分组)
特殊接口 说明
/dimension_remote_table_modelview/<dim_id>/api/_info 获取远程维表元信息
/dimension_remote_table_modelview/<dim_id>/api/ 远程维表列表查询 (GET) / 新增 (POST)
/dimension_remote_table_modelview/<dim_id>/api/<int:pk> 获取远程维表单条记录
/dimension_remote_table_modelview/<dim_id>/api/<pk> 更新 (PUT) / 删除 (DELETE) 远程维表记录
/dimension_remote_table_modelview/<dim_id>/api/upload/ 维表批量上传
/dimension_remote_table_modelview/<dim_id>/api/download_template 下载维表批量上传模板
/dimension_remote_table_modelview/<dim_id>/api/download_template/ 下载维表批量上传模板
/dimension_remote_table_modelview/<dim_id>/api/download/ 维表批量下载
/dimension_remote_table_modelview/<dim_id>/api/multi_action/<string:name> 维表批量操作

元数据库表 / 指标

  • 库表:myapp/views/view_metadata.py,前缀 /metadata_table_modelview/api(仅标准 CRUD)
  • 指标:myapp/views/view_metadata_metric.py,前缀 /metadata_metric_modelview/api(仅标准 CRUD)

血缘

  • 代码文件:myapp/views/view_blood.py
  • 路由前缀:/blood
特殊接口 说明
/blood/search/node 血缘搜索接口
/blood/search/name 血缘节点名称搜索(自动补全)
/blood/show/<node_id> 血缘关系单个节点的详情

LabelStudio 自动化标注

  • 代码文件:myapp/views/view_labelstudio.py
  • 路由前缀:/proxy/labelstudio
特殊接口 说明
/proxy/labelstudio/<field>/<model_type>/health 自动化标注固定接口
/proxy/labelstudio/<field>/<model_type>/setup 自动化标注固定接口
/proxy/labelstudio/<field>/<model_type>/train 自动化标注固定接口
/proxy/labelstudio/<field>/<model_type>/webhook 自动化标注固定接口
/proxy/labelstudio/<field>/<model_type>/delete 自动化标注固定接口
/proxy/labelstudio/<field>/<model_type>/predict 自动化标注预测接口

SQLLab(idex)

  • 代码文件:myapp/views/view_sqllab.py
  • 路由前缀:/idex
特殊接口 说明
/idex/config sqllab 的引擎参数配置
/idex/submit_task 提交 sql 查询任务
/idex/look/<task_id> 获取 sqllab 任务状态
/idex/result/<task_id> 获取 sqllab 结果
/idex/download_url/<task_id> 下载 sqllab 结果
/idex/stop/<task_id> 终止 sqllab 任务

消息

  • 代码文件:myapp/views/view_message.py
  • 路由前缀:/message_modelview/api
特殊接口 说明
/message_modelview/api/<client>/webhook 接收消息的 webhook 接口

K8s

  • 代码文件:myapp/views/view_k8s.py
  • 路由前缀:/k8s
特殊接口 说明
/k8s/read/log/<cluster_name>/<namespace>/<pod_name> 返回获取 pod 日志
/k8s/read/log/<cluster_name>/<namespace>/<pod_name>/<container> 返回获取 pod 日志
/k8s/read/log/<cluster_name>/<namespace>/<pod_name>/<container>/<tail> 返回获取 pod 日志
/k8s/read/pod/<cluster_name>/<namespace>/<pod_name> 返回获取 pod 的信息
/k8s/read/pod/yaml/<cluster_name>/<namespace>/<pod_name> 返回获取 pod 的 YAML 信息
/k8s/read/pod/terminating 返回获取 terminating 不掉的 pod 的信息
/k8s/read/pod/terminating/<namespace> 返回获取 terminating 不掉的 pod 的信息
/k8s/web/delete/pod/<cluster_name>/<namespace>/<pod_name> 强制删除 pod 的信息
/k8s/delete/pod/<cluster_name>/<namespace>/<pod_name> 强制删除 pod 的信息
/k8s/web/log/<cluster_name>/<namespace>/<pod_name> 打开 pod 日志界面
/k8s/web/log/<cluster_name>/<namespace>/<pod_name>/<container_name> 打开 pod 日志界面
/k8s/web/debug/<cluster_name>/<namespace>/<pod_name> 打开 pod 命令行界面
/k8s/web/debug/<cluster_name>/<namespace>/<pod_name>/<container_name> 打开 pod 命令行界面
/k8s/web/search/<cluster_name>/<namespace>/<search> 搜索 pod 和服务

仪表盘

  • 代码文件:myapp/views/view_dashboard.py
  • 路由前缀:/dashboard/api
特殊接口 说明
/dashboard/api/layout 获取仪表盘布局
/dashboard/api/widget/<string:widget_id> 获取仪表盘组件数据

账单 / 发票

  • 账单:myapp/views/view_bill.py,前缀 /bill_modelview/api
    • /bill_modelview/api/detail/<bill_id>,账单详情接口
  • 发票:myapp/views/view_invoice.py,前缀 /invoice_modelview/api(仅标准 CRUD)

整体资源

  • 代码文件:myapp/views/view_total_resource.py
  • 路由前缀:/total_resource/api
特殊接口 说明
/total_resource/api/data 暴露监控数据

资源对象(仅标准 CRUD)

模块 代码文件 路由前缀
Pod 管理(计量计费) myapp/views/view_pod.py /pod_modelview/api
节点资源管理 myapp/views/view_resource_node.py /node_modelview/api
存储资源管理 myapp/views/view_resource_storage.py /storage_modelview/api
操作日志 myapp/views/view_log.py /log_modelview/api
最后更新 2026-06-30完整文档以官方仓库为准:GitHub Wiki