Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rest configuration is adjusted from iotdb-common.properties to iotdb-datanode.properties #115

Merged
merged 4 commits into from
Dec 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/UserGuide/Master/API/RestServiceV1.md
Original file line number Diff line number Diff line change
Expand Up @@ -845,7 +845,7 @@ Sample response:

## Configuration

The configuration is located in 'iotdb-rest.properties'.
The configuration is located in 'iotdb-datanode.properties'.

* Set 'enable_rest_service' to 'true' to enable the module, and 'false' to disable the module. By default, this value is' false '.

Expand Down
2 changes: 1 addition & 1 deletion src/UserGuide/Master/API/RestServiceV2.md
Original file line number Diff line number Diff line change
Expand Up @@ -885,7 +885,7 @@ Sample response:

## Configuration

The configuration is located in 'iotdb-rest.properties'.
The configuration is located in 'iotdb-datanode.properties'.

* Set 'enable_rest_service' to 'true' to enable the module, and 'false' to disable the module. By default, this value is' false '.

Expand Down
119 changes: 0 additions & 119 deletions src/UserGuide/Master/Reference/Common-Config-Manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -1959,123 +1959,4 @@ Different configuration parameters take effect in the following three ways:
| Default | 1048576 |
| Effective | hot-load |

### REST Service Configuration

* enable\_rest\_service

|Name| enable\_rest\_service |
|:---:|:--------------------------------------|
|Description| Whether to enable the Rest service |
|Type| Boolean |
|Default| false |
|Effective| After restarting system |

* rest\_service\_port

|Name| rest\_service\_port |
|:---:|:------------------|
|Description| The Rest service listens to the port number |
|Type| int32 |
|Default| 18080 |
|Effective| After restarting system |

* enable\_swagger

|Name| enable\_swagger |
|:---:|:-----------------------|
|Description| Whether to enable swagger to display rest interface information |
|Type| Boolean |
|Default| false |
|Effective| After restarting system |

* rest\_query\_default\_row\_size\_limit

|Name| rest\_query\_default\_row\_size\_limit |
|:---:|:------------------------------------------------------------------------------------------|
|Description| The maximum number of rows in a result set that can be returned by a query |
|Type| int32 |
|Default| 10000 |
|Effective| After restarting system |

* cache\_expire

|Name| cache\_expire |
|:---:|:--------------------------------------------------------|
|Description| Expiration time for caching customer login information |
|Type| int32 |
|Default| 28800 |
|Effective| After restarting system |

* cache\_max\_num

|Name| cache\_max\_num |
|:---:|:--------------|
|Description| The maximum number of users stored in the cache |
|Type| int32 |
|Default| 100 |
|Effective| After restarting system |

* cache\_init\_num

|Name| cache\_init\_num |
|:---:|:---------------|
|Description| Initial cache capacity |
|Type| int32 |
|Default| 10 |
|Effective| After restarting system |

* enable\_https

|Name| cache\_init\_num |
|:---:|:-------------------------|
|Description| REST Service Specifies whether to enable SSL configuration |
|Type| Boolean |
|Default| false |
|Effective| After restarting system |

* key\_store\_path

|Name| key\_store\_path |
|:---:|:---------------|
|Description| keyStore path (optional) |
|Type| String |
|Default| "" |
|Effective| After restarting system |

* key\_store\_pwd

|Name| key\_store\_pwd |
|:---:|:---------------|
|Description| keyStore Password (optional) |
|Type| String |
|Default| "" |
|Effective| After restarting system |

* trust\_store\_path

|Name| trust\_store\_path |
|:---:|:---------------|
|Description| keyStore Password (optional) |
|Type| String |
|Default| "" |
|Effective| After restarting system |

* trust\_store\_pwd

|Name| trust\_store\_pwd |
|:---:|:---------------------------------|
|Description| trustStore Password (Optional) |
|Type| String |
|Default| "" |
|Effective| After restarting system |

* idle\_timeout

|Name| idle\_timeout |
|:---:|:--------------|
|Description| SSL timeout duration, expressed in seconds |
|Type| int32 |
|Default| 5000 |
|Effective| After restarting system |


102 changes: 102 additions & 0 deletions src/UserGuide/Master/Reference/DataNode-Config-Manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,15 @@ The permission definitions are in ${IOTDB\_CONF}/conf/jmx.access.
|Default| false |
|Effective| After restarting system |

* enable\_https

|Name| cache\_init\_num |
|:---:|:-------------------------|
|Description| REST Service Specifies whether to enable SSL configuration |
|Type| Boolean |
|Default| false |
|Effective| After restarting system |

* key\_store\_path

|Name| key\_store\_path |
Expand Down Expand Up @@ -395,3 +404,96 @@ sbin\start-datanode.bat printgc

GC log is stored at `IOTDB_HOME/logs/gc.log`.
There will be at most 10 gc.log.* files and each one can reach to 10MB.

### REST Service Configuration

* enable\_rest\_service

|Name| enable\_rest\_service |
|:---:|:--------------------------------------|
|Description| Whether to enable the Rest service |
|Type| Boolean |
|Default| false |
|Effective| After restarting system |

* rest\_service\_port

|Name| rest\_service\_port |
|:---:|:------------------|
|Description| The Rest service listens to the port number |
|Type| int32 |
|Default| 18080 |
|Effective| After restarting system |

* enable\_swagger

|Name| enable\_swagger |
|:---:|:-----------------------|
|Description| Whether to enable swagger to display rest interface information |
|Type| Boolean |
|Default| false |
|Effective| After restarting system |

* rest\_query\_default\_row\_size\_limit

