NAYOTA开放平台
  • 开放接口
  • 高级配置相关
  • 边缘网关配置
Nayota
2022-03-25

边缘网关Api

# 说明

边缘网关的字段请查看字段说明

# 列表查询

接口说明

根据查询条件查询边缘网关列表。

接口版本

v1

接口地址

/api-web-v1/controls

请求方法

GET

请求参数

参数类型 参数名称 数据类型 是否必须 参数描述 默认 示例
query label string false 模糊查询字段 emails
query search string false 模糊查询值 1765181758@qq.com
query time string false 时间范围查询字段,必须是边缘网关字段中的时间或时间戳字段名，例如createdAt,updatedAt createdAt
query range string[] or string false 时间范围，开始时间到结束时间,可以是string[]或者以逗号分割的开始时间到结束时间或时间戳 2019-10-22T00:00:00.000Z,2022-01-22T00:00:00.000Z
query page number false 分页第几页 1
query limit number false 单页几条数据 10
query sort string false 根据哪个字段排序 _id -createdAt
query select string false 只查询部分字段,字段名之间用过空格分隔,去掉某个字段的查询字段名前面加-
query autopopulate boolean false 自动关联数据，部分字段自动关联关系表查询，设置这个值可开关自动联表查询 true false
query populate string false 指定关联表查询,查询多个关联表用逗号分隔 control

请求参数举例

注意

GET请求所有参数类型都会变成string拼接在url上面，文档为了表述清晰，将示例结构以json格式编写

{
  "page":"1",
  "limit":"10",
  "sort":"-createdAt",
  "autopopulate":"false"
}

返回参数

参数名称 数据类型 是否必须 参数描述
code number True 是否成功
data json True 返回数据
-total number False 边缘网关总条数
-rows array False 当前返回的边缘网关对象列表

返回参数举例

{
  "code": 0,
  "data": {
    "total": 11,
    "rows": [
      {
        "onlineTime": 1571314554191,
        "_id": "5da857e31816bc001be731cf",
        "name": "Nayota Control",
        "packageData": {
          "hardwareWord": [
            {
              "_id": "5d4c022ec3d2be6d95c41bfc",
              "name": "温湿度-NAYOTA-LORA"
            },
            {
              "_id": "5d359600e099384f086e1cb6",
              "name": "LORA-Modbus型设备"
            },
            {
              "_id": "5d73170d307640dd9aeffabd",
              "name": "智能空开-曼顿-4路"
            },
            {
              "_id": "5d73116a307640dd9aeff86e",
              "name": "智能空开-曼顿-8路"
            },
            {
              "_id": "5d1f3f288ce12637b661b8e4",
              "name": "电表-斯同瑞-三相"
            }
          ],
          "_id": "5d9effc5377ce1001b9058cb",
          "name": "入门套餐",
          "number": 100,
          "year": 2,
          "createdAt": "2019-10-10T09:54:13.369Z",
          "updatedAt": "2019-10-10T09:54:13.369Z",
          "__v": 1,
          "status": true,
          "activeTime": "2019-10-17T12:00:35.452Z",
          "exceedTime": "2021-10-16T12:00:35.452Z"
        },
        "sdk": "B0F3D1A0-F0D5-11E9-9CAE-2958501A3C4D",
        "creator": {
          "mqttPassword": "88223080",
          "_id": "5da855b71816bc001be72f4b",
          "trueName": "王宾宾",
          "username": "15258284638",
          "mqttUsername": "15258284638"
        },
        "controlModel": "5d035878613e0b43efa09fe8",
        "serialData": [
          {
            "_id": "5d22fe461d859e3584a1ebea",
            "comName": "/dev/ttyAMA0",
            "baud": 115200,
            "verification": "none",
            "stopBit": 1,
            "dataBit": 8,
            "state": true,
            "lineAt": "2019-10-17T12:00:36.122Z"
          }
        ],
        "createdAt": "2019-10-17T12:00:35.468Z",
        "updatedAt": "2019-10-17T12:19:34.294Z",
        "number": "0177",
        "__v": 0,
        "clientId": null,
        "ip_address": "60.179.198.177",
        "line": false,
        "version": "On branch develop"
      }
    ]
  }
}

