API列表

address: https://api-aep.xiot.senthink.com

path: 参考各接口说明中的请求地址

接口调用必须携带公共请求头，公共请求头如下。

Headers：

公共错误码

鉴权

获取鉴权参数

请求地址： /oauth/login 传参方式： POST

备注： 无

请求参数

Body:

响应参数

data 说明

请求示例

1、获取鉴权参数

{
    "client_id":"yourAppId",
    "client_secret":"yourAppSecret",
    "grant_type":"password"
}

2、刷新鉴权参数

{
    "refresh_token":"yourRefreshToken",
    "client_id":"yourAppId",
    "client_secret":"yourAppSecret",
    "grant_type":"refresh_token"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "access_token": "theAccessToken",
        "token_type": "bearer",
        "refresh_token": "theRefreshToken",
        "expires_in": 259200,
        "scope": "all",
        "user_id": "yourUserId",
        "user_name": "yourUsername",
        "company_id": "yourCompanyId",
        "role_type": 1,
        "jti": "4b02c4d4-e5d3-42b6-ab67-0062fad87324"
    }
}

错误码

产品模块

添加产品

请求地址： /openApi/v2/product/add 传参方式： POST

备注： 无

请求参数

Body:

1.公共参数

2.其他参数

2.1 产品为设备：deviceType = 0

2.1.1 设备直连:accessType = 1

2.1.2 云云对接:accessType = 2

2.1.3 网关接入:accessType = 3

2.2 产品为网关：deviceType = 1

响应参数

data 说明

示例

1、产品为设备:设备直连

请求示例

{
    "name":"OpenAPIV2产品MQTT测试001",
    "deviceType":0,
    "accessType":1,
    "payloadFormat":1,
    "dataFormat":0,
    "authType":0,
    "encrypted":0,
    "netType":0,
    "protocol":1,
    "securityType":1
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "productId": "98FF3568",
        "productKey": "FD2BC404DDA7840C6126B84259689BA3",
        "name": "OpenAPIV2产品MQTT测试001",
        "accessType": 1,
        "netType": 0,
        "protocol": 1,
        "deviceType": 0,
        "securityType": 1,
        "authType": 0,
        "encrypted": 0,
        "payloadFormat": 1,
        "dataFormat": 0,
        "productDesc": null,
        "createAt": "2022-12-14 11:08:09",
        "deviceNum": 0
    }
}

2、产品为设备:云云对接

请求示例

{
    "name":"OpenAPIV2产品Ctwing测试001",
    "deviceType":0,
    "accessType":2,
    "payloadFormat":1,
    "dataFormat":2,
    "authType":0,
    "encrypted":0,
    "netType":0,
    "protocol":3,
    "ctwingAppId":"67844",
    "ctwingAppKey":"WTazSGDqTuh",
    "ctwingAppSecret":"Cx6E1ccFn3",
    "ctwingMasterKey":"2d2b8c70eadc4e56b35de494b85319f4",
    "ctwingProductId":"15495260",
    "ctwingPayloadFormat":0
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "productId": "78D5BFFA",
        "productKey": "514D12A9F605634EBD19E0B573B54D41",
        "name": "OpenAPIV2产品Ctwing测试001",
        "accessType": 2,
        "netType": 0,
        "protocol": 3,
        "deviceType": 0,
        "securityType": null,
        "authType": null,
        "encrypted": null,
        "payloadFormat": 1,
        "dataFormat": 2,
        "productDesc": null,
        "createAt": "2022-12-14 11:27:54",
        "deviceNum": 0
    }
}

3、产品为设备:网关接入

请求示例

{
    "name":"OpenAPIV2产品网关接入测试001",
    "deviceType":0,
    "accessType":3,
    "payloadFormat":1,
    "dataFormat":1,
    "securityType":1,
    "gatewayProtocol":1
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "productId": "11E1E03F",
        "productKey": "64A4A764F37EFBEFAC05B1DF9EC9091B",
        "name": "OpenAPIV2产品网关接入测试001",
        "accessType": 3,
        "netType": null,
        "protocol": 1,
        "deviceType": 0,
        "securityType": 1,
        "authType": null,
        "encrypted": null,
        "payloadFormat": 1,
        "dataFormat": 1,
        "productDesc": null,
        "createAt": "2022-12-14 11:33:56",
        "deviceNum": 0
    }
}

4、产品为网关

请求示例

{
    "name":"OpenAPIV2产品节点网关测试001",
    "deviceType":1,
    "accessType":1,
    "payloadFormat":1,
    "dataFormat":0,
    "netType":0,
    "protocol":1,
    "securityType":1,
    "authType":0,
    "encrypted":0
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "productId": "59D3C6A3",
        "productKey": "675F55777B069113F7D3FFA6F9129E0A",
        "name": "OpenAPIV2产品节点网关测试001",
        "accessType": 1,
        "netType": 0,
        "protocol": 1,
        "deviceType": 1,
        "securityType": 1,
        "authType": 0,
        "encrypted": 0,
        "payloadFormat": 1,
        "dataFormat": 0,
        "productDesc": null,
        "createAt": "2022-12-14 11:39:22",
        "deviceNum": 0
    }
}

错误码

编辑产品

请求地址： /openApi/v2/product/edit 传参方式： POST

备注： 无

请求参数

Body:

响应参数

请求示例

{
  "productId": "98FF3568",
  "name":"OpenAPIV2产品MQTT测试0011",
  "productDesc": "api编辑产品"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": true
}

错误码

删除产品

请求地址： /openApi/v2/product/delete 传参方式： POST

备注： 无

请求参数

Body:

响应参数

请求示例

{
  "productId": "8A0F0491"
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": true
}

错误码

查询产品详情

请求地址： /openApi/v2/product/query 传参方式： POST

备注： 无

请求参数

Body:

响应参数

data 说明

请求示例

{
    "productId":"98FF3568"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "productId": "98FF3568",
        "productKey": "FD2BC404DDA7840C6126B84259689BA3",
        "name": "OpenAPIV2产品MQTT测试001",
        "accessType": 1,
        "netType": 0,
        "protocol": 1,
        "deviceType": 0,
        "securityType": 1,
        "authType": 0,
        "encrypted": 0,
        "payloadFormat": 1,
        "dataFormat": 0,
        "productDesc": null,
        "createAt": "2022-12-14 11:08:09",
        "deviceNum": 0
    }
}

错误码

获取产品列表

请求地址： /openApi/v2/product/list 传参方式： POST

备注： 无

请求参数

Body:

响应参数

data 说明

records 说明

请求示例

{
  "page": 1,
  "pageSize": 100
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "records": [
            {
                "productId": "A66AF6D8",
                "productKey": "6D63E72964F24B076D44689949242FB5",
                "name": "OpenAPIV2产品MQTT测试002",
                "accessType": 1,
                "netType": 0,
                "protocol": 1,
                "deviceType": 0,
                "securityType": 1,
                "authType": 0,
                "encrypted": 0,
                "payloadFormat": 1,
                "dataFormat": 0,
                "productDesc": null,
                "createAt": "2022-12-14 15:17:26",
                "deviceNum": 0
            }
        ],
        "current": 1,
        "size": 1,
        "total": 30
    }
}

获取产品物模型tsl

请求地址： /openApi/v2/product/getTsl 传参方式： POST

备注： 无

请求参数

Body:

响应参数

data 说明

请求示例

{
  "productId": "1286A6CA"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "modelId": "636b1cd6b55f7227a27e5861",
        "productId": "1286A6CA",
        "productName": "测试物模型非透传json格式",
        "draftModelMetaData": "{\"profile\":{\"version\":\"1.0\",\"productKey\":\"40CE563F93E598FEF3A78E636D54B340\",\"productModelId\":\"636b1cd6b55f7227a27e5861\"},\"properties\":[{\"identifier\":\"test_int11\",\"name\":\"test_int11\",\"dataType\":{\"type\":\"int32\",\"spec\":{}},\"accessMode\":\"r\"},{\"identifier\":\"test_int\",\"identifierOld\":\"test_int1\",\"name\":\"test_int\",\"dataType\":{\"type\":\"int32\",\"spec\":{\"min\":\"1\",\"max\":\"100\",\"step\":\"1\",\"unit\":\"\"}},\"accessMode\":\"rw\"},{\"identifier\":\"ttttest_bool\",\"identifierOld\":\"tttest_bool\",\"name\":\"ttttest_bool\",\"dataType\":{\"type\":\"bool\",\"spec\":{\"0\":\"关2\",\"1\":\"开2\"}},\"accessMode\":\"rw\"}],\"events\":[{\"identifier\":\"q\",\"identifierOld\":\"q\",\"name\":\"q\",\"type\":\"info\",\"outputData\":[{\"identifier\":\"q\",\"identifierOld\":\"q\",\"name\":\"qq\",\"dataType\":{\"type\":\"int32\",\"spec\":{}}},{\"identifier\":\"q1\",\"name\":\"11\",\"dataType\":{\"type\":\"int32\",\"spec\":{}}}]}],\"services\":[{\"identifier\":\"qqqp\",\"identifierOld\":\"qqqp\",\"name\":\"qq\",\"callType\":\"async\",\"inputData\":[{\"identifier\":\"11\",\"identifierOld\":\"11\",\"name\":\"11\",\"dataType\":{\"type\":\"int32\",\"spec\":{}}},{\"identifier\":\"2\",\"name\":\"22\",\"dataType\":{\"type\":\"int32\",\"spec\":{}}}],\"outputData\":[{\"identifier\":\"3\",\"identifierOld\":\"3\",\"name\":\"33\",\"dataType\":{\"type\":\"float\",\"spec\":{}}}]}]}",
        "modelMetaData": "{\"profile\":{\"version\":\"1.0\",\"productKey\":\"40CE563F93E598FEF3A78E636D54B340\",\"productModelId\":\"636b1cd6b55f7227a27e5861\"},\"properties\":[{\"identifier\":\"test_int11\",\"name\":\"test_int11\",\"dataType\":{\"type\":\"int32\",\"spec\":{}},\"accessMode\":\"r\"},{\"identifier\":\"test_int\",\"identifierOld\":\"test_int1\",\"name\":\"test_int\",\"dataType\":{\"type\":\"int32\",\"spec\":{\"min\":\"1\",\"max\":\"100\",\"step\":\"1\",\"unit\":\"\"}},\"accessMode\":\"rw\"},{\"identifier\":\"ttttest_bool\",\"identifierOld\":\"tttest_bool\",\"name\":\"ttttest_bool\",\"dataType\":{\"type\":\"bool\",\"spec\":{\"0\":\"关2\",\"1\":\"开2\"}},\"accessMode\":\"rw\"}],\"events\":[{\"identifier\":\"q\",\"identifierOld\":\"q\",\"name\":\"q\",\"type\":\"info\",\"outputData\":[{\"identifier\":\"q\",\"identifierOld\":\"q\",\"name\":\"qq\",\"dataType\":{\"type\":\"int32\",\"spec\":{}}},{\"identifier\":\"q1\",\"name\":\"11\",\"dataType\":{\"type\":\"int32\",\"spec\":{}}}]}],\"services\":[{\"identifier\":\"qqqp\",\"identifierOld\":\"qqqp\",\"name\":\"qq\",\"callType\":\"async\",\"inputData\":[{\"identifier\":\"11\",\"identifierOld\":\"11\",\"name\":\"11\",\"dataType\":{\"type\":\"int32\",\"spec\":{}}},{\"identifier\":\"22\",\"identifierOld\":\"22\",\"name\":\"22\",\"dataType\":{\"type\":\"int32\",\"spec\":{}}}],\"outputData\":[{\"identifier\":\"3\",\"name\":\"33\",\"dataType\":{\"type\":\"float\",\"spec\":{}}}]}]}",
        "draftAnalyzeScript": "/**\n * 上行16进制字符串转物模型JSON入口\n * \n*/\nfunction rawDataToProtocol(strString) {\n// todo hex to jsonString    var jsonMap = new Object();\n    return jsonMap;\n}\n\n/**\n * 下行json格式数据转十六进制字符串入口\n * \n*/\nfunction protocolToRawData(json) {\n// todo json to hexStringvar hexString = \"\"    return hexString;\n}\n",
        "analyzeScript": null
    }
}

错误码

获取产品下相关的Topic

请求地址： /openApi/v2/product/getTopic 传参方式： POST

备注： 无

请求参数

Body:

响应参数

data 说明

MqttTopic 说明

示例

1、只传入产品productId

请求示例

{
  "productId": "A66AF6D8"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "nodeTopic": null,
        "baseTopic": [
            {
                "function": "认证",
                "topic": "/sys/device/auth",
                "permission": 2,
                "desc": "用于设备认证",
                "subStatus": null
            },
            {
                "function": "入网",
                "topic": "/sys/device/join",
                "permission": 2,
                "desc": "用于设备入网",
                "subStatus": null
            },
            {
                "function": "数据下行",
                "topic": "/sys/8C3E488A/A66AF6D8/${deviceId}/downlink",
                "permission": 1,
                "desc": "平台下行topic(用于认证，心跳,入网的回复)",
                "subStatus": null
            },
            {
                "function": "心跳",
                "topic": "/sys/8C3E488A/A66AF6D8/${deviceId}/heartbeat",
                "permission": 2,
                "desc": "用于心跳上报",
                "subStatus": null
            },
            {
                "function": "固件上报",
                "topic": "/sys/8C3E488A/A66AF6D8/${deviceId}/firmware_report",
                "permission": 2,
                "desc": "用于固件上报",
                "subStatus": null
            },
            {
                "function": "固件上报应答",
                "topic": "/sys/8C3E488A/A66AF6D8/${deviceId}/firmware_report_ack",
                "permission": 1,
                "desc": "固件上报服务端应答",
                "subStatus": null
            },
            {
                "function": "固件查询",
                "topic": "/sys/8C3E488A/A66AF6D8/${deviceId}/ask_firmware",
                "permission": 1,
                "desc": "平台查询设备固件信息",
                "subStatus": null
            },
            {
                "function": "升级通知",
                "topic": "/sys/8C3E488A/A66AF6D8/${deviceId}/ota_notify",
                "permission": 1,
                "desc": "平台通知设备升级",
                "subStatus": null
            },
            {
                "function": "升级通知回复",
                "topic": "/sys/8C3E488A/A66AF6D8/${deviceId}/ota_notify_ack",
                "permission": 2,
                "desc": "设备收到ota通知之后回复平台",
                "subStatus": null
            },
            {
                "function": "查询配置",
                "topic": "/sys/8C3E488A/A66AF6D8/${deviceId}/ask_config",
                "permission": 1,
                "desc": "平台查询设备配置信息",
                "subStatus": null
            },
            {
                "function": "配置上报",
                "topic": "/sys/8C3E488A/A66AF6D8/${deviceId}/config_report",
                "permission": 2,
                "desc": "设备上报配置以及平台下发配置的回复均使用该topic",
                "subStatus": null
            },
            {
                "function": "下发配置",
                "topic": "/sys/8C3E488A/A66AF6D8/${deviceId}/down_config",
                "permission": 1,
                "desc": "平台给设备下发配置",
                "subStatus": null
            },
            {
                "function": "下发订阅通配",
                "topic": "/sys/8C3E488A/A66AF6D8/${deviceId}/#",
                "permission": 1,
                "desc": "下发订阅通配",
                "subStatus": null
            }
        ],
        "throughTopic": null,
        "modelTopic": null,
        "modelHexTopic": [
            {
                "function": "设备属性、事件上报",
                "topic": "/sys/8C3E488A/A66AF6D8/${deviceId}/model/hex/report",
                "permission": 2,
                "desc": "设备物模型数据上报",
                "subStatus": null
            },
            {
                "function": "平台应答",
                "topic": "/sys/8C3E488A/A66AF6D8/${deviceId}/model/hex/report_ack",
                "permission": 1,
                "desc": "平台响应设备数据上报",
                "subStatus": null
            },
            {
                "function": "平台下发属性查询、属性设置、服务调用",
                "topic": "/sys/8C3E488A/A66AF6D8/${deviceId}/model/hex/downlink",
                "permission": 1,
                "desc": "平台下发数据",
                "subStatus": null
            },
            {
                "function": "设备应答",
                "topic": "/sys/8C3E488A/A66AF6D8/${deviceId}/model/hex/downlink_ack",
                "permission": 2,
                "desc": "设备响应平台下发数据",
                "subStatus": null
            }
        ],
        "customTopic": [
            {
                "function": null,
                "topic": "/sys/sub/8C3E488A/A66AF6D8/${deviceId}/custom/pubTest",
                "permission": 1,
                "desc": "test",
                "subStatus": null
            },
            {
                "function": null,
                "topic": "/sys/pub/8C3E488A/A66AF6D8/${deviceId}/custom/testPub",
                "permission": 2,
                "desc": "test1",
                "subStatus": null
            }
        ],
        "childTopic": null
    }
}