|Name| rest\_query\_default\_row\_size\_limit |
|:---:|:------------------------------------------------------------------------------------------|
|Description| The maximum number of rows in a result set that can be returned by a query |
|Type| int32 |
|Default| 10000 |
|Effective| After restarting system |

* cache\_expire

|Name| cache\_expire |
|:---:|:--------------------------------------------------------|
|Description| Expiration time for caching customer login information |
|Type| int32 |
|Default| 28800 |
|Effective| After restarting system |

* cache\_max\_num

|Name| cache\_max\_num |
|:---:|:--------------|
|Description| The maximum number of users stored in the cache |
|Type| int32 |
|Default| 100 |
|Effective| After restarting system |

* cache\_init\_num

|Name| cache\_init\_num |
|:---:|:---------------|
|Description| Initial cache capacity |
|Type| int32 |
|Default| 10 |
|Effective| After restarting system |


* trust\_store\_path

|Name| trust\_store\_path |
|:---:|:---------------|
|Description| keyStore Password (optional) |
|Type| String |
|Default| "" |
|Effective| After restarting system |

* trust\_store\_pwd

|Name| trust\_store\_pwd |
|:---:|:---------------------------------|
|Description| trustStore Password (Optional) |
|Type| String |
|Default| "" |
|Effective| After restarting system |

* idle\_timeout

|Name| idle\_timeout |
|:---:|:--------------|
|Description| SSL timeout duration, expressed in seconds |
|Type| int32 |
|Default| 5000 |
|Effective| After restarting system |
3 changes: 2 additions & 1 deletion src/zh/UserGuide/Master/API/RestServiceV1.md
Original file line number Diff line number Diff line change
Expand Up @@ -857,9 +857,10 @@ curl -H "Content-Type:application/json" -H "Authorization:Basic cm9vdDpyb290" -X
}
```


## 配置

配置位于 `iotdb-common.properties` 中。
配置位于 `iotdb-datanode.properties` 中。



Expand Down
2 changes: 1 addition & 1 deletion src/zh/UserGuide/Master/API/RestServiceV2.md
Original file line number Diff line number Diff line change
Expand Up @@ -899,7 +899,7 @@ curl -H "Content-Type:application/json" -H "Authorization:Basic cm9vdDpyb290" -X

## 配置

配置位于 `iotdb-common.properties` 中。
配置位于 `iotdb-datanode.properties` 中。



Expand Down
119 changes: 0 additions & 119 deletions src/zh/UserGuide/Master/Reference/Common-Config-Manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -1978,122 +1978,3 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。
|类型| int32 |
|默认值| 1048576 |
|改后生效方式|热加载|

#### REST 服务配置

* enable\_rest\_service

|名字| enable\_rest\_service |
|:---:|:--------------------|
|描述| 是否开启Rest服务。 |
|类型| Boolean |
|默认值| false |
|改后生效方式| 重启生效 |

* rest\_service\_port

|名字| rest\_service\_port |
|:---:|:------------------|
|描述| Rest服务监听端口号 |
|类型| int32 |
|默认值| 18080 |
|改后生效方式| 重启生效 |

* enable\_swagger

|名字| enable\_swagger |
|:---:|:-----------------------|
|描述| 是否启用swagger来展示rest接口信息 |
|类型| Boolean |
|默认值| false |
|改后生效方式| 重启生效 |

* rest\_query\_default\_row\_size\_limit

|名字| rest\_query\_default\_row\_size\_limit |
|:---:|:----------------------------------|
|描述| 一次查询能返回的结果集最大行数 |
|类型| int32 |
|默认值| 10000 |
|改后生效方式| 重启生效 |

* cache\_expire

|名字| cache\_expire |
|:---:|:--------------|
|描述| 缓存客户登录信息的过期时间 |
|类型| int32 |
|默认值| 28800 |
|改后生效方式| 重启生效 |

* cache\_max\_num

|名字| cache\_max\_num |
|:---:|:--------------|
|描述| 缓存中存储的最大用户数量 |
|类型| int32 |
|默认值| 100 |
|改后生效方式| 重启生效 |

* cache\_init\_num

|名字| cache\_init\_num |
|:---:|:---------------|
|描述| 缓存初始容量 |
|类型| int32 |
|默认值| 10 |
|改后生效方式| 重启生效 |

* enable\_https

|名字| cache\_init\_num |
|:---:|:-------------------------|
|描述| REST Service 是否开启 SSL 配置 |
|类型| Boolean |
|默认值| false |
|改后生效方式| 重启生效 |

* key\_store\_path

|名字| key\_store\_path |
|:---:|:---------------|
|描述| keyStore 所在路径(非必填) |
|类型| String |
|默认值| "" |
|改后生效方式| 重启生效 |

* key\_store\_pwd

|名字| key\_store\_pwd |
|:---:|:---------------|
|描述| keyStore 密码(非必填) |
|类型| String |
|默认值| "" |
|改后生效方式| 重启生效 |

* trust\_store\_path

|名字| trust\_store\_path |
|:---:|:---------------|
|描述| keyStore 密码(非必填) |
|类型| String |
|默认值| "" |
|改后生效方式| 重启生效 |

* trust\_store\_pwd

|名字| trust\_store\_pwd |
|:---:|:---------------|
|描述| trustStore 密码(非必填) |
|类型| String |
|默认值| "" |
|改后生效方式| 重启生效 |

* idle\_timeout

|名字| idle\_timeout |
|:---:|:--------------|
|描述| SSL 超时时间,单位为秒 |
|类型| int32 |
|默认值| 5000 |
|改后生效方式| 重启生效 |
Loading