Jelajahi Sumber

增加原始数据接口

luoguangyi 2 tahun lalu
induk
melakukan
17e5a22dbf
1 mengubah file dengan 167 tambahan dan 1 penghapusan
  1. 167 1
      docs/iot/iot.md

+ 167 - 1
docs/iot/iot.md

@@ -219,6 +219,171 @@ websocket端口是单独的端口,和服务端口不是同一个;
 
 ```
 
+## 原始数据
+
+
+### 查询iot原始数据
+
+
+**接口地址**:`/listOriginalMonth`
+
+
+**请求方式**:`POST`
+
+
+**请求数据类型**:`application/json`
+
+
+**响应数据类型**:`*/*`
+
+
+**接口描述**:
+
+
+**请求示例**:
+
+
+```javascript
+{
+  "building": 1101070037,
+  "funcid": 10101,
+  "meter": 1001,
+  "time_from": "20200101000000",
+  "time_to": "20200201000000"
+}
+```
+
+
+**请求参数**:
+
+
+| 参数名称              | 参数说明                   | 请求类型 | 是否必须 | 数据类型       | schema   |
+| --------------------- | -------------------------- | -------- | -------- | -------------- | -------- |
+| originalMonthParam    | 注意:参数和返回值共用此类 | body     | true     | 原始数据       | 原始数据 |
+|   building  | 参数:项目编码-10位数字    |          | false    | string         |          |
+|   funcid    | 参数:功能号               |          | false    | integer(int32) |          |
+|   meter     | 参数:仪表编号             |          | false    | string         |          |
+|   time_from | 开始时间                   |          | false    | string         |          |
+|   time_to   | 结束时间                   |          | false    | string         |          |
+
+**响应参数**:
+
+
+| 参数名称  | 参数说明                                   | 类型           | schema         |
+| --------- | ------------------------------------------ | -------------- | -------------- |
+| code      | 结果码.00000是成功,其他都是失败            | string         |                |
+| data      | 响应数据                                   | object         |                |
+| message   | 错误提示信息                               | string         |                |
+| result    | 结果标识:成功标识:success,失败标识:fail | string         |                |
+| timestamp | 响应时间戳                                 | integer(int64) | integer(int64) |
+
+
+**响应示例**:
+
+```json
+{
+    "code": "",
+    "data": {
+        "building": 1101070037,
+        "datas": [
+            {
+                "data": 13.14,
+                "receivetime": 20201224192034
+            }
+        ],
+        "funcid": 10101,
+        "meter": 1001,
+        "time_from": "20200101000000",
+        "time_to": "20200201000000"
+    },
+    "message": "",
+    "result": "",
+    "timestamp": 0
+}
+```
+
+
+### 批量查询iot原始数据
+
+**接口地址**:`/listOriginalMonthBatch`
+
+
+**请求方式**:`POST`
+
+
+**请求数据类型**:`application/json`
+
+
+**响应数据类型**:`*/*`
+
+
+**接口描述**:
+
+
+**请求示例**:
+
+
+```javascript
+[
+  {
+    "building": 1101070037,
+    "funcid": 10101,
+    "meter": 1001,
+    "time_from": "20200101000000",
+    "time_to": "20200201000000"
+  }
+]
+```
+
+
+**请求参数**:
+
+
+| 参数名称               | 参数说明                   | 请求类型 | 是否必须 | 数据类型       | schema   |
+| ---------------------- | -------------------------- | -------- | -------- | -------------- | -------- |
+| originalMonthParamList | 注意:参数和返回值共用此类 | body     | true     | array          | 原始数据 |
+|   building   | 参数:项目编码-10位数字    |          | false    | string         |          |
+|   funcid     | 参数:功能号               |          | false    | integer(int32) |          |
+|   meter      | 参数:仪表编号             |          | false    | string         |          |
+|   time_from  | 开始时间                   |          | false    | string         |          |
+|   time_to    | 结束时间                   |          | false    | string         |          |
+
+**响应参数**:
+
+
+| 参数名称  | 参数说明                                   | 类型           | schema         |
+| --------- | ------------------------------------------ | -------------- | -------------- |
+| data      | 响应数据                                   | object         |                |
+| code      | 结果码.00000是成功,其他都是失败            | string         |                |
+| message   | 错误提示信息                               | string         |                |
+| result    | 结果标识:成功标识:success,失败标识:fail | string         |                |
+| timestamp | 响应时间戳                                 | integer(int64) | integer(int64) |
+
+**响应示例**:
+
+```javascript
+{
+    "code": "",
+    "data": [
+        {
+            "building": 1101070037,
+            "datas": [
+                {
+                    "data": 13.14,
+                    "receivetime": 20201224192034
+                }
+            ],
+            "funcid": 10101,
+            "meter": 1001,
+            "time_from": "20200101000000",
+            "time_to": "20200201000000"
+        }
+    ],
+    "message": "",
+    "result": "",
+    "timestamp": 0
+}
+```
 
 ## 分精度
 
@@ -231,7 +396,6 @@ websocket端口是单独的端口,和服务端口不是同一个;
 
 **请求方式**:`POST`
 
-
 **请求数据类型**:`application/json`
 
 
@@ -2474,5 +2638,7 @@ http://localhost:8080/metadata-web/services/Service1_RS/zk_rmr_zillion
 
 删除zk中compute_engine节点
 http://localhost:8080/metadata-web/services/Service1_RS/zk_rmr_compute_engine
+修改表坏块
+http://localhost:8080/metadata-web/services/Service1_RS/compact_table/db_public/zillion_data_fjd_0_near_15min_202111
 ```