设备连接

实时数据接口位于边缘管理服务,边缘管理服务访问的地址如下:

访问地址:http://{host-ip}:9700

host-ip根据部署的环境进行更换,一般为IoT系统部署服务器的IP地址

在接口访问时,和服务访问地址进行合并即可进行接口的调用

1. 请求设备连接列表

  • 请求语法
GET /equipment/connector
  • 请求参数

  • 响应内容

参数名称 类型 描述
id integer 连接ID
name string 连接名称
model string 连接设备型号
modelName string 连接设备型号名称
address string 连接地址,IP地址或者hostname
port integer 连接端口
connectProp object 连接属性,根据不同的model类型存放不同的连接配置信息
enable boolean 是否启用
desc string 描述
connectTimeout integer 连接超时,单位为毫秒
status string 连接状态,CONNECTED, DISCONNECTED 和DISABLED三个选项
nodeGroupId integer 节点组ID
nodeGroupName integer 节点组名称
createTime datetime 创建时间
enableAutoDowngrade boolean 是否启动降级,默认为不启用
enableStandaloneThreadPool boolean 是否启动独立线程,默认为不启用
standaloneThreadNum integer 独立线程池大小
standaloneMaxThreadNum integer 独立线程池最大值
  • 请求示例

请求

curl -X GET "http://127.0.0.1:9700/equipment/connector" -H "accept: */*"

响应

{
  "data": [
    {
      "id": 354,
      "name": "OEE连接",
      "model": "OPC_UA",
      "modelName": null,
      "protocol": null,
      "address": "192.168.12.30",
      "port": 49320,
      "connectProp": {
        "securityPolicy": "None",
        "securityMode": "None",
        "anonymous": false,
        "enableSubscribe": false,
        "username": "opc_ua",
        "password": "123456",
        "equipmentCount": 8,
        "fieldCount": 93,
        "equipmentState": "ERROR"
      },
      "enable": false,
      "desc": "OEE连接",
      "connectTimeout": null,
      "status": "DISABLED",
      "nodeGroupId": null,
      "nodeGroupName": null,
      "createTime": "2021-12-22T10:19:22.026+08:00",
      "enableAutoDowngrade": null,
      "volatility": null,
      "detectIntervals": null,
      "readingMaxTaskNum": null,
      "enableStandaloneThreadPool": null,
      "standaloneThreadNum": null,
      "standaloneMaxThreadNum": null
    }
   ],
  "code": 200,
  "message": null
}

2. 分页请求设备连接列表

  • 请求语法

POST /equipment/connector/page
  • 请求Body数据
参数名称 类型 是否必选 位置 描述
name string 连接名称,模糊匹配
modelName string 协议类型
address string 连接地址,模糊匹配
status string 连接状态,CONNECTED, DISCONNECTED 和DISABLED三个选项
page integer 页数,默认0,第一页
pageSize integer 每页个数,默认10
direction boolean 是否正序,默认正序
sort boolean 是否排序,默认不排序
sortCol string 排序列名,设置了sort时,必须设置sort的列名
  • 响应数据

数据返回采用分页接口进行返回,分页接口按照统一的格式进行返回,分页数据模版如下:

{
  "data": {
    "content": [ ],        // 返回数据列表,查询对象的内容从该数组中获取
    "totalElements": 1,    // 总数量
    "totalPages": 1,       // 总页面数
    "numberOfElements": 1, // 当前页面的数量
  },
  "code": 200,
  "message": null
}
  • 响应content中数据说明
参数名称 类型 描述
id integer 连接ID
name string 连接名称
model string 连接设备型号
modelName string 连接设备型号名称
address string 连接地址,IP地址或者hostname
port integer 连接端口
connectProp object 连接属性,根据不同的model类型存放不同的连接配置信息
enable boolean 是否启用
desc string 描述
connectTimeout integer 连接超时,单位为毫秒
status string 连接状态,CONNECTED, DISCONNECTED 和DISABLED三个选项
nodeGroupId integer 节点组ID
nodeGroupName integer 节点组名称
createTime datetime 创建时间
enableAutoDowngrade boolean 是否启动降级,默认为不启用
enableStandaloneThreadPool boolean 是否启动独立线程,默认为不启用
standaloneThreadNum integer 独立线程池大小
standaloneMaxThreadNum integer 独立线程池最大值
  • 请求示例

请求

curl -X POST "http://127.0.0.1:9700/equipment/connector/page"  -H "accept: */*" -H "Content-Type: application/json" -d "{ \"address\": \"10.10.32.32\", \"direction\": false, \"modelName\": \"OPC UA Client\", \"name\": \"OPC\", \"page\": 0, \"pageSize\": 10, \"sort\": true, \"sortCol\": \"createTime\", \"status\": \"CONNECTED\"}"

body内容就是如下的数据:

{
  "name": "OPC",
  "modelName": "OPC UA Client",
  "status": "CONNECTED",
  "address": "10.10.32.32",
  "page": 0,
  "pageSize": 10,
  "sort": true,
  "direction": false,
  "sortCol": "createTime"
}

响应

{
  "data": {
    "content": [
      {
        "id": 3743,
        "name": "服务器OPC UA",
        "model": "OPC_UA",
        "modelName": "OPC UA Client",
        "address": "10.10.32.32",
        "port": 4840,
        "connectProp": {                
          "securityPolicy": "None",
          "securityMode": "None",
          "anonymous": true,
          "enableSubscribe": true,
          "equipmentCount": 1,
          "fieldCount": 19,
          "equipmentState": "NORMAL"
        },
        "enable": true,
        "desc": "OPC设备",
        "connectTimeout": 10000,
        "status": "CONNECTED",
        "nodeGroupId": null,
        "nodeGroupName": null,
        "createTime": "2023-06-12T09:40:40.764+08:00",
        "enableAutoDowngrade": false,
        "enableStandaloneThreadPool": false,
        "standaloneThreadNum": 2,
        "standaloneMaxThreadNum": 4,
      }
    ],
    "totalElements": 1,
    "totalPages": 1,
    "numberOfElements": 1,
  },
  "code": 200,
  "message": null
}
2024-03-26
0