2、传入产品productId和设备号

请求示例

{
  "productId": "620cafcb",
  "nodeEui":"0001"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "nodeTopic": [
            {
                "function": "认证",
                "topic": "/sys/device/auth",
                "permission": 2,
                "desc": "用于设备认证",
                "subStatus": 3
            },
            {
                "function": "入网",
                "topic": "/sys/device/join",
                "permission": 2,
                "desc": "用于设备入网",
                "subStatus": 3
            },
            {
                "function": "数据下行",
                "topic": "/sys/8C3E488A/A66AF6D8/0001/downlink",
                "permission": 1,
                "desc": "平台下行topic(用于认证，心跳,入网的回复)",
                "subStatus": 2
            },
            {
                "function": "心跳",
                "topic": "/sys/8C3E488A/A66AF6D8/0001/heartbeat",
                "permission": 2,
                "desc": "用于心跳上报",
                "subStatus": 3
            },
            {
                "function": "固件上报",
                "topic": "/sys/8C3E488A/A66AF6D8/0001/firmware_report",
                "permission": 2,
                "desc": "用于固件上报",
                "subStatus": 3
            },
            {
                "function": "固件上报应答",
                "topic": "/sys/8C3E488A/A66AF6D8/0001/firmware_report_ack",
                "permission": 1,
                "desc": "固件上报服务端应答",
                "subStatus": 2
            },
            {
                "function": "固件查询",
                "topic": "/sys/8C3E488A/A66AF6D8/0001/ask_firmware",
                "permission": 1,
                "desc": "平台查询设备固件信息",
                "subStatus": 2
            },
            {
                "function": "升级通知",
                "topic": "/sys/8C3E488A/A66AF6D8/0001/ota_notify",
                "permission": 1,
                "desc": "平台通知设备升级",
                "subStatus": 2
            },
            {
                "function": "升级通知回复",
                "topic": "/sys/8C3E488A/A66AF6D8/0001/ota_notify_ack",
                "permission": 2,
                "desc": "设备收到ota通知之后回复平台",
                "subStatus": 3
            },
            {
                "function": "查询配置",
                "topic": "/sys/8C3E488A/A66AF6D8/0001/ask_config",
                "permission": 1,
                "desc": "平台查询设备配置信息",
                "subStatus": 2
            },
            {
                "function": "配置上报",
                "topic": "/sys/8C3E488A/A66AF6D8/0001/config_report",
                "permission": 2,
                "desc": "设备上报配置以及平台下发配置的回复均使用该topic",
                "subStatus": 3
            },
            {
                "function": "下发配置",
                "topic": "/sys/8C3E488A/A66AF6D8/0001/down_config",
                "permission": 1,
                "desc": "平台给设备下发配置",
                "subStatus": 2
            },
            {
                "function": "下发订阅通配",
                "topic": "/sys/8C3E488A/A66AF6D8/0001/#",
                "permission": 1,
                "desc": "下发订阅通配",
                "subStatus": 2
            },
            {
                "function": "设备属性、事件上报",
                "topic": "/sys/8C3E488A/A66AF6D8/0001/model/hex/report",
                "permission": 2,
                "desc": "设备物模型数据上报",
                "subStatus": 3
            },
            {
                "function": "平台应答",
                "topic": "/sys/8C3E488A/A66AF6D8/0001/model/hex/report_ack",
                "permission": 1,
                "desc": "平台响应设备数据上报",
                "subStatus": 2
            },
            {
                "function": "平台下发属性查询、属性设置、服务调用",
                "topic": "/sys/8C3E488A/A66AF6D8/0001/model/hex/downlink",
                "permission": 1,
                "desc": "平台下发数据",
                "subStatus": 2
            },
            {
                "function": "设备应答",
                "topic": "/sys/8C3E488A/A66AF6D8/0001/model/hex/downlink_ack",
                "permission": 2,
                "desc": "设备响应平台下发数据",
                "subStatus": 3
            },
            {
                "function": null,
                "topic": "/sys/pub/8C3E488A/A66AF6D8/0001/custom/testPub",
                "permission": 2,
                "desc": "test1",
                "subStatus": 3
            },
            {
                "function": null,
                "topic": "/sys/sub/8C3E488A/A66AF6D8/0001/custom/pubTest",
                "permission": 1,
                "desc": "test",
                "subStatus": 2
            }
        ],
        "baseTopic": null,
        "throughTopic": null,
        "modelTopic": null,
        "modelHexTopic": null,
        "customTopic": null,
        "childTopic": null
    }
}

错误码

设备管理

添加设备

请求地址： /openApi/v2/node/add 传参方式： POST

备注： 无

请求参数

Body:

响应参数

data 说明

请求示例

{
    "productId":"5207C002",
    "nodeEui":"mqttDevice002",
    "deviceName":"qqqq"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "nodeId": "639ac12f8ceff74a36d5b66f",
        "nodeEui": "mqttDevice002",
        "deviceSecret": "DA1BA501D81C5C7777ED3C4B1456F704",
        "productId": "5207C002",
        "productKey": "82E9AD63B2C7D26A4B24355BE631E847"
    }
}

错误码

编辑设备

请求地址： /openApi/v2/node/edit 传参方式： POST

备注： 无

请求参数

Body:

响应参数

请求示例

{
    "nodeId":"639abdbdc7df4956b4ec4aa9",
    "deviceName":"修改设备名称测试"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": true
}

错误码

删除设备

请求地址： /openApi/v2/node/delete 传参方式： POST

备注： 无

请求参数

Body:

响应参数

请求示例

{
    "nodeId":"639abdbdc7df4956b4ec4aa9"
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": true
}

错误码

分页查询设备

请求地址： /openApi/v2/node/list 传参方式： POST

备注： 无

请求参数

Body:

响应参数

data 说明

records 说明

请求示例

