ES Documentation
手册
API
手册
API
简体中文

列表

OpenAPI 文档点击此处查阅中心服务器数据服务在设备类别下的 OpenAPI 文档。

以下内容为提升开发效率，在代码开发前，提供请求与响应的示例示意，助力开发人员深入理解业务需求。同时，这也是对代码注释生成的 OpenAPI 文档的补充说明，会对代码注释未覆盖的部分展开详细阐释，从而减轻代码开发的工作量。

请求路径

/main-service/main-api/v1/retail/device/data-acquisition-device/list

请求结构 (Api request)

字段

TIP
  • Query 参数:
    • options：查询选项, 示例值: dataAcquisitionServer,deviceShare,deviceShareList, 示例值说明:
      • dataAcquisitionServer：绑定的采集服务器信息。
      • deviceShare：设备共享信息。当 state 不等于 bind 时，此信息呈现的是他人共享的设备，共享关系为一对一。
      • deviceShareList：设备共享列表信息。当 state 等于 bind 时，此列表呈现的是自有设备已共享给他人的信息，共享关系为一对多。
    • cache：默认值 true，表示从缓存读取数据；可设为 false 表示不从缓存读取），支持 true/false、yes/no、on/off、1/0、Y/N 等格式

示例

/main-service/main-api/v1/retail/device/data-acquisition-device/list?options=dataAcquisitionServer,deviceShare,deviceShareList&cache=false

示意

  • 主界面使用 options=dataAcquisitionServer
  • 设备共享列表界面使用 options=deviceShare,deviceShareList
  • 尽量避免使用 cache=false

响应结构 (Api response)

字段

TIP
  • data：响应数据，此为可选字段，仅在实际需要返回数据时才会显示相应内容。
    • webrtcOnlineStatus：设备上的 webrtc 程序是否在线。为避免频繁调用该接口获取 webrtc 在线状态（此操作较为消耗性能），建议通过 mqtt 批量向服务端获取，系统额外提供了相应接口。
    • iotOnlineStatus：设备上的 iot 程序是否在线。同样，为避免频繁调用该接口获取 iot 在线状态（此操作较为消耗性能），建议通过 mqtt 批量向服务端获取，系统额外提供了相应接口。
    • state：当 state 等于 bind 时，表示该设备为自有设备；当 state 不等于 bind 时，表示该设备是他人共享的设备，sourceUsername 即为共享者的用户名。
    • dataAcquisitionServer：绑定的采集服务器信息。
    • deviceShare：设备共享信息。当 state 不等于 bind 时，此信息呈现的是他人共享的设备，共享关系为一对一。
    • deviceShareList：设备共享列表信息。当 state 等于 bind 时，此列表呈现的是自有设备已共享给他人的信息，共享关系为一对多。
    • sourceUsername: 共享者或管理者的用户名。当 state 为 bind 时，则表示入库管理员的用户名。

示例

