物联网平台外部访问数据定义


获取设备实时数据

<p><strong>日志:</strong> </p> <table> <thead> <tr> <th style="text-align: left;">版本号</th> <th style="text-align: left;">撰写人</th> <th style="text-align: left;">时间</th> <th>修改内容</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">VA 1.0.0</td> <td style="text-align: left;">lee</td> <td style="text-align: left;">2019-06-08 20:32:56 星期六</td> <td>创建</td> </tr> <tr> <td style="text-align: left;">VA 1.0.1</td> <td style="text-align: left;">张才进</td> <td style="text-align: left;">2022-04-26 09:59:35 星期二</td> <td>修改</td> </tr> <tr> <td style="text-align: left;">VA 1.0.2</td> <td style="text-align: left;">lee</td> <td style="text-align: left;">2024-06-26 13:17:40 星期三</td> <td>此接口增加了流控限制</td> </tr> </tbody> </table> <p><strong>简要描述:</strong> </p> <ul> <li>获取设备实时数据 </li> </ul> <p><strong>注意:</strong></p> <ul> <li>如果设备当前为报警/故障状态,此接口暂不返回设备的异常类型或者描述,设备的异常记录可通过接口:[获取设备状态历史数据](<a href="https://www.showdoc.com.cn/382341824968230/3594748888489717">https://www.showdoc.com.cn/382341824968230/3594748888489717</a> &quot;获取设备状态历史数据&quot;)来获取</li> <li>此接口有<strong>流控限制</strong>,当前为单客户端ip:<strong>5次/秒</strong></li> <li>如果您的业务需要获取设备实时的状态,建议接入[数据推送](<a href="https://www.showdoc.com.cn/382341824968230/5021335889176096">https://www.showdoc.com.cn/382341824968230/5021335889176096</a> &quot;数据推送&quot;),而非通过定时来轮询此接口:1. 定时轮询效率不高;2. 设备在某些情况下可能短时间有多次状态变化,定时轮询会有数据遗漏。</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>https://www.zsdcloud.cn:8443/openApi/equipment/select.action</code> </li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST </li> </ul> <p><strong>参数:</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">keyCode</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>设备标识码</td> </tr> <tr> <td style="text-align: left;">version</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>版本,当前版本: <code>V2</code>,注意是大写的字母V</td> </tr> <tr> <td style="text-align: left;">childDeviceKey</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>子设备识别码</td> </tr> </tbody> </table> <p><strong>返回示例</strong></p> <pre><code> { &amp;quot;statusCode&amp;quot;: 200, &amp;quot;message&amp;quot;: &amp;quot;Success&amp;quot;, &amp;quot;result&amp;quot;: { &amp;quot;equipmentInfo&amp;quot;: { &amp;quot;equipmentTypeId&amp;quot;: &amp;quot;7&amp;quot;, &amp;quot;keyCode&amp;quot;: &amp;quot;867994040096808&amp;quot;, &amp;quot;keyType&amp;quot;: &amp;quot;2&amp;quot;, &amp;quot;typeName&amp;quot;: &amp;quot;SomkeDetector&amp;quot;, &amp;quot;typeRemark&amp;quot;: &amp;quot;烟感火灾探测报警器&amp;quot;, &amp;quot;installAdd&amp;quot;: &amp;quot;二楼中转仓库&amp;quot;, &amp;quot;createTime&amp;quot;: 1572577776000, &amp;quot;sellEndTime&amp;quot;: 1604200176000, &amp;quot;status&amp;quot;: 0, &amp;quot;protocolName&amp;quot;: &amp;quot;LWM2M_NB_SITERWELL_TELECOM&amp;quot;, &amp;quot;protocolId&amp;quot;: &amp;quot;13&amp;quot;, &amp;quot;nodeType&amp;quot;: 0 }, &amp;quot;realInfo&amp;quot;: [ { &amp;quot;Identifier&amp;quot;: &amp;quot;BatteryLevel&amp;quot;, &amp;quot;Name&amp;quot;: &amp;quot;电池电量&amp;quot;, &amp;quot;Unit&amp;quot;: &amp;quot;%&amp;quot;, &amp;quot;Time&amp;quot;: &amp;quot;1576550137716&amp;quot;, &amp;quot;DataType&amp;quot;: &amp;quot;int&amp;quot;, &amp;quot;Value&amp;quot;: &amp;quot;100&amp;quot; }, { &amp;quot;Identifier&amp;quot;: &amp;quot;RSSI&amp;quot;, &amp;quot;Name&amp;quot;: &amp;quot;无线电信号强度&amp;quot;, &amp;quot;Unit&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;Time&amp;quot;: &amp;quot;1576550137716&amp;quot;, &amp;quot;DataType&amp;quot;: &amp;quot;int&amp;quot;, &amp;quot;Value&amp;quot;: &amp;quot;-101&amp;quot; } ], // 网关-子设备类型设备,子设备的实时数据以childList内的为准 &amp;quot;childList&amp;quot;: [ { &amp;quot;chileDeviceInstallAdd&amp;quot;: &amp;quot;线路号1&amp;quot;, &amp;quot;childDeviceKey&amp;quot;: &amp;quot;1&amp;quot;, &amp;quot;childDeviceType&amp;quot;: &amp;quot;gas&amp;quot;, &amp;quot;valueList&amp;quot;: [ { &amp;quot;Identifier&amp;quot;: &amp;quot;RSSI&amp;quot;, &amp;quot;Time&amp;quot;: &amp;quot;1653616222260&amp;quot;, &amp;quot;Value&amp;quot;: &amp;quot;-75&amp;quot; }, { &amp;quot;Identifier&amp;quot;: &amp;quot;status&amp;quot;, &amp;quot;Name&amp;quot;: &amp;quot;状态&amp;quot;, &amp;quot;DataType&amp;quot;: &amp;quot;String&amp;quot;, &amp;quot;Unit&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;Time&amp;quot;: &amp;quot;1653616222260&amp;quot;, &amp;quot;Value&amp;quot;: &amp;quot;0&amp;quot; }, { &amp;quot;Identifier&amp;quot;: &amp;quot;sensor_units&amp;quot;, &amp;quot;Time&amp;quot;: &amp;quot;1653616222260&amp;quot;, &amp;quot;Value&amp;quot;: &amp;quot;%LEL&amp;quot; }, { &amp;quot;Identifier&amp;quot;: &amp;quot;measuredValue&amp;quot;, &amp;quot;Name&amp;quot;: &amp;quot;浓度&amp;quot;, &amp;quot;DataType&amp;quot;: &amp;quot;float&amp;quot;, &amp;quot;Unit&amp;quot;: &amp;quot;%LEL&amp;quot;, &amp;quot;Time&amp;quot;: &amp;quot;1653616222260&amp;quot;, &amp;quot;Value&amp;quot;: &amp;quot;0.0&amp;quot; }, { &amp;quot;Identifier&amp;quot;: &amp;quot;device_status_desc&amp;quot;, &amp;quot;Name&amp;quot;: &amp;quot;状态描述&amp;quot;, &amp;quot;DataType&amp;quot;: &amp;quot;String&amp;quot;, &amp;quot;Unit&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;Time&amp;quot;: &amp;quot;1653616222260&amp;quot;, &amp;quot;Value&amp;quot;: &amp;quot;正常&amp;quot; } ] }, { &amp;quot;chileDeviceInstallAdd&amp;quot;: &amp;quot;线路号2&amp;quot;, &amp;quot;childDeviceKey&amp;quot;: &amp;quot;2&amp;quot;, &amp;quot;childDeviceType&amp;quot;: &amp;quot;gas&amp;quot;, &amp;quot;valueList&amp;quot;: [ { &amp;quot;Identifier&amp;quot;: &amp;quot;status&amp;quot;, &amp;quot;Name&amp;quot;: &amp;quot;状态&amp;quot;, &amp;quot;DataType&amp;quot;: &amp;quot;String&amp;quot;, &amp;quot;Unit&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;Time&amp;quot;: &amp;quot;1653616222260&amp;quot;, &amp;quot;Value&amp;quot;: &amp;quot;0&amp;quot; }, { &amp;quot;Identifier&amp;quot;: &amp;quot;sensor_units&amp;quot;, &amp;quot;Time&amp;quot;: &amp;quot;1653616222260&amp;quot;, &amp;quot;Value&amp;quot;: &amp;quot;%LEL&amp;quot; }, { &amp;quot;Identifier&amp;quot;: &amp;quot;measuredValue&amp;quot;, &amp;quot;Name&amp;quot;: &amp;quot;浓度&amp;quot;, &amp;quot;DataType&amp;quot;: &amp;quot;float&amp;quot;, &amp;quot;Unit&amp;quot;: &amp;quot;%LEL&amp;quot;, &amp;quot;Time&amp;quot;: &amp;quot;1653616222260&amp;quot;, &amp;quot;Value&amp;quot;: &amp;quot;0.0&amp;quot; }, { &amp;quot;Identifier&amp;quot;: &amp;quot;device_status_desc&amp;quot;, &amp;quot;Name&amp;quot;: &amp;quot;状态描述&amp;quot;, &amp;quot;DataType&amp;quot;: &amp;quot;String&amp;quot;, &amp;quot;Unit&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;Time&amp;quot;: &amp;quot;1653616222260&amp;quot;, &amp;quot;Value&amp;quot;: &amp;quot;正常&amp;quot; } ] } ] } } </code></pre> <p><strong>返回参数说明</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">equipmentInfo</td> <td style="text-align: left;">JSON</td> <td>设备固定数据JSON</td> </tr> <tr> <td style="text-align: left;">nodeType</td> <td style="text-align: left;">int</td> <td>设备节点类型,1网关-子设备类型,0:独立式设备</td> </tr> <tr> <td style="text-align: left;">equipmentTypeId</td> <td style="text-align: left;">String</td> <td>设备类型id</td> </tr> <tr> <td style="text-align: left;">keyCode</td> <td style="text-align: left;">String</td> <td>设备标识码</td> </tr> <tr> <td style="text-align: left;">keyType</td> <td style="text-align: left;">String</td> <td>设备标识码类型id</td> </tr> <tr> <td style="text-align: left;">typeName</td> <td style="text-align: left;">String</td> <td>设备类型唯一标识符</td> </tr> <tr> <td style="text-align: left;">typeRemark</td> <td style="text-align: left;">String</td> <td>设备类型显示名称</td> </tr> <tr> <td style="text-align: left;">installAdd</td> <td style="text-align: left;">String</td> <td>设备安装位置</td> </tr> <tr> <td style="text-align: left;">createTime</td> <td style="text-align: left;">long</td> <td>设备创建时间,时间戳</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">int</td> <td>设备当前状态,0正常,1故障,2报警,3离线</td> </tr> <tr> <td style="text-align: left;">protocolName</td> <td style="text-align: left;">String</td> <td>设备协议唯一标识符</td> </tr> <tr> <td style="text-align: left;">protocolId</td> <td style="text-align: left;">String</td> <td>设备协议id</td> </tr> <tr> <td style="text-align: left;">childList</td> <td style="text-align: left;">List</td> <td>子设备数据集合 <strong>网关/主机类设备 会返回该字段</strong></td> </tr> <tr> <td style="text-align: left;">chileDeviceInstallAdd</td> <td style="text-align: left;">String</td> <td>子设备安装位置</td> </tr> <tr> <td style="text-align: left;">childDeviceKey</td> <td style="text-align: left;">String</td> <td>子设备识别码</td> </tr> <tr> <td style="text-align: left;">childDeviceType</td> <td style="text-align: left;">String</td> <td>子设备类型</td> </tr> <tr> <td style="text-align: left;">channelNum</td> <td style="text-align: left;">int</td> <td>通道数,当前仅智能照明设备类型会有此参数,标识此子设备下有多少通道</td> </tr> <tr> <td style="text-align: left;">valueList</td> <td style="text-align: left;">JSONArray</td> <td>子设备实时数据集合</td> </tr> <tr> <td style="text-align: left;">realInfo</td> <td style="text-align: left;">JSONArray</td> <td>设备实时数据集合,<strong>非独立式设备此属性非必返</strong></td> </tr> <tr> <td style="text-align: left;">Identifier</td> <td style="text-align: left;">String</td> <td>属性唯一识别字符</td> </tr> <tr> <td style="text-align: left;">Name</td> <td style="text-align: left;">String</td> <td>属性显示名称</td> </tr> <tr> <td style="text-align: left;">Unit</td> <td style="text-align: left;">String</td> <td>属性值单位,可能为空字符</td> </tr> <tr> <td style="text-align: left;">Value</td> <td style="text-align: left;">String</td> <td>此属性当前值</td> </tr> <tr> <td style="text-align: left;">Time</td> <td style="text-align: left;">String</td> <td>设备上报此属性值的时间戳,非必返</td> </tr> <tr> <td style="text-align: left;">Alias</td> <td style="text-align: left;">String</td> <td>属性的别名,非必返</td> </tr> <tr> <td style="text-align: left;">IdentifierDis</td> <td style="text-align: left;">String</td> <td>属性区分,如果Identifer的IdentiferDis相同,代表属于同一组数据,<strong>非必返</strong></td> </tr> </tbody> </table> <p><strong>备注</strong> </p> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML