跳转到内容

云控开放API

获取任务信息接口

POST : 云控地址/openapi/getTask 例如: http://192.168.1.182:8099/openapi/getTask Content-Type: application/json

{
  "dataSecret": "后台配置的API云控通信密钥"
  // 配置在config.toml文件中的appkey选项，默认是 test123
}
  • 返回数据:
[
  {
    "cacheScript": 1,
    "delaySecond": 0,
    "execNumber": 9999,
    "cronText": "* * * * * ?",
    "deviceNos": "006,001,003x,test222", // 任务执行设备
    "downloadUrl": "http://192.168.2.7:8098/pub_upload/2022-10-07/cnfdy1l2biiwpl8qcm.iec",
    "execType": 1,
    "scheduleTime": null,
    "scheduleType": 0,
    "execStatus": 1,
    "endTime": null,
    "scriptId": 16,
    "scriptMd5": "b7ec603dffd9527c98e505bdd0eea137",
    "scriptName": "html5",
    "scriptVersion": "1",
    "sort": 1,
    "taskId": 11, // 任务的ID 一般只关心这个即可
    "taskName": "23", // 任务名称
    "tenantId": 1, // 租户的id
    // 参数配置
    "valueConfig": "[{\"id\":3,\"key\":\"我是多选框\",\"options\":[\"111\",\"2222\",\"333\"],\"type\":\"3\",\"value\":[\"111\",\"222\",\"333\"]},{\"id\":2,\"type\":\"2\",\"key\":\"b\",\"value\":\"111\",\"options\":[\"111\",\"2\"]},{\"id\":1,\"type\":\"\",\"key\":\"a\",\"value\":\"111333\",\"options\":\"111\"},{\"id\":1,\"key\":\"我是文本\",\"options\":\"\",\"type\":\"\",\"value\":\"我是文本的值\"},{\"id\":2,\"key\":\"我是单选框\",\"options\":[\"我是选中\",\"2222\"],\"type\":\"2\",\"value\":\"我是选中\"}]",
    // 参数格式化的值
    "valueJson": {
      "a": "111333",
      "b": "111",
      "我是单选框": "我是选中",
      "我是多选框": [
        "111",
        "222",
        "333"
      ],
      "我是文本": "我是文本的值"
    }
  },
  {
    "cacheScript": 1,
    "delaySecond": 222,
    "execNumber": 133,
    "cronText": "* * * * * ?",
    "deviceNos": "003,test222,001,002",
    "downloadUrl": "http://192.168.2.7:8098/pub_upload/2022-10-07/cnfdy1l2biiwpl8qcm.iec",
    "execType": 2,
    "scheduleTime": null,
    "scheduleType": 3,
    "execStatus": 1,
    "endTime": null,
    "scriptId": 16,
    "scriptMd5": "b7ec603dffd9527c98e505bdd0eea137",
    "scriptName": "html5",
    "scriptVersion": "1",
    "sort": 1,
    "taskId": 10,
    "taskName": "33",
    "tenantId": 1,
    "valueConfig": "[{\"id\":3,\"key\":\"我是多选框\",\"options\":[\"111\",\"2222\",\"333\"],\"type\":\"3\",\"value\":[\"111\",\"222\",\"333\"]},{\"id\":2,\"type\":\"2\",\"key\":\"b\",\"value\":\"111\",\"options\":[\"111\",\"2\"]},{\"id\":1,\"type\":\"\",\"key\":\"a\",\"value\":\"111333\",\"options\":\"111\"},{\"id\":1,\"key\":\"我是文本\",\"options\":\"\",\"type\":\"\",\"value\":\"我是文本的值\"},{\"id\":2,\"key\":\"我是单选框\",\"options\":[\"我是选中\",\"2222\"],\"type\":\"2\",\"value\":\"我是选中\"}]",
    "valueJson": {
      "a": "111333",
      "b": "111",
      "我是单选框": "我是选中",
      "我是多选框": [
        "111",
        "222",
        "333"
      ],
      "我是文本": "我是文本的值"
    }
  }
]

任务控制接口

  • 可以执行任务
  • 可以停止任务
  • 可以移出、增加执行设备
  • 可以移出、增加参数等

POST : 云控地址/openapi/changeTask 例如: http://192.168.1.182:8099/openapi/changeTask Content-Type: application/json

{
  "dataSecret":"后台配置的API云控通信密钥", // 配置在config.toml文件中的appkey选项，默认是 test123
  "taskId":"1",// 任务ID，在云控建好的
  "status":"0",// 1 停止本地，2 停止远程 0 开启
  "addDevices":"001,002,003",//需要增加执行的设备
    "removeDevices":"007,009",//需要减少执行的设备
  // 要增加的参数解释
  //key = 代表参数名称
  //type = 参数类型，1代表是文本 2 代表是单选框  3代表是多选框
  // value = 代表是参数值，如果是文本情况下，直接就是字符串
  // 如果是单选框，也填写字符串
  // 如果是多选框，填写json数组，因为是多选，必须是数组
  // options = 代表是候选选择，如果是文本，请忽略
  // 如果是单选框，请填写json数组
  // 如果是多选框，请填写json数组
  "addParamEx":[
    {
      "key":"我是文本",
      "type":"1",
      "value":"我是文本的值"
    },
    {
      "key":"我是单选框",
      "type":"2",
      "value":"2222",
      "options":["我是选中","2222"]
    },
    {
      "key":"我是多选框",
      "type":"3",
      "value":["111","222"],
      "options":["111","2222","333"]
    }
  ],
  "removeParam":["ke1"]
}
title: 下单自动执行流程
participant 客户
participant 下单系统
participant 云控系统
participant 设备


客户->下单系统: 客户下单并支付完成
下单系统->云控系统: 调用(/api/changeTask) 执行任务某个任务，\n并加入某写设备和参数
云控系统->云控系统: 改变任务状态\n参数、设备等
云控系统->设备: 下发任务到设备
设备->设备: 循环执行脚本
设备->云控系统: 调用(/api/changeTask)达到条件\n将自己从任务的设备中移出

WebHook 心跳日志推送

  • 该功能会将心跳和脚本的日志推送给外部系统
  • 可以通过http或者websocket推送 二选一
  • 具体配置在config/config.toml文件
  • 自行选择 mode，然后填写对应的httpUrl或者wsUrl，重启云控就行了
# 心跳转发（把 心跳数据 和脚本日志 推送到外部系统）
[heartbeatForward]
# 是否启用
enabled = true
# 转发方式：http 或 websocket
mode = "http"


# HTTP 模式配置（POST JSON）
#例如 http://192.168.2.26:8199/heartbeat
httpUrl = ""
httpTimeoutMs = 3000
# 可选：自定义 header（例如 Authorization）
httpHeaderKey = "ecloud_token"
httpHeaderValue = "90284kdf9i4k"


# WebSocket 模式配置（发送 TextMessage(JSON)）
# 例如 ws://192.168.2.26:8199/wstest
wsUrl = ""
wsDialTimeoutMs = 3000
wsWriteTimeoutMs = 1500
wsReconnectWaitMs = 2000
# header授权认证
wsHeaderKey = "ecloud_token"
wsHeaderValue = "90284kdf9i4k"


# 队列配置（异步发送，不阻塞主流程）
queueSize = 10240
# 队列满时是否丢弃（true：丢弃并打 warn；false：阻塞 RecordHeartBeat）
dropWhenFull = true