1. 网关（软件）管理API

API列表

编号 API名称 路径 版本
1.1 新增网关 /v1/iot/gateway/software/add 1.0
1.2 查看网关列表 /v1/iot/gateway/software/list 1.0
1.3 网关软件版本发布 /v1/iot/gateway/software/deploy 1.0
1.4 查看网关软件包详情 /v1/iot/gateway/sofeware/detail 1.0
1.5 更改网关软件包 /v1/iot/gateway/software/update 1.0
1.6 删除网关 /v1/iot/gateway/software/delete 1.0
1.7 查看网关id列表 /v1/iot/gateway/software/id/list 1.0
1.8 网关文件上传 /v1/iot/gateway/software/package/upload 1.0
1.9 新增网关名字 /v1/iot/gateway/software/name/add 1.0
1.10 删除网关名字 /v1/iot/gateway/software/name/delete 1.0
1.11 修改网关名字 /v1/iot/gateway/software/name/update 1.0
1.12 异步上传文件 /v1/iot/gateway/software/package/upload/async 1.0
1.13 获取上传进度 /v1/iot/gateway/software/package/upload/get/progress 1.1
1.14 查看已绑定固件的网关id列表 /v1/iot/gateway/software/id/bind/list 1.0
1.15 获取网关版本信息 v1/iot/gateway/software/queryGatewayVersionList 1.0
1.16 获取网关列表(不分页) v1/iot/gateway/software/queryList 1.0

API调用

1.1: 新增网关

描述

添加应用网关软件包记录

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/software/add

方法：POST

请求参数

名称 位置 类型 必填 描述
msgId body string y
gatewayName body String y 网关名称
packageVersion body String y 软件版本
packageUrl body String n 软件包下载url
releaseNote body String y 备注
packageMd5 body string y

请求Body描述(非Form表单)

{
    "msgId": "12345678",
    "gatewayName": "IOTBOX网关",
    "packageVersion": "v1.0.0",
    "packageUrl": "https://oss-sample/gateway.jar",
    "releaseNote": "1、xxx\n2、xxx",
    "packageMd5": "f2e91a565a89c5a7fabd69077a00a231"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {},
    "message": "success"
}

1.2: 查看网关列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/software/list

方法：POST

请求参数

名称 位置 类型 必填 描述
msgId body string y
gatewayId body string y 网关Id，传""时查询所有网关版本
gatewayName body String n 网关名称，传""时查询所有网关版本
pageNo body Integer y 第几页
pageSize body Integer y 每页显示几条

请求Body描述(非Form表单数据)

{
    "msgId": "123123123",
    "gatewayId": 5,
    "gatewayName": "",
    "pageNo": 1,
    "pageSize": 2
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {
        "paginator": {
            "pageNo": 1,
            "pageSize": 2,
            "totalCount": 15
        },
        "resultList": [
            {
                "gatewayName": "IOTBOX测试网关3",
                "packageId": 2,
                "releaseStatus": 1,
                "packageVersion": "v1.0.0",
                "updateTime": "2020-08-10T02:10:02.000+0000",
                "releaseNote": "1、xx",
                "gatewayId": 5
            },
            {
                "gatewayName": "IOTBOX测试网关3",
                "packageId": 4,
                "releaseStatus": 1,
                "packageVersion": "v1.0.0",
                "updateTime": "2020-08-10T02:10:02.000+0000",
                "releaseNote": "1、xx",
                "gatewayId": 5
            }
        ]
    },
    "message": "success"
}

1.3: 网关软件版本发布

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/software/deploy

方法：POST

请求参数

名称 位置 类型 必填 描述
msgId body string y
packageId body string y 网关软件包id
releaseStatus body int y 发布状态，0：未发布，1：已发布

请求Body描述(非Form表单数据)

