This is an automated email from the ASF dual-hosted git repository.
qiaojialin pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iotdb-docs.git
The following commit(s) were added to refs/heads/main by this push:
new 461b71e rest add insertRecords doc (#67)
461b71e is described below
commit 461b71e39b3c5d6996f1b9276d996eae04ffe5e5
Author: CloudWise-Lukemiao
<[email protected]>
AuthorDate: Thu Aug 17 17:29:15 2023 +0800
rest add insertRecords doc (#67)
Co-authored-by: Cloudwise_Luke <[email protected]>
---
src/UserGuide/Master/API/RestServiceV1.md | 37 ++++++++++++++++++++++++++++
src/UserGuide/Master/API/RestServiceV2.md | 37 ++++++++++++++++++++++++++++
src/UserGuide/V1.2.x/API/RestServiceV1.md | 37 ++++++++++++++++++++++++++++
src/UserGuide/V1.2.x/API/RestServiceV2.md | 37 ++++++++++++++++++++++++++++
src/zh/UserGuide/Master/API/RestServiceV1.md | 37 ++++++++++++++++++++++++++++
src/zh/UserGuide/Master/API/RestServiceV2.md | 37 ++++++++++++++++++++++++++++
src/zh/UserGuide/V1.2.x/API/RestServiceV1.md | 37 ++++++++++++++++++++++++++++
src/zh/UserGuide/V1.2.x/API/RestServiceV2.md | 37 ++++++++++++++++++++++++++++
8 files changed, 296 insertions(+)
diff --git a/src/UserGuide/Master/API/RestServiceV1.md
b/src/UserGuide/Master/API/RestServiceV1.md
index 6e22bcb..89ec126 100644
--- a/src/UserGuide/Master/API/RestServiceV1.md
+++ b/src/UserGuide/Master/API/RestServiceV1.md
@@ -843,6 +843,43 @@ Sample response:
}
```
+### insertRecords
+
+Request method: `POST`
+
+Request header: `application/json`
+
+Request path: http://ip:port/rest/v1/insertRecords
+
+Parameter Description:
+
+| parameter name |parameter type |is required|parameter describe|
+|:---------------| :--- | :---| :---|
+| timestamps | array | yes | Time column |
+| measurementsList | array | yes | The name of the measuring point |
+| dataTypesList | array | yes | The data type |
+| valuesList | array | yes | Value columns, the values in each column
can be `null` |
+| deviceIds | string | yes | Device name |
+
+Example request:
+```shell
+curl -H "Content-Type:application/json" -H "Authorization:Basic cm9vdDpyb290"
-X POST --data
'{"timestamps":[1635232113960,1635232151960,1635232151860,1635232152960],"measurementsList":[["s33","s44"],["s55","s66"],["s77","s88"],["s771","s881"]],"dataTypesList":[["INT32","INT64"],["FLOAT","DOUBLE"],["FLOAT","DOUBLE"],["BOOLEAN","TEXT"]],"valuesList":[[1,11],[2.1,2],[4,6],[false,"cccccc"]],"deviceIds":["root.s1","root.s1","root.s1","root.s3"]}'
http://127.0.0.1:18080/rest/v1/insertRecords
+```
+
+Sample response:
+
+|parameter name |parameter type |parameter describe|
+|:--- | :--- | :---|
+| code | integer | status code |
+| message | string | message |
+
+Sample response:
+```json
+{
+ "code": 200,
+ "message": "SUCCESS_STATUS"
+}
+```
## Configuration
diff --git a/src/UserGuide/Master/API/RestServiceV2.md
b/src/UserGuide/Master/API/RestServiceV2.md
index 61cdada..41e753c 100644
--- a/src/UserGuide/Master/API/RestServiceV2.md
+++ b/src/UserGuide/Master/API/RestServiceV2.md
@@ -843,6 +843,43 @@ Sample response:
}
```
+### insertRecords
+
+Request method: `POST`
+
+Request header: `application/json`
+
+Request path: http://ip:port/rest/v2/insertRecords
+
+Parameter Description:
+
+| parameter name |parameter type |is required|parameter describe|
+|:------------------| :--- | :---| :---|
+| timestamps | array | yes | Time column |
+| measurements_list | array | yes | The name of the measuring point |
+| data_types_list | array | yes | The data type |
+| values_list | array | yes | Value columns, the values in each column
can be `null` |
+| devices | string | yes | Device name |
+
+Example request:
+```shell
+curl -H "Content-Type:application/json" -H "Authorization:Basic cm9vdDpyb290"
-X POST --data
'{"timestamps":[1635232113960,1635232151960,1635232143960,1635232143960],"measurements_list":[["s33","s44"],["s55","s66"],["s77","s88"],["s771","s881"]],"data_types_list":[["INT32","INT64"],["FLOAT","DOUBLE"],["FLOAT","DOUBLE"],["BOOLEAN","TEXT"]],"values_list":[[1,11],[2.1,2],[4,6],[false,"cccccc"]],"devices":["root.s1","root.s1","root.s1","root.s3"]}'
http://127.0.0.1:18080/rest/v2/insertRecords
+```
+
+Sample response:
+
+|parameter name |parameter type |parameter describe|
+|:--- | :--- | :---|
+| code | integer | status code |
+| message | string | message |
+
+Sample response:
+```json
+{
+ "code": 200,
+ "message": "SUCCESS_STATUS"
+}
+```
## Configuration
diff --git a/src/UserGuide/V1.2.x/API/RestServiceV1.md
b/src/UserGuide/V1.2.x/API/RestServiceV1.md
index 6e22bcb..89ec126 100644
--- a/src/UserGuide/V1.2.x/API/RestServiceV1.md
+++ b/src/UserGuide/V1.2.x/API/RestServiceV1.md
@@ -843,6 +843,43 @@ Sample response:
}
```
+### insertRecords
+
+Request method: `POST`
+
+Request header: `application/json`
+
+Request path: http://ip:port/rest/v1/insertRecords
+
+Parameter Description:
+
+| parameter name |parameter type |is required|parameter describe|
+|:---------------| :--- | :---| :---|
+| timestamps | array | yes | Time column |
+| measurementsList | array | yes | The name of the measuring point |
+| dataTypesList | array | yes | The data type |
+| valuesList | array | yes | Value columns, the values in each column
can be `null` |
+| deviceIds | string | yes | Device name |
+
+Example request:
+```shell
+curl -H "Content-Type:application/json" -H "Authorization:Basic cm9vdDpyb290"
-X POST --data
'{"timestamps":[1635232113960,1635232151960,1635232151860,1635232152960],"measurementsList":[["s33","s44"],["s55","s66"],["s77","s88"],["s771","s881"]],"dataTypesList":[["INT32","INT64"],["FLOAT","DOUBLE"],["FLOAT","DOUBLE"],["BOOLEAN","TEXT"]],"valuesList":[[1,11],[2.1,2],[4,6],[false,"cccccc"]],"deviceIds":["root.s1","root.s1","root.s1","root.s3"]}'
http://127.0.0.1:18080/rest/v1/insertRecords
+```
+
+Sample response:
+
+|parameter name |parameter type |parameter describe|
+|:--- | :--- | :---|
+| code | integer | status code |
+| message | string | message |
+
+Sample response:
+```json
+{
+ "code": 200,
+ "message": "SUCCESS_STATUS"
+}
+```
## Configuration
diff --git a/src/UserGuide/V1.2.x/API/RestServiceV2.md
b/src/UserGuide/V1.2.x/API/RestServiceV2.md
index 61cdada..41e753c 100644
--- a/src/UserGuide/V1.2.x/API/RestServiceV2.md
+++ b/src/UserGuide/V1.2.x/API/RestServiceV2.md
@@ -843,6 +843,43 @@ Sample response:
}
```
+### insertRecords
+
+Request method: `POST`
+
+Request header: `application/json`
+
+Request path: http://ip:port/rest/v2/insertRecords
+
+Parameter Description:
+
+| parameter name |parameter type |is required|parameter describe|
+|:------------------| :--- | :---| :---|
+| timestamps | array | yes | Time column |
+| measurements_list | array | yes | The name of the measuring point |
+| data_types_list | array | yes | The data type |
+| values_list | array | yes | Value columns, the values in each column
can be `null` |
+| devices | string | yes | Device name |
+
+Example request:
+```shell
+curl -H "Content-Type:application/json" -H "Authorization:Basic cm9vdDpyb290"
-X POST --data
'{"timestamps":[1635232113960,1635232151960,1635232143960,1635232143960],"measurements_list":[["s33","s44"],["s55","s66"],["s77","s88"],["s771","s881"]],"data_types_list":[["INT32","INT64"],["FLOAT","DOUBLE"],["FLOAT","DOUBLE"],["BOOLEAN","TEXT"]],"values_list":[[1,11],[2.1,2],[4,6],[false,"cccccc"]],"devices":["root.s1","root.s1","root.s1","root.s3"]}'
http://127.0.0.1:18080/rest/v2/insertRecords
+```
+
+Sample response:
+
+|parameter name |parameter type |parameter describe|
+|:--- | :--- | :---|
+| code | integer | status code |
+| message | string | message |
+
+Sample response:
+```json
+{
+ "code": 200,
+ "message": "SUCCESS_STATUS"
+}
+```
## Configuration
diff --git a/src/zh/UserGuide/Master/API/RestServiceV1.md
b/src/zh/UserGuide/Master/API/RestServiceV1.md
index 45bc6ac..f9a733b 100644
--- a/src/zh/UserGuide/Master/API/RestServiceV1.md
+++ b/src/zh/UserGuide/Master/API/RestServiceV1.md
@@ -857,6 +857,43 @@ curl -H "Content-Type:application/json" -H
"Authorization:Basic cm9vdDpyb290" -X
}
```
+### insertRecords
+
+请求方式：`POST`
+
+请求头：`application/json`
+
+请求路径：http://ip:port/rest/v1/insertRecords
+
+参数说明:
+
+| 参数名称 |参数类型 |是否必填|参数描述|
+|------------------| ------------ | ------------ |------------ |
+| timestamps | array | 是 | 时间列 |
+| measurementsList | array | 是 | 测点名称 |
+| dataTypesList | array | 是 | 数据类型 |
+| valuesList | array | 是 | 值列，每一列中的值可以为 `null` |
+| deviceIds | string | 是 | 设备名称 |
+
+请求示例：
+```shell
+curl -H "Content-Type:application/json" -H "Authorization:Basic cm9vdDpyb290"
-X POST --data
'{"timestamps":[1635232113960,1635232151960,1635232151860,1635232152960],"measurementsList":[["s33","s44"],["s55","s66"],["s77","s88"],["s771","s881"]],"dataTypesList":[["INT32","INT64"],["FLOAT","DOUBLE"],["FLOAT","DOUBLE"],["BOOLEAN","TEXT"]],"valuesList":[[1,11],[2.1,2],[4,6],[false,"cccccc"]],"deviceIds":["root.s1","root.s1","root.s1","root.s3"]}'
http://127.0.0.1:18080/rest/v1/insertRecords
+```
+
+响应参数：
+
+|参数名称 |参数类型 |参数描述|
+| ------------ | ------------ | ------------|
+| code | integer | 状态码 |
+| message | string | 信息提示 |
+
+响应示例：
+```json
+{
+ "code": 200,
+ "message": "SUCCESS_STATUS"
+}
+```
## 配置
diff --git a/src/zh/UserGuide/Master/API/RestServiceV2.md
b/src/zh/UserGuide/Master/API/RestServiceV2.md
index b68a7c5..c52191a 100644
--- a/src/zh/UserGuide/Master/API/RestServiceV2.md
+++ b/src/zh/UserGuide/Master/API/RestServiceV2.md
@@ -857,6 +857,43 @@ curl -H "Content-Type:application/json" -H
"Authorization:Basic cm9vdDpyb290" -X
}
```
+### insertRecords
+
+请求方式：`POST`
+
+请求头：`application/json`
+
+请求路径：http://ip:port/rest/v2/insertRecords
+
+参数说明:
+
+| 参数名称 |参数类型 |是否必填|参数描述|
+|----------------| ------------ | ------------ |------------ |
+| timestamps | array | 是 | 时间列 |
+| measurements | array | 是 | 测点名称 |
+| data_types_list | array | 是 | 数据类型 |
+| values_list | array | 是 | 值列，每一列中的值可以为 `null` |
+| devices | string | 是 | 设备名称 |
+
+请求示例：
+```shell
+curl -H "Content-Type:application/json" -H "Authorization:Basic cm9vdDpyb290"
-X POST --data
'{"timestamps":[1635232113960,1635232151960,1635232143960,1635232143960],"measurements_list":[["s33","s44"],["s55","s66"],["s77","s88"],["s771","s881"]],"data_types_list":[["INT32","INT64"],["FLOAT","DOUBLE"],["FLOAT","DOUBLE"],["BOOLEAN","TEXT"]],"values_list":[[1,11],[2.1,2],[4,6],[false,"cccccc"]],"devices":["root.s1","root.s1","root.s1","root.s3"]}'
http://127.0.0.1:18080/rest/v2/insertRecords
+```
+
+响应参数：
+
+|参数名称 |参数类型 |参数描述|
+| ------------ | ------------ | ------------|
+| code | integer | 状态码 |
+| message | string | 信息提示 |
+
+响应示例：
+```json
+{
+ "code": 200,
+ "message": "SUCCESS_STATUS"
+}
+```
## 配置
diff --git a/src/zh/UserGuide/V1.2.x/API/RestServiceV1.md
b/src/zh/UserGuide/V1.2.x/API/RestServiceV1.md
index 45bc6ac..f9a733b 100644
--- a/src/zh/UserGuide/V1.2.x/API/RestServiceV1.md
+++ b/src/zh/UserGuide/V1.2.x/API/RestServiceV1.md
@@ -857,6 +857,43 @@ curl -H "Content-Type:application/json" -H
"Authorization:Basic cm9vdDpyb290" -X
}
```
+### insertRecords
+
+请求方式：`POST`
+
+请求头：`application/json`
+
+请求路径：http://ip:port/rest/v1/insertRecords
+
+参数说明:
+
+| 参数名称 |参数类型 |是否必填|参数描述|
+|------------------| ------------ | ------------ |------------ |
+| timestamps | array | 是 | 时间列 |
+| measurementsList | array | 是 | 测点名称 |
+| dataTypesList | array | 是 | 数据类型 |
+| valuesList | array | 是 | 值列，每一列中的值可以为 `null` |
+| deviceIds | string | 是 | 设备名称 |
+
+请求示例：
+```shell
+curl -H "Content-Type:application/json" -H "Authorization:Basic cm9vdDpyb290"
-X POST --data
'{"timestamps":[1635232113960,1635232151960,1635232151860,1635232152960],"measurementsList":[["s33","s44"],["s55","s66"],["s77","s88"],["s771","s881"]],"dataTypesList":[["INT32","INT64"],["FLOAT","DOUBLE"],["FLOAT","DOUBLE"],["BOOLEAN","TEXT"]],"valuesList":[[1,11],[2.1,2],[4,6],[false,"cccccc"]],"deviceIds":["root.s1","root.s1","root.s1","root.s3"]}'
http://127.0.0.1:18080/rest/v1/insertRecords
+```
+
+响应参数：
+
+|参数名称 |参数类型 |参数描述|
+| ------------ | ------------ | ------------|
+| code | integer | 状态码 |
+| message | string | 信息提示 |
+
+响应示例：
+```json
+{
+ "code": 200,
+ "message": "SUCCESS_STATUS"
+}
+```
## 配置
diff --git a/src/zh/UserGuide/V1.2.x/API/RestServiceV2.md
b/src/zh/UserGuide/V1.2.x/API/RestServiceV2.md
index b68a7c5..c52191a 100644
--- a/src/zh/UserGuide/V1.2.x/API/RestServiceV2.md
+++ b/src/zh/UserGuide/V1.2.x/API/RestServiceV2.md
@@ -857,6 +857,43 @@ curl -H "Content-Type:application/json" -H
"Authorization:Basic cm9vdDpyb290" -X
}
```
+### insertRecords
+
+请求方式：`POST`
+
+请求头：`application/json`
+
+请求路径：http://ip:port/rest/v2/insertRecords
+
+参数说明:
+
+| 参数名称 |参数类型 |是否必填|参数描述|
+|----------------| ------------ | ------------ |------------ |
+| timestamps | array | 是 | 时间列 |
+| measurements | array | 是 | 测点名称 |
+| data_types_list | array | 是 | 数据类型 |
+| values_list | array | 是 | 值列，每一列中的值可以为 `null` |
+| devices | string | 是 | 设备名称 |
+
+请求示例：
+```shell
+curl -H "Content-Type:application/json" -H "Authorization:Basic cm9vdDpyb290"
-X POST --data
'{"timestamps":[1635232113960,1635232151960,1635232143960,1635232143960],"measurements_list":[["s33","s44"],["s55","s66"],["s77","s88"],["s771","s881"]],"data_types_list":[["INT32","INT64"],["FLOAT","DOUBLE"],["FLOAT","DOUBLE"],["BOOLEAN","TEXT"]],"values_list":[[1,11],[2.1,2],[4,6],[false,"cccccc"]],"devices":["root.s1","root.s1","root.s1","root.s3"]}'
http://127.0.0.1:18080/rest/v2/insertRecords
+```
+
+响应参数：
+
+|参数名称 |参数类型 |参数描述|
+| ------------ | ------------ | ------------|
+| code | integer | 状态码 |
+| message | string | 信息提示 |
+
+响应示例：
+```json
+{
+ "code": 200,
+ "message": "SUCCESS_STATUS"
+}
+```
## 配置
