Appearance
1. 概述
适用版本:DASS5(当前版本)
前提:已安装 DASS 并完成注册登录;已准备可调用 HTTP 接口的工具(如 curl / ApiPost)
依据:本指南逐条对照 DASSConsole 后端实现整理,路径、字段名、类型、枚举与错误码均以实际接口为准。
1.1 本指南能做什么
本指南面向要基于 DASSConsole 做二次开发 / 集成的工程师,目标是让读者用 HTTP(S) 把下面这条核心链路一次跑通,并知道每个环节的约束与坑:
登录 → 建连接 → 建采集服务 → 建通道 → 建测点 → 建上传服务 → 建上传测点 → 启停服务 → 回查验收读完本指南可以获得:
- 一条最小可跑链路:8 个步骤的 curl 示例,每步都有真实请求与响应片段,可直接复制执行。
- 完整接口参考:8 组接口的方法、完整路径、请求字段(字段 / 类型 / 必填 / 说明,含长度与枚举)、响应形态与相关错误码。
- 数据字典:点的类型(RT)、采集点类型(SR)、控制属性(AE)、显示格式(FM)、同步属性(UM)、压缩类型(KZ)、死区类型(DT)、数据状态(DS)等枚举,以及测点表列名与 API 字段的对应关系。
- 必读的坑:按严重程度排序的已知限制,每条写清「现象 / 原因 / 规避方式」。
【注意】本指南面向接口调用方。DASSConsole 前端界面的操作说明见 《使用手册》;本指南中出现的界面路径(如「数据采集 → 采集服务」)只用于帮助把接口动作与界面动作对应起来。
1.2 覆盖范围
| 维度 | 内容 |
|---|---|
| 协议与端口 | HTTPS(httpsAddr: ":8095",配置中无 HTTP 端口) |
| 路径前缀 | /api/mlinkClient |
| 鉴权方式 | gtoken:Authorization: Bearer <token>(WebSocket 用 query token) |
| 覆盖分组 | 用户与登录、连接管理、采集服务、采集通道、采集测点、上传服务与上传测点、应用包管理、实时库与数据查询 |
| 不在范围 | 网络管理、OTA 升级全量接口、备份恢复全量接口、数据镜像、计算点/计算模型、控制管理、STOMP 帧细节,以及 caict / cloud / industry 组 |
接口参考的编排约定:4.1 ~ 4.8 中,核心链路接口给出完整字段表、请求与响应示例;次要接口给出字段表与响应结构说明,不再重复罗列示例,以免掩盖关键信息。
【警告】登录密码必须传
md5(明文)的小写 hex;传明文会报「账号或密码错误」。
帮助中心