{
    "msgId": "123123123",
    "packageId": "1",
    "releaseStatus": 0
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.4: 查看网关软件包详情

描述

点击编辑按钮，获取网关详细信息

请求信息

HTTP协议：HTTP，HTTPS

uri：/v1/iot/gateway/software/detail

方法：POST

请求参数

名称 位置 类型 必填 描述
msgId body string y
packageId body string y 网关软件包id

请求Body描述(非Form表单数据)

{
    "msgId":"123123123",
    "packageId": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {
        "gatewayName": "测试网关固件包",
        "packageUrl": "https://oss-sample/image/url",
        "packageVersion": "001",
        "releaseNote": "这是测试固件包"
    },
    "message": "success"
}

1.5: 编辑网关安装包

描述

修改软件包或软件包下载地址

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/software/update

方法：POST

请求参数

名称 位置 类型 必填 描述
msgId body string y
packageId body string y 网关软件包id
packageDesc body String n 软件包描述

请求Body描述(非Form表单数据)

{
    "msgId": "123123123",
    "packageId": "1",
    "packageDesc": "xxxxxx"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.6: 删除网关软件包

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/software/delete

方法：POST

请求参数

名称 位置 类型 必填 描述
msgId body string y
packageId body string y 网关软件包id

请求Body描述(非Form表单数据)

{
    "msgId": "123123123",
    "packageId": "1"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.7: 查看网关id列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/software/id/list

方法：POST

请求参数

名称 位置 类型 必填 描述
msgId body string y 请求msgId

请求Body描述(非Form表单数据)

{
    "msgId": "123123123"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
          "resultList": [
              {
                  "gatewayName": "测试网关",
                  "id": 1
              },
              {
                  "gatewayName": "IOTBOX测试网关2",
                  "id": 2
              },
              {
                  "gatewayName": "IOTBOX测试网关3",
                  "id": 5
              }
          ]
      }
}

1.8: 网关文件上传

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/software/package/upload

方法：POST

请求参数

名称 位置 类型 必填 描述
file body file y

请求Body描述(Form表单数据)

{
    "file": xxx.tar.gz
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {
        "packageMd5": "f2e91a565a89c5a7fabd69077a00a231",
        "url": "https://mideazy-test-public.oss-cn-hangzhou.aliyuncs.com/iot_box_image/app.000000010410.tar.bz"
    },
    "message": "success"
}

1.9: 新增网关名字

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/software/name/add

方法：POST

请求参数

名称 位置 类型 必填 描述
msgId body string y
gatewayName body string y

请求Body描述(非Form表单数据)

{
    "msgId":"12345654321",
    "gatewayName":"测试网关4"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {},
    "message": "success"
}

1.10: 删除网关名字

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/software/name/delete

方法：POST

请求参数

名称 位置 类型 必填 描述
msgId body string y
gatewayId body int y

请求Body描述(非Form表单数据)

{
    "msgId":"12345654321",
    "gatewayId": 11
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {},
    "message": "success"
}

1.11: 修改网关名字

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/software/name/update

方法：POST

请求参数

名称 位置 类型 必填 描述
msgId body string y
gatewayId body string y
gatewayName body int y

请求Body描述(非Form表单数据)

{
    "msgId": "12345654321",
    "gatewayId": 11,
    "gatewayName": "测试网关4"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {},
    "message": "success"
}

1.12: 异步上传文件

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/software/package/upload/async

方法：POST

请求参数

名称 位置 类型 必填 描述
file body file y

请求Body描述(Form表单数据)

{
    "file": xxx.tar.gz
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {
        "packageMd5": "0a2d40e7ef2be06cb132edf2abcd13a4",
        "url": "https://mideazy-test-public.oss-cn-hangzhou.aliyuncs.com/iot_box_image/bonlaway.000000010608.tar.gz",
        "fileUploadCode": "443400"  //用于查询文件上传进度
    },
    "message": "success"
}

1.13: 获取上传进度

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/software/package/upload/get/progress

方法：POST

请求参数

名称 位置 类型 必填 描述
msgId body string y
fileUploadCode body string y

请求Body描述(非Form表单数据)

{
    "msgId": "12345654321",
    "fileUploadCode": "443400"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {
        "progress": "91",   //上传进度
        "status": "3"   //上传状态，0：开始上传，2：正在上传，3：上传完成，-1：上传出错
    },
    "message": "success"
}

1.14: 查看已绑定固件的网关id列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/software/id/bind/list

方法：POST

请求参数

名称 位置 类型 必填 描述
msgId body string y 请求msgId

请求Body描述(非Form表单数据)

{
    "msgId": "123123123"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
          "resultList": [
              {
                  "gatewayName": "测试网关",
                  "id": 1
              },
              {
                  "gatewayName": "IOTBOX测试网关2",
                  "id": 2
              },
              {
                  "gatewayName": "IOTBOX测试网关3",
                  "id": 5
              }
          ]
      }
}

1.15: 获取网关版本信息

描述 获取网关版本信息

请求信息

HTTP协议：HTTP,HTTPS

uri：v1/iot/gateway/software/queryGatewayVersionList

方法：POST

请求参数

名称 位置 类型 必填 描述
msgId body string y 请求msgId
gatewayDefinitionId body string y 查询网关id

请求Body描述(非Form表单数据)

{
    "msgId": "4c928438-b522-e944-b6c6-9d674ccc5ab0",
    "gatewayDefinitionId": "51"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code":200,
    "data":{
        "resultList":[
            {
                "packageMd5":"93fffae09e0228772e6efe0feb1cb257",
                "packageVersion":"1.0.3",
                "updateTime":1604388157000,
                "releaseNote":"1.0.3",
                "imageLink":"https://mideazy-test-public.oss-cn-hangzhou.aliyuncs.com/iot_box_image/aa.jpg",
                "latestVersionFlag":0,
                "createBy":"2158397",
                "createTime":1604285945000,
                "updateBy":"2205875",
                "id":90,
                "packageName":"205网关",
                "definitionId":51,
                "status":1
            }
        ]
    },
    "message":"success"
}

results matching ""

    No results matching ""