{
    "page":1,
    "pageSize":1
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "records": [
            {
                "nodeId": "639ac1e78ceff74a36d5b671",
                "nodeEui": "mqttDevice00",
                "deviceName": "mqttDevice00",
                "deviceSecret": "E2947CCCEBA91B04E85CF4A9359F7DE5",
                "status": 1,
                "connected": -1,
                "productId": "5207C002",
                "productKey": "82E9AD63B2C7D26A4B24355BE631E847",
                "productName": "OpenAPI产品MQTT测试001",
                "deviceType": 0,
                "encrypted": 0,
                "upNodeId": null,
                "subDeviceCount": 0,
                "relationState": 0,
                "gatewayStatus": null,
                "localLogReport": 1,
                "otaType": null,
                "hardVer": null,
                "softVer": null,
                "versionReportAt": null,
                "createAt": "2022-12-15 14:42:47",
                "activeAt": null,
                "lastJoinAt": null,
                "lastDisconnectAt": null,
                "lastHeartbeatAt": null
            }
        ],
        "current": 1,
        "size": 1,
        "total": 38
    }
}

设备详情

请求地址： /openApi/v2/node/query 传参方式： POST

备注：

• 无设备id时，设备号和产品productId必填
• 当设备id、设备号、产品productId都有值的情况下，以设备id为准

请求参数

Body:

响应参数

data 说明

请求示例

{
    "nodeId":"639ac12f8ceff74a36d5b66f"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "nodeId": "639ac12f8ceff74a36d5b66f",
        "nodeEui": "mqttDevice002",
        "deviceName": "qqqq",
        "deviceSecret": "DA1BA501D81C5C7777ED3C4B1456F704",
        "status": 1,
        "connected": -1,
        "productId": "5207C002",
        "productKey": "82E9AD63B2C7D26A4B24355BE631E847",
        "productName": "OpenAPI产品MQTT测试001",
        "deviceType": 0,
        "encrypted": 0,
        "localLogReport": 1,
        "otaType": null,
        "hardVer": null,
        "softVer": null,
        "versionReportAt": null,
        "createAt": "2022-12-15 14:39:43",
        "activeAt": null,
        "lastJoinAt": null,
        "lastDisconnectAt": null,
        "lastHeartbeatAt": null
    }
}

错误码

自定义topic在线调试

请求地址： /openApi/v2/node/customInstruct 传参方式： POST

备注： 无

请求参数

Body:

响应参数

请求示例

{
  "nodeId": "639ac12f8ceff74a36d5b66f",
  "instruction": "FFFF",
  "topic": "/sys/sub/8C3E488A/A98F5743/lnmqtt0007/custom/test"
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": true
}

错误码

普通透传在线调试

请求地址： /openApi/v2/node/instruct 传参方式： POST

备注： 无

请求参数

Body:

响应参数

请求示例

{
  "nodeId": "639ac12f8ceff74a36d5b66f",
  "instruction": "FFFF",
  "instructionType": 0
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data":  true
}

错误码

下发配置

请求地址： /openApi/v2/node/config 传参方式： POST

备注： 无

请求参数

Body:

响应参数

请求示例

{
  "nodeId": "620cafcb40539518e647cb39",
  "configData": "{data:\"1231\"}"  
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data":  true
}

错误码

获取配置

请求地址： /openApi/v2/node/getConfig 传参方式： POST

备注： 无

请求参数

Body:

响应参数

请求示例

{
  "nodeId": "620cafcb40539518e647cb39"
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data":  true
}

错误码

批量导入设备

请求地址： /openApi/v2/node/batchAdd 传参方式： POST

备注： 同一个appId上次任务未结束，不能创建新任务

请求参数

Body:

nodeDetail 说明

响应参数

data 说明

请求示例

{
    "productId": "5207C002",
    "nodes": [{
            "nodeEui": "mqttDevice004",
            "deviceName": "004"
        },
        {
            "nodeEui": "mqttDevice005",
            "deviceName": "005"
        },
        {
            "nodeEui": "mqttDevice006",
            "deviceName": "006"
        },
        {
            "nodeEui": "mqttDevice008",
            "deviceName": "008"
        }
    ]
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "applyId": "af14f07d-8961-4a81-bd82-af29d7ca6432"
    }
}

错误码

批量导入设备批次号查询接口

请求地址： /openApi/v2/node/queryBatchAddInfo 传参方式： POST

备注： 无

请求参数

Body:

响应参数

data 说明

successList 说明

records 说明

failList 说明

请求示例

{
   "applyId":"7a6c09b5-b565-49fa-99b5-5d3c5facfbdf"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "importStatus": 1,
        "successList": {
            "records": [
                {
                    "nodeId": "63a16d278e5f354034bd69a3",
                    "nodeEui": "mqttDevice008",
                    "deviceSecret": "B3DB80BB4DE5302E3C6739715E0C1B8D",
                    "productId": "5207C002",
                    "productKey": "82E9AD63B2C7D26A4B24355BE631E847"
                }
            ],
            "current": 1,
            "size": 10,
            "total": 1
        },
        "failList": [
            {
                "nodeEui": "mqttDevice009",
                "deviceName": "009",
                "failReason": "deviceName格式非法"
            }
        ]
    }
}

子设备管理

批量添加或解除子设备

请求地址： /openApi/v2/subDevice/batchAddOrRelieve 传参方式： POST

备注： 无

请求参数

Body:

响应参数

请求示例

{
    "gatewayNodeId": "63a18ad6d2c8a94fe4cd337b",
    "subdeviceNodeIds": ["63a18b1ad2c8a94fe4cd3382", "63a18b25d2c8a94fe4cd3385"],
    "type": true
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": true
}

错误码

分页查询子设备列表

请求地址： /openApi/v2/subDevice/list 传参方式： POST

备注： 无

请求参数

Body:

响应参数

data 说明

records 说明

请求示例

{
    "nodeId": "63a18ad6d2c8a94fe4cd337b",
    "page":1,
    "pageSize": 10
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "records": [
            {
                "nodeId": "63a18b1ad2c8a94fe4cd3382",
                "nodeEui": "test0001",
                "deviceName": "test0001",
                "deviceSecret": "4BE6AC005A6586EBD805FEF56DB39902",
                "status": 1,
                "connected": -1,
                "productId": "2141E406",
                "productKey": "34A3B1D8C42C698F0469DCEF0BB51C5F",
                "productName": "网关子设备产品",
                "deviceType": 0,
                "encrypted": null,
                "upNodeId": "8C3E488A-CFFC2801-testGateWay",
                "subDeviceCount": 0,
                "relationState": 0,
                "gatewayStatus": null,
                "localLogReport": 1,
                "otaType": null,
                "hardVer": null,
                "softVer": null,
                "versionReportAt": null,
                "createAt": "2022-12-20 18:14:50",
                "activeAt": null,
                "lastJoinAt": null,
                "lastDisconnectAt": null,
                "lastHeartbeatAt": null
            }
        ],
        "current": 1,
        "size": 10,
        "total": 1
    }
}

设备分组管理

添加分组

请求地址： /openApi/v2/deviceGroup/add 传参方式： POST

备注： 无

请求参数

Body:

响应参数

data 说明

请求示例

{
  "name": "2222",
  "level": "0"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "groupId": "63a171660191fd310a0b12fb",
        "name": "2222",
        "num": "YmUce1VAKFziSANQ",
        "parentNum": null,
        "level": 1,
        "description": null,
        "createAt": "2022-12-20 16:25:10"
    }
}

错误码

编辑分组

请求地址： /openApi/v2/deviceGroup/edit 传参方式： POST

备注： 无

请求参数

Body:

响应参数

请求示例

{
   "groupId": "63a1753a257ea9623fc1744e",
   "name":"3333",
   "description":"修改名称"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": true
}

错误码

删除分组

请求地址： /openApi/v2/deviceGroup/delete 传参方式： POST

备注： 无

请求参数

Body:

响应参数

请求示例

{
   "groupId": "63a1753a257ea9623fc1744e"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": true
}

错误码

查询分组列表

请求地址： /openApi/v2/deviceGroup/list 传参方式： POST

备注： 无

响应参数

