simApi

物联网平台API


获取流量池列表

<h5>简要描述</h5> <ul> <li>查询流量池基础信息, 包括成员数量,流量使用情况等</li> </ul> <h5>请求URL</h5> <ul> <li><code>http://域名/Api/IotApi/queryPoolInfo</code></li> </ul> <h5>请求方式</h5> <ul> <li>POST</li> </ul> <h5>数据格式</h5> <ul> <li>表单(application/x-www-form-urlencoded)</li> </ul> <h5>参数</h5> <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;">appId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>appId</td> </tr> <tr> <td style="text-align: left;">poolId</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>流量池ID,不指定时,则获取所有名下所有流量池信息</td> </tr> <tr> <td style="text-align: left;">timeStamp</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>当前时间秒级时间戳</td> </tr> <tr> <td style="text-align: left;">sign</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>签名,参考通信规范章节中的 <a href="https://www.showdoc.cc/916774523755909?page_id=4853199661052891" title="《签名算法》">《签名算法》</a>生成</td> </tr> </tbody> </table> <h5>返回示例 (Json)</h5> <pre><code>{ "code": 0, "data": [ { "id": 10001, "name": "测试池", "ttraffic": 2048, "ottraffic": 307200, "utraffic": 25, "num": 1 }, { "id": 10007, "name": "测试池02", "ttraffic": 102400, "ottraffic": 0, "utraffic": 0, "num": 0 } ], "msg": "OK" }</code></pre> <h5>返回参数说明</h5> <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;">code</td> <td style="text-align: left;">int</td> <td>返回错误代码,0:成功</td> </tr> <tr> <td style="text-align: left;">data</td> <td style="text-align: left;">object</td> <td>返回数据,详情请查看下方data参数说明</td> </tr> <tr> <td style="text-align: left;">msg</td> <td style="text-align: left;">string</td> <td>当code不为0时,错误提示</td> </tr> </tbody> </table> <h6>data参数说明</h6> <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;">id</td> <td style="text-align: left;">int</td> <td>流量池ID</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;">ttraffic</td> <td style="text-align: left;">int</td> <td>流量池每月基础流量,单位:MB</td> </tr> <tr> <td style="text-align: left;">ottraffic</td> <td style="text-align: left;">int</td> <td>流量池本月追加订购流量,单位:MB</td> </tr> <tr> <td style="text-align: left;">utraffic</td> <td style="text-align: left;">int</td> <td>流量池本月使用量,单位:MB</td> </tr> <tr> <td style="text-align: left;">num</td> <td style="text-align: left;">int</td> <td>流量池成员数量</td> </tr> </tbody> </table> <h5>备注</h5> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML