标准化接口参数详情概览

想知道某个模型(project/pipeline/task/dataset/inferenceservice 等)新增或修改时有哪些字段、类型、默认值、可选值时从这里进

06-二次开发 / API参考 / 标准化接口参数详情
标准化接口参数字段详情新增参数修改参数查看参数add_columnsedit_columns_info模型字段默认值校验choices

标准化接口参数详情

本目录覆盖各标准化 ModelView 的新增 / 修改 / 查看字段(参数名、类型、是否必填、默认值、是否唯一、说明、校验/可选值)。内容由后端 MyappModelRestApi 视图的表单配置(add/edit_form_extra_fieldsadd/show/edit_columns)静态整理而来。

通用说明

  • 新增接口:POST http://x.x.x.x/$view/api/,请求体为 JSON。
  • 修改接口:PUT http://x.x.x.x/$view/api/<id>,请求体为 JSON。
  • 查看接口:GET http://x.x.x.x/$view/api/<id>,返回字段见各模型「查看参数」。
  • 外键字段按标准接口约定使用关系名传参,例如 project,不是 project_id(见 标准化接口/01-通用约定与路径对照)。
  • 「必填」依据数据库 nullable=False、无默认值,以及表单 DataRequired 静态推断。
  • 类型为 computed 的字段通常是模型属性、展示链接或运行时计算字段,不作为新增/修改请求体的普通数据库列。
  • 字段、枚举值、权限和默认值运行时可能受用户、配置或 _info 动态影响,联调请以 $view/api/_info 返回为准。

子文档目录(TOC)

文件 覆盖模型
01-项目与权限.md 项目与权限(分组管理、项目成员管理、用户管理)
02-资源计费与日志.md 资源计费与日志(计量计费、账单管理、报警消息、机器资源、存储资源、日志列表)
03-数据治理.md 数据治理(库表管理、指标管理、维表管理、数据集管理)
04-镜像与notebook.md 镜像与 notebook(仓库管理、docker构建管理、镜像管理、notebook管理)
05-数据开发.md 数据开发(数据开发任务流管理、数据开发任务管理)
06-训练.md 训练(job模板管理、训练pipeline管理、训练task管理、定时调度实例管理、workflow管理、超参搜索管理)
07-模型与服务.md 模型与服务(整体资源、内部服务管理、训练模型管理、推理服务管理)
08-aihub与智能体.md aihub 与智能体(aihub管理、智能体管理)

$view 路径与表名对照见 标准化接口/01-通用约定与路径对照;各视图特殊接口见 接口总览

最后更新 2026-06-30完整文档以官方仓库为准:GitHub Wiki