data 说明

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": [
        {
            "groupId": "63637542f2c16c3e2ec2bb3a",
            "name": "测试分组",
            "num": "0rekF4H0cZ8IM5nK",
            "parentNum": null,
            "level": 1,
            "description": null,
            "createAt": "2022-11-03 16:01:06"
        },
        {
            "groupId": "63637551f2c16c3e2ec2bb3b",
            "name": "二级分组",
            "num": "Z4LSklduJ8LJ3gPC",
            "parentNum": "0rekF4H0cZ8IM5nK",
            "level": 2,
            "description": null,
            "createAt": "2022-11-03 16:01:21"
        },
        {
            "groupId": "6363755cf2c16c3e2ec2bb3c",
            "name": "三级分组",
            "num": "s60B3vEOiLEbvpQO",
            "parentNum": "Z4LSklduJ8LJ3gPC",
            "level": 3,
            "description": null,
            "createAt": "2022-11-03 16:01:32"
        }
       ]
}

查询分组下设备

请求地址： /openApi/v2/deviceGroup/listDeviceUderGroup 传参方式： POST

备注： 无

请求参数

Body:

响应参数

data 说明

records 说明

请求示例

{
   "groupId": "63a1753a257ea9623fc1744e"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "records": [
            {
                "nodeId": "63a12afd209856044ba0962d",
                "nodeEui": "mqttDevice003",
                "deviceName": "qqqq",
                "deviceSecret": "0A79EC7E6D5C3AAD0140F6B92039D42F",
                "status": 1,
                "connected": -1,
                "productId": "5207C002",
                "productKey": "82E9AD63B2C7D26A4B24355BE631E847",
                "productName": "OpenAPI产品MQTT测试001",
                "deviceType": 0,
                "encrypted": 0,
                "upNodeId": null,
                "subDeviceCount": 0,
                "relationState": 0,
                "gatewayStatus": null,
                "localLogReport": 1,
                "otaType": null,
                "hardVer": null,
                "softVer": null,
                "versionReportAt": null,
                "createAt": "2022-12-20 11:24:45",
                "activeAt": null,
                "lastJoinAt": null,
                "lastDisconnectAt": null,
                "lastHeartbeatAt": null
            }
        ],
        "current": 1,
        "size": 10,
        "total": 1
    }
}

批量添加设备到分组

请求地址： /openApi/v2/deviceGroup/batchAddDevice 传参方式： POST

备注： 无

请求参数

Body:

响应参数

请求示例

{
    "nodeIds": "6180a3bf7571341cc90f7b55,6180aa63ea679609a7aa24e7",
    "groupId": "61e8f9a501f61368266f0deb"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": "操作结果：{success: 2,fail: 0}"
}

错误码

移除分组下面的设备

请求地址： /openApi/v2/deviceGroup/removeDevice 传参方式： POST

备注： 无

请求参数

Body:

响应参数

请求示例

{
   "groupId": "63a1753a257ea9623fc1744e",
   "nodeId":"63a16d278e5f354034bd69a3"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": true
}

错误码

查询设备分组

请求地址： /openApi/v2/deviceGroup/listGroupUnderDevice 传参方式： POST

备注： 无

请求参数

Body:

响应参数

data 说明

请求示例

{
   "nodeId": "63a12afd209856044ba0962d"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": [
        {
            "groupId": "63a1753a257ea9623fc1744e",
            "name": "3333",
            "num": "R6YzRTXaynS4Xjep",
            "parentNum": null,
            "level": 1,
            "description": "修改名称",
            "createAt": "2022-12-20 16:41:30"
        }
    ]
}

错误码

物模型

属性设置

请求地址： /openApi/v2/model/propertySet 传参方式： POST

备注：

• 当产品为物模型产品时，下发指令设置产品属性
• 调用前提，产品已定义物模型，且设置的属性为可写可读属性

请求参数

Body:

响应参数

请求示例

{
    "nodeId": "63a264fba4e4394a03996af1",
    "identifier": "prop_int",
    "value": "10"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": true
}

错误码

属性查询

请求地址： /openApi/v2/model/propertyAsk 传参方式： POST

备注：

• 当产品为物模型产品时，下发指令查询产品属性
• 调用前提，产品已定义物模型，且查询的属性已定义
• 设备收到平台下发属性查询指令后应该通过属性上报方式上报属性

请求参数

Body:

响应参数

请求示例

{
    "nodeId":"63a264fba4e4394a03996af1",
    "identifier":"prop_int"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": true
}

错误码

服务调用

请求地址： /openApi/v2/model/serviceCall 传参方式： POST

备注：

• 当产品为物模型产品时，可以通过服务调用来进行指令下发；
• 服务调用分为同步调用和异步调用，异步调用立即返回结果，同步调用其结果会在10s内返回，如果10s后才返回结果，则返回结果和异步调用结果一致
• 调用前提，产品已定义物模型，并且调用的服务标识和参数和定义的一致

请求参数

Body:

响应参数

请求示例

{
    "nodeId":"63a264fba4e4394a03996af1",
    "identifier":"switch",
    "value":"{\"on\":15}"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": true
}

错误码

设备物模型属性列表查询

请求地址： /openApi/v2/model/getPropertyReportList 传参方式： POST

备注：

• 无设备id时，设备号和产品productId必填
• 当设备id、设备号、产品productId都有值的情况下，以设备id为准

请求参数

Body:

响应参数

data 说明

请求示例

{
    "nodeId":"63a2b7d3a4e4394a03996b26"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": [
        {
            "propertyId": "681f47d7-ff8e-47a0-a69d-3c8062c95d1b",
            "time": "2022-12-21 15:38:00",
            "productId": "65451EFB",
            "nodeEui": "10MQTTH0005435",
            "identifier": "prop_bool",
            "accessMode": "rw",
            "name": "prop_bool",
            "value": "1"
            "label": "开"
        },
        {
            "propertyId": "67d343b1-eaf2-4a65-9e6a-e8130b246911",
            "time": "2022-12-21 15:38:00",
            "productId": "65451EFB",
            "nodeEui": "10MQTTH0005435",
            "identifier": "prop_float",
            "accessMode": "rw",
            "name": "prop_float",
            "value": "1.25",
            "label": "1.25"
        },
        {
            "propertyId": "e75158db-4554-458d-a46f-96717462d673",
            "time": "2022-12-21 15:38:00",
            "productId": "65451EFB",
            "nodeEui": "10MQTTH0005435",
            "identifier": "prop_int",
            "accessMode": "rw",
            "name": "prop_int",
            "value": "-16",
            "label": "-16"
        },
        {
            "propertyId": "0068db3a-c99c-490a-b208-f47dcea02410",
            "time": "2022-12-21 15:38:00",
            "productId": "65451EFB",
            "nodeEui": "10MQTTH0005435",
            "identifier": "uint8_prop",
            "accessMode": "rw",
            "name": "uint8_prop",
            "value": "255",
            "label": "255"
        }
    ]
}

错误码

查询同一属性历史列表

请求地址： /openApi/v2/model/getPropertyReportSingleList 传参方式： POST

备注：

• 无设备id时，设备号和产品productId必填
• 当设备id、设备号、产品productId都有值的情况下，以设备id为准

• 请求参数

Body:

响应参数

data 说明

records 说明

请求示例

{
    "nodeId": "63e0c7bd5bb10716fadd1cd7",
    "identifier": "prop_bool",
    "page": 1,
    "pageSize": 10
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "records": [
            {
                "propertyId": "f3e51d76-cf68-4f11-b673-864bd987b196",
                "time": "2023-02-06 17:26:22",
                "productId": "AA30C505",
                "nodeEui": "20MQTT000507",
                "identifier": "prop_bool",
                "accessMode": "rw",
                "name": "prop_bool",
                "value": "0",
                "label": null
            }
        ],
        "current": 1,
        "size": 10,
        "total": 1
    }
}

