标准化接口-通用约定与 $view 路径对照表

调标准接口前先看清 token 怎么传、响应格式、外键字段怎么传参,以及某功能对应哪个 $view 路径/表名

06-二次开发 / API参考 / 标准化接口
通用约定请求头HeaderAuthorizationtoken响应格式status外键传参relation路径对照viewroute_base表名

通用约定与 $view 路径对照表

请求 Header

Content-Type: application/json
Authorization: $token

token 获取方式:登录平台后在个人信息页面复制。

Python 客户端中 Authorization 也可使用 $username|$token 形式,见 05-Python客户端示例.md

通用响应格式

{
  "status": 0,
  "message": "success",
  "result": {}
}
  • status:0 成功,非 0 失败
  • message:提示信息
  • result:具体数据

注意:favorite 接口的 status 返回的是字符串 "success"/"fail" 而非数字,见 03-操作图表收藏.md

外键字段传参规则

对于外键列(例如 a 对象通过 b_id 绑定 b 对象),传参和返回均使用关系名而非字段名:

POST/PUT 传参:{"b": "$b_id"}    (不是 {"b_id": "$b_id"})
GET 返回:    {"b": {"b_name": "xxx", "b_id": 1}}

$view 路径对照表

说明 路径 表名
分组管理 /project_modelview/api project
项目成员管理 /project_user_modelview/api project_user
用户管理 /users/api ab_user
计量计费 /pod_modelview/api pod
账单管理 /bill_modelview/api bill
报警消息 /message_modelview/api message
机器资源 /node_modelview/api node
存储资源 /storage_modelview/api storage
日志列表 /log_modelview/api logs
库表管理 /metadata_table_modelview/api metadata_table
指标管理 /metadata_metric_modelview/api metadata_metric
维表管理 /dimension_table_modelview/api dimension
数据集管理 /dataset_modelview/api dataset
仓库管理 /repository_modelview/api repository
docker 构建管理 /docker_modelview/api docker
镜像管理 /images_modelview/api images
notebook 管理 /notebook_modelview/api notebook
数据开发任务流管理 /etl_pipeline_modelview/api etl_pipeline
数据开发任务管理 /etl_task_modelview/api etl_task
job 模板管理 /job_template_modelview/api job_template
训练 pipeline 管理 /pipeline_modelview/api pipeline
训练 task 管理 /task_modelview/api task
定时调度实例管理 /runhistory_modelview/api runhistory
workflow 管理 /workflow_modelview/api workflow
超参搜索管理 /nni_modelview/api nni
整体资源 /total_resource/api
内部服务管理 /service_modelview/api service
训练模型管理 /training_model_modelview/api model
推理服务管理 /inferenceservice_modelview/api inferenceservice
aihub 管理 /model_market/{类别}/api aihub
智能体管理 /aitalk_modelview/api chat

⚠️ 已按代码改正:原文档 aihub 管理路径写作 /aihub_modelview/api,但实际 myapp/views/view_aihub.py:1223-1319route_base/model_market/visual|voice|language|multimodal|aigc|all/api(无 /aihub_modelview/api),模型表名 aihubmyapp/models/model_aihub.py:18)。智能体管理路径 /aitalk_modelview/api、表名 chat 均与代码一致(myapp/views/view_chat.py:169myapp/models/model_chat.py:21)。

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