在线调试 (opens new window)

# 查询边缘网关ID

接口说明

根据边缘网关ID查询边缘网关

接口版本

v1

接口地址

/api-v1/controls/:id

请求方法

GET

请求参数

参数类型 参数名称 数据类型 是否必须 参数描述
params id string True 边缘网关ID

请求参数举例

注意

GET请求所有参数类型都会拼接在url上面，文档为了表述清晰，将示例结构以json格式编写

{
  "_id": "5da857e31816bc001be731cf"
}

返回参数

参数名称 数据类型 是否必须 参数描述
code number True 是否成功
data json false 返回边缘网关信息

返回参数举例

{
  "code": 0,
  "data": {
    "onlineTime": 1571314554191,
    "_id": "5da857e31816bc001be731cf",
    "name": "Nayota Control",
    "packageData": {
      "hardwareWord": [
        {
          "_id": "5d4c022ec3d2be6d95c41bfc",
          "name": "温湿度-NAYOTA-LORA"
        },
        {
          "_id": "5d359600e099384f086e1cb6",
          "name": "LORA-Modbus型设备"
        },
        {
          "_id": "5d73170d307640dd9aeffabd",
          "name": "智能空开-曼顿-4路"
        },
        {
          "_id": "5d73116a307640dd9aeff86e",
          "name": "智能空开-曼顿-8路"
        },
        {
          "_id": "5d1f3f288ce12637b661b8e4",
          "name": "电表-斯同瑞-三相"
        }
      ],
      "_id": "5d9effc5377ce1001b9058cb",
      "name": "入门套餐",
      "number": 100,
      "year": 2,
      "createdAt": "2019-10-10T09:54:13.369Z",
      "updatedAt": "2019-10-10T09:54:13.369Z",
      "__v": 1,
      "status": true,
      "activeTime": "2019-10-17T12:00:35.452Z",
      "exceedTime": "2021-10-16T12:00:35.452Z"
    },
    "sdk": "B0F3D1A0-F0D5-11E9-9CAE-2958501A3C4D",
    "creator": {
      "mqttPassword": "88223080",
      "_id": "5da855b71816bc001be72f4b",
      "trueName": "王宾宾",
      "username": "15258284638",
      "mqttUsername": "15258284638"
    },
    "controlModel": "5d035878613e0b43efa09fe8",
    "serialData": [
      {
        "_id": "5d22fe461d859e3584a1ebea",
        "comName": "/dev/ttyAMA0",
        "baud": 115200,
        "verification": "none",
        "stopBit": 1,
        "dataBit": 8,
        "state": true,
        "lineAt": "2019-10-17T12:00:36.122Z"
      }
    ],
    "createdAt": "2019-10-17T12:00:35.468Z",
    "updatedAt": "2019-10-17T12:19:34.294Z",
    "number": "0177",
    "__v": 0,
    "clientId": null,
    "ip_address": "60.179.198.177",
    "line": false,
    "version": "On branch develop"
  }
}

在线调试 (opens new window)

# 新建

接口说明

新建一个网关信息。

接口版本

v1

接口地址

/api-v1/controls

请求方法

POST

请求参数

参数类型 参数名称 数据类型 是否必须 参数描述
body - Object True 网关信息对象字段说明
- name String True 网关名称
- type number True 网关类型 0:边缘网关 1:云网关
- serverName String True 服务类型 OpenMqttApi
- server ObjectId True 服务信息OpenMqttApi接口说明