错误码

分页查询服务调用

请求地址： /openApi/v2/model/getServiceCallList 传参方式： POST

备注：

• 无设备id时，设备号和产品productId必填
• 当设备id、设备号、产品productId都有值的情况下，以设备id为准

请求参数

Body:

响应参数

data 说明

records 说明

请求示例

{
    "nodeId": "63e0c7bd5bb10716fadd1cd7",
    "identifier": "switch",
    "page": 1,
    "pageSize": 10
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "records": [
            {
                "serviceCallId": "562443c3-c109-40c1-940d-58f6127f2d37",
                "time": "2023-02-06 17:27:02",
                "productId": "AA30C505",
                "nodeEui": "20MQTT000507",
                "identifier": "switch",
                "name": "测试",
                "inputData": "{\"on\":\"100L/s\"}",
                "ouputData": null
            }
        ],
        "current": 1,
        "size": 10,
        "total": 1
    }
}

错误码

分页查询事件上报

请求地址： /openApi/v2/model/getEventReportList 传参方式： POST

备注：

• 无设备id时，设备号和产品productId必填
• 当设备id、设备号、产品productId都有值的情况下，以设备id为准

请求参数

Body:

响应参数

data 说明

records 说明

请求示例

{
    "nodeId": "63e0c7bd5bb10716fadd1cd7",
    "identifier": "TEST_EVENT",
    "page": 1,
    "pageSize": 10
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "records": [
            {
                "eventId": "1c030182-1091-4b18-859f-ace28c1711e1",
                "time": "2023-02-06 17:26:26",
                "productId": "AA30C505",
                "nodeEui": "20MQTT000507",
                "identifier": "TEST_EVENT",
                "name": "测试事件",
                "type": "warn",
                "ouputData": "{\"prop_int\":\"-70km/h\"}"
            }
        ],
        "current": 1,
        "size": 10,
        "total": 1
    }
}

错误码

OTA模块管理

添加OTA模块

请求地址： /openApi/v2/otaModule/add 传参方式： POST

备注： 无

请求参数

Body:

响应参数

data 说明

请求示例

{
    "productId": "65451EFB",
    "module": "module001",
    "moduleName": "OPENAPI2测试",
    "moduleDesc": ""
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "module": "module001",
        "moduleName": "OPENAPI2测试",
        "productId": "65451EFB",
        "productName": "网关接入子设备HEX",
        "moduleDesc": "",
        "createAt": "2022-12-30 16:39:22"
    }
}

错误码

编辑OTA模块

请求地址： /openApi/v2/otaModule/edit 传参方式： POST

备注： 无

请求参数

Body:

响应参数

请求示例

{
    "productId": "65451EFB",
    "module": "module001",
    "moduleName": "OPENAPI2测试1",
    "moduleDesc": "备注描述"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": true
}

错误码

删除OTA模块

请求地址： /openApi/v2/otaModule/delete 传参方式： POST

备注： 无

请求参数

Body:

响应参数

请求示例

{
    "productId": "65451EFB",
    "module": "module001"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": true
}

错误码

查询OTA模块详情

请求地址： /openApi/v2/otaModule/query 传参方式： POST

备注： 无

请求参数

Body:

响应参数

data 说明

请求示例

{
    "productId": "65451EFB",
    "module": "module001"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "module": "module001",
        "moduleName": "OPENAPI2测试",
        "productId": "65451EFB",
        "productName": "网关接入子设备HEX",
        "moduleDesc": "",
        "createAt": "2022-12-30 16:39:22"
    }
}

错误码

模块分页查询

请求地址： /openApi/v2/otaModule/list 传参方式： POST

备注： 无

请求参数

Body:

响应参数

data 说明

records 说明

请求示例

{
    "module": "default",
    "productId": "7E0204D0",
    "page": 1,
    "pageSize": 10
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "records": [
            {
                "module": "default",
                "moduleName": "默认",
                "productId": "7E0204D0",
                "productName": "openapiMQTT非透传产品1",
                "moduleDesc": "默认模块不可删除",
                "createAt": "2022-12-28 08:45:12"
            }
        ],
        "current": 1,
        "size": 10,
        "total": 1
    }
}

OTA固件管理

添加小固件(表单格式)

请求地址： /openApi/v2/firmware/add 传参方式： POST

备注：

• 添加固件接口，sign值计算方法与通用签名计算方法不同，请参考如何调用API中form-data签名计算示例
• 该接口适合上传较小固件，大小限制在50MB以内

请求参数

Headers：

form-data参数:

响应参数

data 说明

请求示例

name:测试固件
productId:8DC561D5
softVer:V1.0
hardVer:V2.0
module:default
remark:测试固件描述
firmwareType:1
sourceVersion:2345
file:[文件]

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "firmwareId": "602f4beb4e8bf61a7d516c23",
        "createAt": "2021-02-19 13:26:02"
    }
}

错误码

修改小固件(表单格式)

请求地址： /openApi/v2/firmware/edit 传参方式： POST

备注：

• 当固件管理下存在升级计划时，只能编辑固件名称和固件描述
• 不存在升级计划时，file可为空，此时不更新文件

请求参数

Headers：

form-data参数:

响应参数

请求示例

1、存在升级计划时

firmwareId:602f4beb4e8bf61a7d516c23
name:测试固件
remark:测试固件描述

2、无升级计划时

firmwareId:602f4beb4e8bf61a7d516c23
name:测试固件
productId:8DC561D5
softVer:V1.0
hardVer:V2.0
module:default
remark:测试固件描述
firmwareType:1
sourceVersion:2345
file:[文件]

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": true
}

错误码

添加大固件(Json格式)

请求地址： /openApi/v2/firmware/addBig 传参方式： POST

备注：

• 调用该接口保存固件信息时，用户需按顺序完成以下操作： 1. 已经调用平台开放的获取STS凭证的接口获取到了STS凭证 2. 在凭证有效期内完成固件的上传(阿里云文档地址https://help.aliyun.com/document_detail/84778.html)

  PS：流程可以参考平台开放的获取OSS文件上传STS凭证接口

• 该接口的固件大小限制在200MB以内，在请求该接口保存固件信息时会去OSS服务器上验证文件大小，超过200MB不允许保存，且平台会定时删除OSS上超过200MB的文件

请求参数

Body:

响应参数

data 说明

请求示例

{
    "name": "测试固件",
    "productId": "8DC561D5",
    "softVer": "V1.0",
    "hardVer": "V2.0",
    "md5": "5340c78b52045b3f03718d105a820ac7",
    "path": "https://xxxxxxx",
    "originalFilename": "2.jpg",
    "fileKey": "otaFirmware/1670378256275_2.jpg",
    "module": "default",
    "remark": "测试固件描述",
    "signMethod": "md5",
    "firmwareType": 1,
    "sourceVersion": "2345"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "firmwareId": "602f4beb4e8bf61a7d516c23",
        "createAt": "2021-02-19 13:26:02"
    }
}

错误码

修改大固件(Json格式)

请求地址： /openApi/v2/firmware/editBig 传参方式： POST

备注：

• 当固件管理下存在升级计划时，只能编辑固件名称和固件描述
• 不存在升级计划时，path可为空，此时不校验文件相关字段，不更新文件

请求参数

Body:

响应参数

请求示例

1、存在升级计划时

{
    "firmwareId": "602f4beb4e8bf61a7d516c23",
    "name": "测试固件",
    "remark": "测试固件描述"
}

2、无升级计划时

