HTTP REST 服务用于 外部应用需要通过简单 JSON 请求读取 Darra PLC 状态或过程映像时。项目部署后,Darra 被动监听 HTTP 8080。
本服务不是 MES 接口,也不是远程管理。真 MES / SCADA 读过程数据走 OPC UA;工程远程管理走 HTTPS 18443。本页不提供 PLC 启停控制。
当前状态
| 项目 | 实际行为 |
|---|
| 工程服务类型 | HttpRestServer |
| 默认端口 | HTTP 8080 |
| 基础路径 | 固定 /api |
| 数据格式 | JSON |
| 项目服务绑定 | 当前只绑定运行中的 IO 映像 |
| 读取认证 | 当前项目服务未注入读取凭据,读取端点可直接访问 |
| 写入认证 | 当前项目服务未注入写入凭据,所有 PUT/POST 写操作返回 401 |
| PLC 启停 | 两个程序控制端点固定返回 501 |
界面会保存基础路径 /api/plc、要求 HTTPS true 和最大连接数 32。当前项目服务启动路径尚未应用这三个值;实际监听仍为 http://<设备地址>:8080/,路由仍以 /api 开头。
生效参数
| 参数 | 类型 | 默认值 | 说明 |
|---|
| 服务名 | string | HTTP REST API | 工程内实例名称 |
| 启用 | bool | true | 随项目部署启动 |
| 监听端口 | int | 8080 | HTTP 监听端口 |
| 地址映射 | 列表 | 空 | 当前 HTTP 路径不消费协议映射;保持为空以便绑定 IO 映像 |
全部 API
以下表格列出当前服务实际注册的全部路由,不需要跳转到其他索引。这些路由提供 L1-L2 过程数据查询,不提供工单、OEE 或物料追溯。
系统与诊断
| 方法 | 路径 | 结果 | 当前项目服务可用性 |
|---|
| OPTIONS | 任意路径 | CORS 预检,返回 204 | 可用 |
| GET | /api/health | 服务状态、时间、运行时长、端口 | 可用,无需认证 |
| GET | /api/status | PLC、变量、报警和 HTTP 摘要 | 可用;未绑定模块显示默认值 |
| GET | /api/diagnostics | 进程、监听和模块绑定状态 | 可用 |
| GET | /api/program/state | PLC 与运动控制状态摘要 | 可用;未绑定模块显示默认值 |
| GET | /api/plc/metrics | PLC 扫描统计 | 当前返回“PLC 引擎未初始化” |
| POST | /api/program/start | PLC 启动请求 | 固定返回 501,不执行 |
| POST | /api/program/stop | PLC 停止请求 | 固定返回 501,不执行 |
| 方法 | 路径 | 结果 | 当前项目服务可用性 |
|---|
| GET | /api/variables | 变量列表 | 当前返回“变量表未绑定” |
| GET | /api/variables/{name} | 单个变量 | 当前返回“变量表未绑定” |
| PUT | /api/variables/{name} | 写变量 | 当前返回 401,不执行 |
IO 与 M 区
| 方法 | 路径 | 结果 | 当前项目服务可用性 |
|---|
| GET | /api/io/di | 数字输入列表 | 当前返回“IO 管理器未绑定” |
| GET | /api/io/do | 数字输出列表 | 当前返回“IO 管理器未绑定” |
| GET | /api/io/ai | 模拟输入列表 | 当前返回“IO 管理器未绑定” |
| GET | /api/io/ao | 模拟输出列表 | 当前返回“IO 管理器未绑定” |
| GET | /api/io/all | 四类 IO 列表 | 当前各分组返回未绑定说明 |
| GET | /api/io/snapshot | DI、DO、AI、AO 完整快照 | IO 映像首次同步后可用 |
| GET | /api/io/di/{index} | 单个数字输入 | IO 映像首次同步后可用 |
| GET | /api/io/do/{index} | 单个数字输出 | IO 映像首次同步后可用 |
| GET | /api/io/ai/{index} | 单个模拟输入 | IO 映像首次同步后可用 |
| PUT | /api/io/di/{index} | 写数字输入 | 当前返回 401,不执行 |
| PUT | /api/io/do/{index} | 写数字输出 | 当前返回 401,不执行 |
| GET | /api/m/{address} | 读取 MB、MW、MD 或位地址 | IO 映像首次同步后可用 |
| PUT | /api/m/{address} | 写 M 区 | 当前返回 401,不执行 |
报警与运动状态
| 方法 | 路径 | 结果 | 当前项目服务可用性 |
|---|
| GET | /api/alarms | 活跃报警列表 | 当前返回“报警管理器未绑定” |
| POST | /api/alarms/{id}/ack | 确认报警 | 当前返回 401,不执行 |
| GET | /api/robot/status | 运动控制状态 | 当前返回“控制器未绑定” |
| GET | /api/robot/joints | 关节位置 | 当前返回“控制器未绑定” |
静态文件
| 方法 | 路径 | 结果 | 当前项目服务可用性 |
|---|
| GET | /web/{filename} | 返回随服务部署的静态文件 | 文件存在时可用,否则 404 |
| GET | /web | 返回默认 index.html | 文件存在时可用,否则 404 |
| GET | / | 返回默认 index.html | 文件存在时可用,否则 404 |
响应约定
| 状态码 | 含义 |
|---|
| 200 | 路由已处理;业务不可用时可能在 JSON 中返回 error |
| 204 | OPTIONS 预检成功 |
| 304 | ETag 命中,内容未变化 |
| 401 | 写入未获准或凭据无效 |
| 404 | 路由或静态文件不存在 |
| 500 | 请求处理异常 |
| 501 | HTTP 面不提供 PLC 启停 |
成功响应直接返回数据对象;错误响应使用 error 字段。GET 成功响应支持 ETag,较大的 JSON 响应支持 gzip。
使用步骤
- 添加“HTTP REST API”服务并保持端口 8080。
- 部署项目,先请求
/api/health 确认监听正常。
- 等待一次过程映像同步后,请求
/api/io/snapshot。
- 需要变量、报警或扫描统计时,先确认目标端点在上表中已接入;不要把“未绑定”响应当作空数据。
- PLC 启停和工程控制使用产品主控制通道 HTTPS
18443,不通过本服务执行。MES 读数使用 OPC UA 4840。