请求参数举例

    {
  "name": "测试云网关",
  "type": 1,
  "server": "5feaed458c1afe001bca0c5a"
  "serverName": "OpenMqttApi"
  
}

    // Make sure to add code blocks to your code group

    返回参数

    参数名称 数据类型 是否必须 参数描述
    code number True 是否成功
    data json True 返回创建的对象

    返回参数举例

      {
    "code": 0,
    "data": {
      "fathers": [
        "618dd3a009e86b001b496b0a"
      ],
      "_id": "62cd16e3e450544275d8f139",
      "level": 1,
      "sort": 1,
      "status": true,
      "name": "一楼",
      "father": "618dd3a009e86b001b496b0a",
      "creator": "5714a78935b1fecb47044bf7",
      "createdAt": "2022-07-12T06:38:27.817Z",
      "updatedAt": "2022-07-12T06:38:27.817Z",
      "__v": 0
    }
  }
}

    # 编辑

    接口说明

    修改边缘网关

    接口版本

    v1

    接口地址

    /api-v1/controls/:id

    请求方法

    PUT

    请求参数

    参数类型 参数名称 数据类型 是否必须 参数描述
    params id string True 修改的边缘网关ID
    body - Object True 边缘网关对象字段说明

    请求参数举例

      {
  "name": "Nayota Control NB",
}

      // Make sure to add code blocks to your code group

      返回参数

      参数名称 数据类型 是否必须 参数描述
      code number True 是否成功
      data json True 返回创建的对象

      返回参数举例

      {
  "code": 0,
  "data": {
    "onlineTime": 1571314554191,
    "_id": "5da857e31816bc001be731cf",
    "name": "Nayota Control NB",
    "packageData": {
      "hardwareWord": [
        {
          "_id": "5d4c022ec3d2be6d95c41bfc",
          "name": "温湿度-NAYOTA-LORA"
        },
        {
          "_id": "5d359600e099384f086e1cb6",
          "name": "LORA-Modbus型设备"
        },
        {
          "_id": "5d73170d307640dd9aeffabd",
          "name": "智能空开-曼顿-4路"
        },
        {
          "_id": "5d73116a307640dd9aeff86e",
          "name": "智能空开-曼顿-8路"
        },
        {
          "_id": "5d1f3f288ce12637b661b8e4",
          "name": "电表-斯同瑞-三相"
        }
      ],
      "_id": "5d9effc5377ce1001b9058cb",
      "name": "入门套餐",
      "number": 100,
      "year": 2,
      "createdAt": "2019-10-10T09:54:13.369Z",
      "updatedAt": "2019-10-10T09:54:13.369Z",
      "__v": 1,
      "status": true,
      "activeTime": "2019-10-17T12:00:35.452Z",
      "exceedTime": "2021-10-16T12:00:35.452Z"
    },
    "sdk": "B0F3D1A0-F0D5-11E9-9CAE-2958501A3C4D",
    "creator": {
      "mqttPassword": "88223080",
      "_id": "5da855b71816bc001be72f4b",
      "trueName": "王宾宾",
      "username": "15258284638",
      "mqttUsername": "15258284638"
    },
    "controlModel": "5d035878613e0b43efa09fe8",
    "serialData": [
      {
        "_id": "5d22fe461d859e3584a1ebea",
        "comName": "/dev/ttyAMA0",
        "baud": 115200,
        "verification": "none",
        "stopBit": 1,
        "dataBit": 8,
        "state": true,
        "lineAt": "2019-10-17T12:00:36.122Z"
      }
    ],
    "createdAt": "2019-10-17T12:00:35.468Z",
    "updatedAt": "2019-10-17T12:19:34.294Z",
    "number": "0177",
    "__v": 0,
    "clientId": null,
    "ip_address": "60.179.198.177",
    "line": false,
    "version": "On branch develop"
  }
}
      上次更新: 2023/05/19, 10:27:07
      推送配置Api
      通用路由配置

      ← 通用路由配置→

      Theme by Vdoing | Copyright © 2021-2023