{
    "firmwareId": "602f4beb4e8bf61a7d516c23",
    "name": "测试固件",
    "productId": "8DC561D5",
    "softVer": "V1.0",
    "hardVer": "V2.0",
    "md5": "5340c78b52045b3f03718d105a820ac7",
    "path": "https://xxxxxxx",
    "originalFilename": "2.jpg",
    "fileKey": "otaFirmware/1670378256275_2.jpg",
    "module": "default",
    "remark": "测试固件描述",
    "signMethod": "md5",
    "firmwareType": 1,
    "sourceVersion": "2345"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": true
}

错误码

固件详情

请求地址： /openApi/v2/firmware/query 传参方式： POST

备注： 无

请求参数

Body:

响应参数

data 说明

请求示例

{ 
  "firmwareId": "63b3e8e140a321450c7d166f"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "firmwareId": "63b3e8e140a321450c7d166f",
        "createAt": "2023-01-03 16:35:44",
        "name": "测试固件",
        "productId": "FB511D31",
        "productName": "MQTT非透传免注册json950",
        "hardVer": "V2.0",
        "softVer": "V1.1",
        "signMethod": "md5",
        "size": 4616,
        "remark": "测试固件描述",
        "md5": "bcb95b23ede941e5483a316c096dd2e0",
        "originalFilename": "1.jpg",
        "fileKey": "otaFirmware/1672734942385_1.jpg",
        "firmwareType": 1,
        "sourceVersion": "",
        "updateAt": "2023-01-03 16:42:31",
        "module": "default",
        "moduleName": "默认"
    }
}

错误码

固件分页查询

请求地址： /openApi/v2/firmware/list 传参方式： POST

备注： 无

请求参数

Body:

响应参数

data 说明

records 说明

请求示例

{
    "productId": "E11822F6",
    "page": 1,
    "pageSize": 10
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "records": [
            {
                "firmwareId": "63c0f59744e95b7f8c811300",
                "createAt": "2023-01-13 14:09:27",
                "name": "TCP版本",
                "productId": "E11822F6",
                "productName": "TCP认证验证",
                "hardVer": "v1.0",
                "softVer": "v3.0.0",
                "signMethod": "md5",
                "remark": "",
                "md5": "69f9321429ff3572e81bc4f107a5a346",
                "size": 1856544,
                "originalFilename": "DDC_firmwareL4.0.0.1.bin",
                "fileKey": "otaFirmware/DDC_firmwareL4.0.0.1.bin",
                "firmwareType": 1,
                "sourceVersion": "",
                "updateAt": "2023-01-13 14:09:27",
                "module": "default",
                "moduleName": "默认"
            }
        ],
        "current": 1,
        "size": 10,
        "total": 1
    }
}

OTA升级

创建OTA升级计划

请求地址： /openApi/v2/otaPlan/add 传参方式： POST

备注： 返回数据中，batchUuid必存在，升级计划planId，不一定返回，如没有需要通过详情接口利用batchUuid获取

请求参数

Body:

响应参数

data 说明

请求示例

1、静态升级-所有设备-定时升级-重试2次

{
    "firmwareId": "63b3e8e140a321450c7d166f",
    "notifyType": 1,
    "strategy": 0,
    "scope": 0,
    "softVerScope": [
        "v1.0.0"
    ],
    "startAt": "2023-01-06 17:00:00",
    "endAt": "2023-01-10 18:00:00",
    "retryInterval": 30,
    "retryLimit": 2,
    "expireTime": 30,
    "overwrite": 1,
    "triggerType": 1,
    "remark": "备注"
}

2、动态升级

{
    "firmwareId": "63b3e8e140a321450c7d166f",
    "notifyType": 0,
    "strategy": 1,
    "scope": 1,
    "softVerScope": [
        "v1.0.0"
    ],
    "retryInterval": 0,
    "overwrite": 0,
    "triggerType": 1,
    "remark": "动态升级"
}

3、静态升级-指定设备-立即推送-云端触发-不重试-不覆盖

{
    "firmwareId": "63b3e8e140a321450c7d166f",
    "notifyType": 0,
    "strategy": 0,
    "scope": 0,
    "retryInterval": 0,
    "overwrite": 0,
    "triggerType": 2,
    "nodeIds":["632ab50ea3e8582b78b38fee"],
    "remark": "指定设备升级"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "batchUuid": "a5d15326-5c64-4c71-b8ca-d047f2c27ba1",
        "planId": "63b79188a5cdd8367db36bf0"
    }
}

取消OTA升级计划

请求地址： /openApi/v2/otaPlan/cancel 传参方式： POST

备注： 无

请求参数

Body:

响应参数

请求示例

{
    "planId": "306134d4050d4800a8ab8bce88b1db43"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": true
}

OTA升级计划分页查询

请求地址： /openApi/v2/otaPlan/list 传参方式： POST

备注： 无

请求参数

Body:

响应参数

data 说明

records 说明

请求示例

{
    "firmwareId": "63b3e8e140a321450c7d166f",
    "page": 1,
    "pageSize": 10,
    "status": 0,
    "strategy": 1
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "records": [
            {
                "planId": "63bb7962d68a1239d503160e",
                "productId": "FB511D31",
                "productName": "MQTT非透传免注册json950",
                "firmwareId": "63b3e8e140a321450c7d166f",
                "strategy": 1,
                "scope": 1,
                "softVerScope": [
                    "v1.0.0"
                ],
                "targetSoftVer": "V1.01",
                "notifyType": 0,
                "triggerType": 1,
                "startAt": "2023-01-09 10:18:10",
                "endAt": null,
                "retryInterval": 0,
                "retryLimit": 0,
                "expireTime": 1440,
                "overwrite": 0,
                "status": 0,
                "remark": "动态升级",
                "createAt": "2023-01-09 10:18:10",
                "updateAt": "2023-01-09 10:18:10",
                "module": "default",
                "isCancel": false
            }
        ],
        "current": 1,
        "size": 10,
        "total": 1
    }
}

升级计划详情

请求地址： /openApi/v2/otaPlan/query 传参方式： POST

备注： 无

请求参数

Body:

响应参数

data 说明

请求示例

{
    "planId": "63bb7962d68a1239d503160e"
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "planId": "63bb7962d68a1239d503160e",
        "productId": "FB511D31",
        "productName": "MQTT非透传免注册json950",
        "firmwareId": "63b3e8e140a321450c7d166f",
        "strategy": 1,
        "scope": 1,
        "softVerScope": [
            "v1.0.0"
        ],
        "targetSoftVer": "V1.01",
        "notifyType": 0,
        "triggerType": 1,
        "startAt": "2023-01-09 10:18:10",
        "endAt": null,
        "retryInterval": 0,
        "retryLimit": 0,
        "expireTime": 1440,
        "overwrite": 0,
        "status": 0,
        "remark": "动态升级",
        "createAt": "2023-01-09 10:18:10",
        "updateAt": "2023-01-09 10:18:10",
        "module": "default",
        "isCancel": false
    }
}

升级计划详情-设备升级任务列表

请求地址： /openApi/v2/otaPlan/tasks 传参方式： POST

备注： 无

请求参数

Body:

响应参数

data 说明

records 说明

请求示例

{
    "planId": "63c0eda074ef5e16c5b66468",
    "page":1,
    "pageSize":10
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "records": [
            {
                "taskId": "63c0eda274ef5e16c5b66469",
                "planId": "63c0eda074ef5e16c5b66468",
                "firmwareId": "63c0ed758fea9e716ae06f70",
                "productId": "A50F56D0",
                "productName": "MQTT20网关设备",
                "nodeEui": "20MQTTWJ00001",
                "downId": "77AF1957",
                "softVer": "v2.1.3",
                "hardVer": "v1.0.1",
                "targetSoftVer": "v3.0.0",
                "otaType": 2,
                "startAt": "2023-01-13 13:35:28",
                "endAt": null,
                "retryInterval": 0,
                "retryLimit": 0,
                "retryCnt": 0,
                "overwrite": 0,
                "createdStrategy": 1,
                "errorInfo": null,
                "createAt": "2023-01-13 13:35:29",
                "updateAt": "2023-01-13 13:35:29",
                "status": 0,
                "triggerType": 2,
                "delayTaskId": null,
                "module": "default",
                "expireAtStamp": null,
                "expirationTime": 1673674528166
            }
        ],
        "current": 1,
        "size": 10,
        "total": 1
    }
}

