MQTT网络设备Api
MQTT 网络设备的字段请查看字段说明
# 列表查询
接口说明
根据查询条件查询 MQTT 网络设备列表。
接口版本
v1接口地址
/api-web-v1/net-mqtt-devices
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 | 默认 | 示例 |
---|---|---|---|---|---|---|
query | label | string | false | 模糊查询字段 | name | |
query | search | string | false | 模糊查询值 | 测试 | |
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 | 指定关联表查询,查询多个关联表用逗号分隔 | checks,operates | |
query | hardwareWord | string | false | 指定设备字典_id | 5ebe578fb64352001b1f3876 | |
query | depart | string | false | 层级 | _id |
请求参数举例
注意
GET 请求所有参数类型都会变成 string 拼接在 url 上面,文档为了表述清晰,将示例结构以 json 格式编写
{
"page": "1",
"limit": "10",
"sort": "-createdAt",
"autopopulate": "false"
}
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回数据 |
-total | number | False | MQTT 网络设备总条数 |
-rows | array | False | 当前返回的 MQTT 网络设备对象列表 |
返回参数举例
{
"code": 0,
"data": {
"total": 9,
"rows": [
{
"range": 60000,
"status": 0,
"line": false,
"lineTime": "2023-05-12T01:49:31.529Z",
"tags": [],
"_id": "645c58190cbebc64e29057f3",
"clientId": "l3u75",
"shortAddress": "l3u75",
"name": "test1",
"control": "5feaed768c1afe001bca0f3f",
"hardwareWord": {
"_id": "645c89e3102dc0bd2ff221b8",
"name": "上海途鸽MQTT透传网关"
},
"attribute": [],
"creator": "5da994550dc418001b95d36f",
"createdAt": "2023-05-11T02:51:05.312Z",
"updatedAt": "2023-05-15T08:26:27.381Z",
"__v": 0,
"tcp_client_ip": "172.16.17.135",
"mac": "123123",
"username": "",
"id": "645c58190cbebc64e29057f3"
}
]
}
}
# 查询单个设备
接口说明
根据查询条件查询单个 MQTT 网络设备。
接口版本
v1接口地址
/api-web-v1/net-mqtt-devices/one
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 | 默认 | 示例 |
---|---|---|---|---|---|---|
query | label | string | false | 模糊查询字段 | name | |
query | search | string | false | 模糊查询值 | 测试 | |
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 | sort | string | false | 根据哪个字段排序 | _id | -createdAt |
query | select | string | false | 只查询部分字段,字段名之间用过空格分隔,去掉某个字段的查询字段名前面加- | ||
query | autopopulate | boolean | false | 自动关联数据,部分字段自动关联关系表查询,设置这个值可开关自动联表查询 | true | false |
query | populate | string | false | 指定关联表查询,查询多个关联表用逗号分隔 | checks,operates |
请求参数举例
注意
GET 请求所有参数类型都会变成 string 拼接在 url 上面,文档为了表述清晰,将示例结构以 json 格式编写
{
"sort": "-createdAt",
"autopopulate": "false"
}
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回数据 |
返回参数举例
{
"code": 0,
"data": {
"range": 60000,
"status": 0,
"line": false,
"lineTime": "2023-05-12T01:49:31.529Z",
"tags": [],
"_id": "645c58190cbebc64e29057f3",
"clientId": "l3u75",
"shortAddress": "l3u75",
"name": "test1",
"control": "5feaed768c1afe001bca0f3f",
"hardwareWord": {
"_id": "645c89e3102dc0bd2ff221b8",
"name": "上海途鸽MQTT透传网关"
},
"attribute": [],
"creator": "5da994550dc418001b95d36f",
"createdAt": "2023-05-11T02:51:05.312Z",
"updatedAt": "2023-05-15T08:26:27.381Z",
"__v": 0,
"tcp_client_ip": "172.16.17.135",
"mac": "123123",
"username": "",
"id": "645c58190cbebc64e29057f3"
}
}
# 查询设备 ID
接口说明
根据设备 ID 查询设备
接口版本
v1接口地址
/api-v1/net-mqtt-devices/:id
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | MQTT 网络设备 ID |
请求参数举例
注意
GET 请求所有参数类型都会拼接在 url 上面,文档为了表述清晰,将示例结构以 json 格式编写
{ "_id": "645c58190cbebc64e29057f3" }
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | false | 返回设备信息 |
返回参数举例
{
"code": 0,
"data": {
"range": 60000,
"status": 0,
"line": false,
"lineTime": "2023-05-12T01:49:31.529Z",
"tags": [],
"_id": "645c58190cbebc64e29057f3",
"clientId": "l3u75",
"shortAddress": "l3u75",
"name": "test1",
"control": "5feaed768c1afe001bca0f3f",
"hardwareWord": {
"_id": "645c89e3102dc0bd2ff221b8",
"name": "上海途鸽MQTT透传网关"
},
"attribute": [],
"creator": "5da994550dc418001b95d36f",
"createdAt": "2023-05-11T02:51:05.312Z",
"updatedAt": "2023-05-15T08:26:27.381Z",
"__v": 0,
"tcp_client_ip": "172.16.17.135",
"mac": "123123",
"username": "",
"id": "645c58190cbebc64e29057f3"
}
}
# 新建
接口说明
新建一个 MQTT 网络设备。第三方不建议直接调用 MQTT 网络设备新建接口,此接口创建需实际设备。
接口版本
v1接口地址
/api-v1/net-mqtt-devices
请求方法
POST
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
body | - | Object | True | MQTT 网络设备对象字段说明 |
- | name | String | True | 网关名称 |
- | shortAddress | number | True | 网关类型 0:边缘网关 1:云网关 |
- | range | String | True | 服务类型 OpenMqttApi |
- | clientId | ObjectId | True | 服务信息OpenMqttApi接口说明 |
- | mac | ObjectId | True | 服务信息OpenMqttApi接口说明 |
请求参数举例
{
"range": 5000,
"clientId": "gef2u",
"shortAddress": "gef2u",
"name": "TEST",
"mac": "231000000247",
"control": "5feaed768c1afe001bca0f3f",
"hardwareWord": "645c89e3102dc0bd2ff221b8",
"scanCode": "1222208002304"
}
// Make sure to add code blocks to your code group
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回创建的对象 |
返回参数举例
{
"code": 0,
"data": {
"range": 5000,
"status": 0,
"line": false,
"lineTime": "2023-05-15T03:42:32.821Z",
"tags": [],
"_id": "64631b1c7b72d6d4281cfc2d",
"clientId": "gef2u",
"shortAddress": "gef2u",
"name": "TEST",
"mac": "231000000247",
"control": "5feaed768c1afe001bca0f3f",
"hardwareWord": "645c89e3102dc0bd2ff221b8",
"attribute": [],
"scanCode": "1222208002304",
"creator": "5da994550dc418001b95d36f",
"createdAt": "2023-05-16T05:56:44.052Z",
"updatedAt": "2023-05-16T05:56:44.052Z",
"__v": 0,
"id": "64631b1c7b72d6d4281cfc2d"
}
}
第三方不建议直接调用 MQTT 网络设备新建接口,此接口创建需实际设备。文档不提供新增在线调试
# 编辑
接口说明
修改 MQTT 网络设备。第三方不建议直接调用 MQTT 网络设备修改接口,此接口使用需实际设备。
接口版本
v1接口地址
/api-v1/net-mqtt-devices/:id
请求方法
PUT
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 修改的 MQTT 网络设备 ID |
body | - | Object | True | MQTT 网络设备对象字段说明 |
请求参数举例
{
"name": "TEST1",
}
// Make sure to add code blocks to your code group
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回创建的对象 |
返回参数举例
{
"code": 0,
"data": {
"range": 5000,
"status": 0,
"line": false,
"lineTime": "2023-05-15T03:42:32.821Z",
"tags": [],
"_id": "64631b1c7b72d6d4281cfc2d",
"clientId": "gef2u",
"shortAddress": "gef2u",
"name": "TEST",
"mac": "231000000247",
"control": "5feaed768c1afe001bca0f3f",
"hardwareWord": "645c89e3102dc0bd2ff221b8",
"attribute": [],
"scanCode": "1222208002304",
"creator": "5da994550dc418001b95d36f",
"createdAt": "2023-05-16T05:56:44.052Z",
"updatedAt": "2023-05-16T05:56:44.052Z",
"__v": 0,
"id": "64631b1c7b72d6d4281cfc2d"
}
}
第三方不建议直接调用 MQTT 网络设备修改接口,此接口修改需实际设备。文档不提供修改在线调试
# 删除
接口说明
删除一个 MQTT 网络设备。第三方不建议直接调用 MQTT 网络设备删除接口,此接口需实际设备。
接口版本
v1接口地址
/api-v1/net-mqtt-devices/:id
请求方法
DELETE
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 删除的 MQTT 网络设备 ID |
请求参数举例
只需发送删除设备的 ID
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
message | string | false | 成功删除返回 complete |
返回参数举例
{
"code": 0,
"message": "complete"
}
第三方不建议直接调用 MQTT 网络设备删除接口,此接口需实际设备。文档不提供删除在线调试
# 查询主题
接口说明
根据设备 ID 查询主题
接口版本
v1接口地址
/api-v1/net-mqtt-devices/short-sub-pub
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | MQTT 网络设备 ID |
请求参数举例
注意
GET 请求所有参数类型都会拼接在 url 上面,文档为了表述清晰,将示例结构以 json 格式编写
{ "_id": "645c58190cbebc64e29057f3" }
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | false | 返回设备信息 |
返回参数举例
{
"code": 0,
"data": {
"subTopic": "nayota-prod/15258284638/mgtvs/down/post/open-mqtt-api/tfe2d86/mgtvs",
"subTopicShort": "mcK0s1DgW3g4",
"pubTopic": "nayota-prod/15258284638/mgtvs/up/post/open-mqtt-api/tfe2d86/mgtvs",
"pubTopicShort": "N18iBM0gS1ib",
}
}
# 简易添加
接口说明
简易添加一个 MQTT 网络设备
接口版本
v1接口地址
/api-v1/net-mqtt-devices/create-simple
请求方法
POST
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
body | - | Object | True | 网关信息对象字段说明 |
- | name | String | True | 网关名称 |
- | control | ObjectId | True | 网关ID |
- | hardwareWord | ObjectId | True | 字典ID |
- | mac | String | True | 设备mac地址 |
请求参数举例
{
"name": "测试MQTT",
"control": "5feaed458c1afe001bca0c5a",
"hardwareWord": "OpenMqttApi",
"mac":'231000000247'
}
// Make sure to add code blocks to your code group
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回创建的对象 |
返回参数举例
{
"code": 0,
"data": {
"range": 5000,
"status": 0,
"line": false,
"lineTime": "2023-05-18T07:18:11.243Z",
"tags": [],
"_id": "6465d14672db352e90f3d15f",
"attribute": [],
"mac":"231000000247"
"shortAddress": "mgtvs",
"clientId": "mgtvs",
"control": "6465cbd6ba28ca265d86f985",
"name": "测试MQTT",
"hardwareWord": {
"_id": "5f97b17ba4475c001b16eec3",
"name": "MQTT透传服务/通道"
},
"creator": "5da855b71816bc001be72f4b",
"createdAt": "2023-05-18T07:18:30.783Z",
"updatedAt": "2023-05-18T07:18:30.783Z",
"__v": 0,
"id": "6465d14672db352e90f3d15f"
}
}