HTTP: response application/json
1{
2    "timestamp": 1750406579448,
3    "status": 200,
4    "data": [
5        {
6            "deviceId": "d62fc658289b4354a3deeece043e4ed1",
7            "deviceNo": "90000188",
8            "name": "90000188",
9            "state": "To be confirm share",
10            "createdUsername": "svmikg",
11            "createdTime": 1750297488,
12            "lastModifiedUsername": "svmikg",
13            "lastModifiedTime": 1750297488,
14            "tenantId": "f581e0f79e934fffa85b14c1c1efacb3",
15            "sourceUsername": "svmikg",
16            "sourceTenantId": "7d187c6865df4d639c1b688a9fa8c790",
17            "sourceDeviceId": "620c35e4d0554013b6a38d5d637c49ff",
18            "iotOnlineStatus": false,
19            "webrtcOnlineStatus": false,
20            "onlineStatus": true,
21            "dataAcquisitionServer": {
22                "deviceId": "hpoPD9I7n8rYDXwiDLUmN",
23                "deviceNo": "test-111",
24                "name": "test-111",
25                "createdUsername": "admin",
26                "createdTime": 1747798318,
27                "lastModifiedUsername": "admin",
28                "lastModifiedTime": 1747798474,
29                "tenantId": "default",
30                "dataAcquisitionServerId": "hpoPD9I7n8rYDXwiDLUmN",
31                "domainNameWebPort": 3000,
32                "domainNameUploadPort": 3000,
33                "externalIpWebPort": 3000,
34                "externalIpUploadPort": 3000,
35                "internalIpWebPort": 3000,
36                "internalIpUploadPort": 3000,
37                "privateIpWebPort": 3000,
38                "privateIpUploadPort": 3000
39            },
40            "deviceShare": {
41                "deviceShareId": "e853712d64e73209f3cd3a1dd849833e",
42                "deviceId": "620c35e4d0554013b6a38d5d637c49ff",
43                "targetUsername": "zebfuu",
44                "state": "To be confirm share",
45                "inviteTime": 1750297488,
46                "createdUsername": "svmikg",
47                "createdTime": 1750297488,
48                "lastModifiedUsername": "svmikg",
49                "lastModifiedTime": 1750297488,
50                "tenantId": "7d187c6865df4d639c1b688a9fa8c790",
51                "targetTenantId": "f581e0f79e934fffa85b14c1c1efacb3"
52            }
53        },
54        {
55            "deviceId": "78bc8024b9424cff8eb0d23b4730faf5",
56            "deviceNo": "24093200478",
57            "name": "测试设备",
58            "state": "bind",
59            "createdUsername": "zebfuu",
60            "createdTime": 1750398648,
61            "lastModifiedUsername": "zebfuu",
62            "lastModifiedTime": 1750398648,
63            "tenantId": "f581e0f79e934fffa85b14c1c1efacb3",
64            "sourceUsername": "admin",
65            "sourceTenantId": "default",
66            "sourceDeviceId": "b8mCAOrZ0WIOIzUgeLw0L",
67            "iotOnlineStatus": false,
68            "webrtcOnlineStatus": false,
69            "onlineStatus": true,
70            "dataAcquisitionServer": {
71                "deviceId": "hpoPD9I7n8rYDXwiDLUmN",
72                "deviceNo": "test-111",
73                "name": "test-111",
74                "createdUsername": "admin",
75                "createdTime": 1747798318,
76                "lastModifiedUsername": "admin",
77                "lastModifiedTime": 1747798474,
78                "tenantId": "default",
79                "dataAcquisitionServerId": "hpoPD9I7n8rYDXwiDLUmN",
80                "domainNameWebPort": 3000,
81                "domainNameUploadPort": 3000,
82                "externalIpWebPort": 3000,
83                "externalIpUploadPort": 3000,
84                "internalIpWebPort": 3000,
85                "internalIpUploadPort": 3000,
86                "privateIpWebPort": 3000,
87                "privateIpUploadPort": 3000
88            },
89            "deviceShareList": [
90                {
91                    "deviceShareId": "70ac13627576e3806099a19198b07363",
92                    "deviceId": "78bc8024b9424cff8eb0d23b4730faf5",
93                    "targetUsername": "svmikg",
94                    "state": "To be confirm share",
95                    "inviteTime": 1750399164,
96                    "createdUsername": "zebfuu",
97                    "createdTime": 1750399164,
98                    "lastModifiedUsername": "zebfuu",
99                    "lastModifiedTime": 1750399164,
100                    "tenantId": "f581e0f79e934fffa85b14c1c1efacb3",
101                    "targetTenantId": "7d187c6865df4d639c1b688a9fa8c790",
102                    "deviceManage": "zebfuu"
103                }
104            ]
105        }
106    ]
107}

示意

TIP

原型设计

  • 设备列表
    • 设备: 24076780002
      • state 值为 bind，此设备属于自己。
      • 设备编号
      • 设备名称
      • 采集服务器编号等其他字段（此处省略）
      • 设备共享列表（分享给他人）
        • 设备共享
          • 目标用户名: 913251650@qq.com
          • 设备共享标识
          • 邀请时间等其他字段（此处省略）
        • 设备共享
          • 目标用户名: 913251651@qq.com
          • 设备共享标识
          • 邀请时间等其他字段（此处省略）
    • 设备: 24076780003
      • state 为 bind，此设备属于自己。
      • 设备编号
      • 设备名称
      • 采集服务器编号等其他字段（此处省略）
      • 设备共享列表（分享给他人）：为空
    • 设备: 24076780004
      • state 不等于 bind，表示该设备是他人共享的，sourceUsername 为共享者用户名。
      • 设备编号
      • 设备名称
      • 采集服务器编号等其他字段（此处省略）
      • 设备共享
        • 设备共享标识
        • 邀请时间等其他字段（此处省略）
目录