设备升级任务取消/重新升级

请求地址： /openApi/v2/otaPlan/taskCancelOrReCreate 传参方式： POST

备注： 无

请求参数

Body:

响应参数

请求示例

1、取消升级

{
  "taskId": "601bff8b5b3bb45bef53c230,601bff8b5b3bb45bef53c231",
  "opt": 0
}

2、重新升级

{
    "taskId": "617109258ca4fb051b307ad5",
    "opt": 1
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": true
}

错误码

应用推送

添加推送应用

请求地址： /openApi/v2/pushApp/add 传参方式： POST

备注： 无

请求参数

Body:

httpPushInfo 说明

mqttPushInfo 说明

rabbitMqPushInfo 说明

响应参数

data 说明

示例

1、http

请求示例

{
    "appName": "http推送应用",
    "httpPushInfo": {
        "httpConnectRemote": "http://localhost:8080/receive/conn",
        "httpHeartBeatRemote": "http://localhost:8080/receive/heart",
        "httpOtaResultRemote": "http://localhost:8080/receive/ota",
        "httpUplinkRemote": "http://localhost:8080/receive/uplink",
        "httpLifeCycleRemote": "http://localhost:8080/receive/lifeCycle",
        "httpSubDeviceRemote": "http://localhost:8080/receive/subDevice",
        "httpNeedVerify": 0
    },
    "pushDataFormat": 1,
    "pushType": 0,
    "status": 1,
    "productIds": [
        "B7C71C40"
    ]
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "appId": "xxxx",
        "appSecret": "xxx",
        "status": 1,
        "appName": "http推送应用",
        "createAt": "2023-01-15 15:56:00",
        "productIds": [
            "B7C71C40"
        ],
        "productNames": [
            "推送测试产品"
        ],
        "pushType": 0,
        "pushDataFormat": 1,
        "httpPushInfo": {
            "httpUplinkRemote": "http://localhost:8080/receive/uplink",
            "httpHeartBeatRemote": "http://localhost:8080/receive/heart",
            "httpConnectRemote": "http://localhost:8080/receive/conn",
            "httpOtaResultRemote": "http://localhost:8080/receive/ota",
            "httpLifeCycleRemote": "http://localhost:8080/receive/lifeCycle",
            "httpSubDeviceRemote": "http://localhost:8080/receive/subDevice",
            "httpNeedVerify": 0
        },
        "mqttPushInfo": null,
        "rabbitMqPushInfo": null
    }
}

2、mqtt

请求示例

{
    "appName": "mqtt推送应用",
    "mqttPushInfo": {
        "mqttBroker": "xxxx.com",
        "mqttPort": 1883,
        "mqttAdmin": "xxxx",
        "mqttPassword": "xxxx"
    },
    "pushDataFormat": 1,
    "pushType": 1,
    "status": 1,
    "productIds": [
        "B7C71C40"
    ]
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "appId": "xxxx",
        "appSecret": "xxxx",
        "status": 1,
        "appName": "mqtt推送应用",
        "createAt": "2023-01-15 15:56:50",
        "productIds": [
            "B7C71C40"
        ],
        "productNames": [
            "推送测试产品"
        ],
        "pushType": 1,
        "pushDataFormat": 1,
        "httpPushInfo": null,
        "mqttPushInfo": {
            "mqttBroker": "xxxx.com",
            "mqttPort": 1883,
            "mqttAdmin": "xxxx",
            "mqttPassword": "xxxx",
            "mqttQos": 2,
            "mqttUplinkTopic": "xxxx/app-data",
            "mqttConnectTopic": "xxxx/connect",
            "mqttHeartBeatTopic": "xxxx/heartbeat",
            "mqttOtaResultTopic": "xxxx/ota-result",
            "mqttLifeCycleTopic": "xxxx/life-cycle",
            "mqttSubDeviceTopic": "xxxx/sub-device"
        },
        "rabbitMqPushInfo": null
    }
}

3、rabbitmq

请求示例

{
    "appName": "rabbitmq推送应用",
    "rabbitMqPushInfo": {
        "rabbitBroker": "rabbitmq.xxxx.com",
        "rabbitPort": 5672,
        "rabbitAdmin": "xxxx",
        "rabbitPassword": "xxxx",
        "rabbitVHost": "qa",
        "rabbitExchangePrefix": "xxx"
    },
    "pushDataFormat":1,
    "pushType": 2,
    "status": 1,
    "productIds": [
        "B7C71C40"
    ]
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": {
        "appId": "xxxxx",
        "appSecret": "xxxxx",
        "status": 1,
        "appName": "rabbitmq推送应用",
        "createAt": "2023-01-15 15:59:37",
        "productIds": [
            "B7C71C40"
        ],
        "productNames": [
            "推送测试产品"
        ],
        "pushType": 2,
        "pushDataFormat": 1,
        "httpPushInfo": null,
        "mqttPushInfo": null,
        "rabbitMqPushInfo": {
            "rabbitBroker": "rabbitmq.xxxx.com",
            "rabbitPort": 5672,
            "rabbitAdmin": "xxxx",
            "rabbitPassword": "xxxx",
            "rabbitVHost": "qa",
            "rabbitUplinkExchange": "xxx-app-data",
            "rabbitConnectExchange": "xxx-connect",
            "rabbitHeartBeatExchange": "xxx-heartbeat",
            "rabbitOtaResultExchange": "xxx-ota-result",
            "rabbitExchangePrefix": "xxx",
            "rabbitLifeCycleExchange": "xxx-life-cycle",
            "rabbitSubDeviceExchange": "xxx-sub-device"
        }
    }
}

错误码

编辑推送应用

请求地址： /openApi/v2/pushApp/edit 传参方式： POST

备注：

• 只能编辑对应推送类型的参数
• 如果编辑信息包含 httpPushInfo/rabbitMqPushInfo/mqttPushInfo层级下字段需要全部包含，如果字段未包含的情况下，对应推送则将设置为空

请求参数

Body:

mqttPushInfo 说明

rabbitMqPushInfo 说明

响应参数

请求示例

{
    "appId": "63bbda6a9139652aab3e7d54",
    "mqttPushInfo": {
        "mqttBroker": "xxxx.com",
        "mqttPort": 1883,
        "mqttAdmin": "xxxx",
        "mqttPassword": "xxxx",
        "mqttQos": 2,
        "mqttUplinkTopic": "xxxx/app-data",
        "mqttConnectTopic": "xxxx/connect",
        "mqttHeartBeatTopic": "xxxx/heartbeat",
        "mqttOtaResultTopic": "xxxx/ota-result",
        "mqttLifeCycleTopic": "xxxx/life-cycle",
        "mqttSubDeviceTopic": "xxxx/sub-device"
    },
    "pushDataFormat": 1,
    "pushType": 1,
    "status": 1,
    "productIds": [
        "D1784C95","8C09C149"
    ]
}

响应示例

{
    "code": "8001",
    "msg": "操作成功",
    "data": true
}

错误码

删除推送应用

请求地址： /openApi/v2/pushApp/delete 传参方式： POST

备注： 无

请求参数

Body:

响应参数

请求示例

{
  "appId": "601bb356112352169e31a57c"
}

响应示例

{
  "code": "8001",
  "msg": "操作成功",
  "data": true
}

分页查询消息推送应用

请求地址： /openApi/v2/pushApp/list 传参方式： POST

备注： 无

请求参数

Body:

响应参数