This is an automated email from the ASF dual-hosted git repository.
morningman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new a03a3753ada [feat](http-api) add broker op api (#2532)
a03a3753ada is described below
commit a03a3753adac86ab88a6a610804ced6c2b7dd2fc
Author: Mingyu Chen (Rayner) <[email protected]>
AuthorDate: Sat Jun 21 18:15:24 2025 +0800
[feat](http-api) add broker op api (#2532)
## Versions
- [x] dev
- [x] 3.0
- [ ] 2.1
- [ ] 2.0
## Languages
- [x] Chinese
- [x] English
## Docs Checklist
- [ ] Checked by AI
- [ ] Test Cases Built
---
docs/admin-manual/open-api/fe-http/node-action.md | 476 +++++++++++++--------
.../admin-manual/open-api/fe-http/node-action.md | 300 +++++++++----
.../admin-manual/open-api/fe-http/node-action.md | 300 +++++++++----
.../admin-manual/open-api/fe-http/node-action.md | 476 +++++++++++++--------
4 files changed, 1042 insertions(+), 510 deletions(-)
diff --git a/docs/admin-manual/open-api/fe-http/node-action.md
b/docs/admin-manual/open-api/fe-http/node-action.md
index 6669bf4bf61..e267bafafc7 100644
--- a/docs/admin-manual/open-api/fe-http/node-action.md
+++ b/docs/admin-manual/open-api/fe-http/node-action.md
@@ -1,6 +1,6 @@
---
{
- "title": "Node Action",
+ "title": "Node Operations",
"language": "en"
}
---
@@ -48,7 +48,9 @@ under the License.
`POST /rest/v2/manager/node/{action}/fe`
-## Get information about fe, be, broker nodes
+`POST /rest/v2/manager/node/{action}/broker` (3.0.7+)
+
+## Get fe, be, broker Node Information
`GET /rest/v2/manager/node/frontends`
@@ -58,7 +60,7 @@ under the License.
### Description
-Used to get cluster to get fe, be, broker node information.
+Used to get fe, be, broker node information from the cluster.
### Response
@@ -164,7 +166,7 @@ brokers:
}
```
-## Get node configuration information
+## Get Node Configuration Information
`GET /rest/v2/manager/node/configuration_name`
@@ -174,31 +176,38 @@ brokers:
### Description
-configuration_name Used to get the name of the node configuration item.
-node_list Get the list of nodes.
-configuration_info to get the node configuration details.
+- `configuration_name` is used to get node configuration item names.
+- `node_list` is used to get the node list.
+- `configuration_info` is used to get detailed node configuration information.
+
+### Query Parameters
-### Query parameters
`GET /rest/v2/manager/node/configuration_name`
-none
+
+None
`GET /rest/v2/manager/node/node_list`
-none
+
+None
`POST /rest/v2/manager/node/configuration_info`
* type
- The value is fe or be, which specifies to get the configuration information
of fe or the configuration information of be.
-### Request body
+ Value is fe or be, used to specify getting fe configuration information or
be configuration information.
+
+### Request Body
`GET /rest/v2/manager/node/configuration_name`
-none
+
+None
`GET /rest/v2/manager/node/node_list`
-none
+
+None
`POST /rest/v2/manager/node/configuration_info`
+
```
{
"conf_name": [
@@ -209,15 +218,18 @@ none
]
}
-If no body is included, the parameters in the body use the default values.
-conf_name specifies which configuration items to return, the default is all
configuration items.
-node is used to specify which node's configuration information is returned,
the default is all fe nodes or be nodes configuration information.
+If no body is provided, all parameters in the body use default values.
+
+conf_name is used to specify which configuration items' information to return,
defaults to returning all configuration items' information;
+
+node is used to specify which nodes' configuration item information to return,
defaults to all fe nodes or be nodes configuration item information.
```
### Response
+
`GET /rest/v2/manager/node/configuration_name`
-```json
+```
{
"msg": "success",
"code": 0,
@@ -235,7 +247,7 @@ node is used to specify which node's configuration
information is returned, the
`GET /rest/v2/manager/node/node_list`
-```json
+```
{
"msg": "success",
"code": 0,
@@ -253,27 +265,27 @@ node is used to specify which node's configuration
information is returned, the
`POST /rest/v2/manager/node/configuration_info?type=fe`
-```json
-{
- "msg": "success",
- "code": 0,
- "data": {
- "column_names": [
- "Configuration Item",
- "Node",
- "Node Type",
- "Configuration Value Type",
- "MasterOnly",
- "Configuration Value",
- "Modifiable"
- ],
- "rows": [
- [
- ""
- ]
- ]
- },
- "count": 0
+```
+{
+ "msg": "success",
+ "code": 0,
+ "data": {
+ "column_names": [
+ "配置项",
+ "节点",
+ "节点类型",
+ "配置值类型",
+ "MasterOnly",
+ "配置值",
+ "可修改"
+ ],
+ "rows": [
+ [
+ ""
+ ]
+ ]
+ },
+ "count": 0
}
```
@@ -284,12 +296,12 @@ node is used to specify which node's configuration
information is returned, the
"code": 0,
"data": {
"column_names": [
- "Configuration Item",
- "Node",
- "Node Type",
- "Configuration Value Type",
- "Configuration Value",
- "Modifiable"
+ "配置项",
+ "节点",
+ "节点类型",
+ "配置值类型",
+ "配置值",
+ "可修改"
],
"rows": [
[
@@ -303,12 +315,13 @@ node is used to specify which node's configuration
information is returned, the
### Examples
-1. Get the fe agent_task_resend_wait_time_ms configuration information:
+1. Get fe `agent_task_resend_wait_time_ms` configuration item information:
- POST /rest/v2/manager/node/configuration_info?type=fe
- body:
+ `POST /rest/v2/manager/node/configuration_info?type=fe`
- ```json
+ Body:
+
+ ```
{
"conf_name":[
"agent_task_resend_wait_time_ms"
@@ -318,37 +331,37 @@ node is used to specify which node's configuration
information is returned, the
Response:
- ```json
- {
- "msg": "success",
- "code": 0,
- "data": {
- "column_names": [
- "Configuration Item",
- "Node",
- "Node Type",
- "Configuration Value Type",
- "MasterOnly",
- "Configuration Value",
- "Modifiable"
- ],
- "rows": [
- [
- "agent_task_resend_wait_time_ms",
- "127.0.0.1:8030",
- "FE",
- "long",
- "true",
- "50000",
- "true"
- ]
- ]
- },
- "count": 0
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": {
+ "column_names": [
+ "配置项",
+ "节点",
+ "节点类型",
+ "配置值类型",
+ "MasterOnly",
+ "配置值",
+ "可修改"
+ ],
+ "rows": [
+ [
+ "agent_task_resend_wait_time_ms",
+ "127.0.0.1:8030",
+ "FE",
+ "long",
+ "true",
+ "50000",
+ "true"
+ ]
+ ]
+ },
+ "count": 0
}
```
-## Modify configuration values
+## Modify Configuration Values
`POST /rest/v2/manager/node/set_config/fe`
@@ -360,7 +373,7 @@ Used to modify fe or be node configuration values
### Request body
-```json
+```
{
"config_name":{
"node":[
@@ -370,17 +383,18 @@ Used to modify fe or be node configuration values
"persist":
}
}
-
-config_name is the corresponding configuration item.
-node is a keyword indicating the list of nodes to be modified;
-value is the value of the configuration.
-persist is true for permanent modification and false for temporary
modification. persist means permanent modification, false means temporary
modification. permanent modification takes effect after reboot, temporary
modification fails after reboot.
```
+- `config_name` is the corresponding configuration item;
+- `node` is a keyword, indicating the list of nodes to be modified;
+- `value` is the configuration value;
+- `persist` is true for permanent modification, false for temporary
modification. Permanent modification takes effect after restart, temporary
modification becomes invalid after restart.
+
### Response
+
`GET /rest/v2/manager/node/configuration_name`
-``` json
+```
{
"msg": "",
"code": 0,
@@ -397,17 +411,19 @@ persist is true for permanent modification and false for
temporary modification.
"count": 0
}
-failed Indicates a configuration message that failed to be modified.
```
+
+- `failed` indicates configuration information that failed to modify.
### Examples
-1. Modify the agent_task_resend_wait_time_ms and alter_table_timeout_second
configuration values in the fe 127.0.0.1:8030 node:
+1. Modify `agent_task_resend_wait_time_ms` and `alter_table_timeout_second`
configuration values in fe 127.0.0.1:8030 node:
+
+ `POST /rest/v2/manager/node/set_config/fe`
- POST /rest/v2/manager/node/set_config/fe
- body:
+ Body:
- ```json
+ ```
{
"agent_task_resend_wait_time_ms":{
"node":[
@@ -427,6 +443,7 @@ failed Indicates a configuration message that failed to be
modified.
```
Response:
+
```
{
"msg": "success",
@@ -444,164 +461,163 @@ failed Indicates a configuration message that failed to
be modified.
"count": 0
}
- gent_task_resend_wait_time_ms configuration value modified successfully,
alter_table_timeout_second modification failed.
```
-## Operate be node
+ `agent_task_resend_wait_time_ms` configuration value was modified
successfully, `alter_table_timeout_second` modification failed.
+
+## Operate be Nodes
`POST /rest/v2/manager/node/{action}/be`
### Description
-Used to add/drop/offline be node
+Used to add/drop/decommission be nodes
action：ADD/DROP/DECOMMISSION
### Request body
-
-```json
+```
{
"hostPorts": ["127.0.0.1:9050"],
"properties": {
"tag.location": "test"
}
}
-
-hostPorts A set of be node addresses to be operated, ip:heartbeat_port
-properties The configuration passed in when adding a node is only used to
configure the tag. If not, the default tag is used
```
+- `hostPorts` a group of be node addresses to operate `ip:heartbeat_port`
+- `properties` configuration passed when adding nodes, currently only used for
configuring tag, uses default tag if not passed
+
### Response
-```json
+```
{
"msg": "Error",
"code": 1,
"data": "errCode = 2, detailMessage = Same backend already
exists[127.0.0.1:9050]",
"count": 0
}
-
-msg Success/Error
-code 0/1
-data ""/Error message
```
### Examples
-1. add be node
+1. Add be node
- post /rest/v2/manager/node/ADD/be
- Request body
+ `POST /rest/v2/manager/node/ADD/be`
- ```json
- {
- "hostPorts": ["127.0.0.1:9050"]
- }
- ```
+ Request
+
+ ```
+ {
+ "hostPorts": ["127.0.0.1:9050"]
+ }
+ ```
Response
- ```json
- {
- "msg": "success",
- "code": 0,
- "data": null,
- "count": 0
- }
- ```
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
-2. drop be node
+2. Drop be node
- post /rest/v2/manager/node/DROP/be
- Request body
+ `POST /rest/v2/manager/node/DROP/be`
- ```json
- {
- "hostPorts": ["127.0.0.1:9050"]
- }
- ```
+ Request
+
+ ```
+ {
+ "hostPorts": ["127.0.0.1:9050"]
+ }
+ ```
Response
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
- ```json
- {
- "msg": "success",
- "code": 0,
- "data": null,
- "count": 0
- }
- ```
+3. Decommission be node
-3. offline be node
+ `POST /rest/v2/manager/node/DECOMMISSION/be`
- post /rest/v2/manager/node/DECOMMISSION/be
- Request body
- ```json
- {
- "hostPorts": ["127.0.0.1:9050"]
- }
- ```
+ Request
+
+ ```
+ {
+ "hostPorts": ["127.0.0.1:9050"]
+ }
+ ```
Response
- ```json
- {
- "msg": "success",
- "code": 0,
- "data": null,
- "count": 0
- }
- ```
-## Operate fe node
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
+
+## Operate fe Nodes
`POST /rest/v2/manager/node/{action}/fe`
### Description
-Used to add/drop fe node
+Used to add/drop fe nodes
action：ADD/DROP
### Request body
-```json
+```
{
"role": "FOLLOWER",
"hostPort": "127.0.0.1:9030"
}
role FOLLOWER/OBSERVER
-hostPort The address of the fe node to be operated, ip:edit_log_port
+hostPort fe node address to operate ip:edit_log_port
```
### Response
-```json
+
+```
{
"msg": "Error",
"code": 1,
"data": "errCode = 2, detailMessage = frontend already exists name:
127.0.0.1:9030_1670495889415, role: FOLLOWER, 127.0.0.1:9030",
"count": 0
}
-
-msg Success/Error
-code 0/1
-data ""/Error message
```
### Examples
-1. add FOLLOWER node
+1. Add FOLLOWER node
+
+ `POST /rest/v2/manager/node/ADD/fe`
- post /rest/v2/manager/node/ADD/fe
- Request body
- ```json
+ Request
+ ```
{
"role": "FOLLOWER",
"hostPort": "127.0.0.1:9030"
}
```
+
+ Response
- Response
- ```json
+ ```
{
"msg": "success",
"code": 0,
@@ -610,23 +626,133 @@ data ""/Error message
}
```
-2. drop FOLLOWER node
+2. Drop FOLLOWER node
+
+ `POST /rest/v2/manager/node/DROP/fe`
+
+ Request
+
+ ```
+ {
+ "role": "FOLLOWER",
+ "hostPort": "127.0.0.1:9030"
+ }
+ ```
+
+ Response
+
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
+
+## Operate broker Nodes
+
+`POST /rest/v2/manager/node/{action}/broker`
+
+Supported since 3.0.7.
+
+### Description
+
+Used to add/drop broker nodes
+
+action：ADD/DROP/DROP_ALL
+
+### Request body
+
+```
+{
+ "brokerName": "your_broker_name",
+ "hostPortList": "broker_ip:broker_port"
+}
+```
+
+### Response
- post /rest/v2/manager/node/DROP/fe
- Request body
- ```json
+```
+{
+ "msg": "Error",
+ "code": 1,
+ "data": "errCode = 2, detailMessage = xxxx",
+ "count": 0
+}
+```
+
+### Examples
+
+1. Add BROKER node
+
+ `POST /rest/v2/manager/node/ADD/broker`
+
+ Request
+
+ ```
{
- "role": "FOLLOWER",
- "hostPort": "127.0.0.1:9030"
+ "brokerName": "hdfs_broker",
+ "hostPortList": "127.0.0.1:8001"
}
```
+
+ Response
- Response
- ```json
+ ```
{
"msg": "success",
"code": 0,
"data": null,
"count": 0
}
- ```
\ No newline at end of file
+ ```
+
+2. Drop BROKER node
+
+ `POST /rest/v2/manager/node/DROP/broker`
+
+ Request
+
+ ```
+ {
+ "brokerName": "hdfs_broker",
+ "hostPortList": "127.0.0.1:8001"
+ }
+ ```
+
+ Response
+
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
+
+3. Drop a group of BROKER nodes
+
+ `POST /rest/v2/manager/node/DROP_ALL/broker`
+
+ Request
+
+ ```
+ {
+ "brokerName": "hdfs_broker",
+ "hostPortList": ""
+ }
+ ```
+
+ Response
+
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
+
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/open-api/fe-http/node-action.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/open-api/fe-http/node-action.md
index 2e578d8611a..da58072c4d0 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/open-api/fe-http/node-action.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/open-api/fe-http/node-action.md
@@ -48,6 +48,8 @@ under the License.
`POST /rest/v2/manager/node/{action}/fe`
+`POST /rest/v2/manager/node/{action}/broker` (3.0.7+)
+
## 获取 fe, be, broker 节点信息
`GET /rest/v2/manager/node/frontends`
@@ -174,31 +176,38 @@ brokers:
### Description
-configuration_name 用于获取节点配置项名称。
-node_list 用于获取节点列表。
-configuration_info 用于获取节点配置详细信息。
+- `configuration_name` 用于获取节点配置项名称。
+- `node_list` 用于获取节点列表。
+- `configuration_info` 用于获取节点配置详细信息。
### Query parameters
+
`GET /rest/v2/manager/node/configuration_name`
+
无
`GET /rest/v2/manager/node/node_list`
+
无
`POST /rest/v2/manager/node/configuration_info`
* type
+
值为 fe 或 be，用于指定获取 fe 的配置信息或 be 的配置信息。
### Request body
`GET /rest/v2/manager/node/configuration_name`
+
无
`GET /rest/v2/manager/node/node_list`
+
无
`POST /rest/v2/manager/node/configuration_info`
+
```
{
"conf_name": [
@@ -210,12 +219,16 @@ configuration_info 用于获取节点配置详细信息。
}
若不带body，body中的参数都使用默认值。
+
conf_name 用于指定返回哪些配置项的信息， 默认返回所有配置项信息；
+
node 用于指定返回哪些节点的配置项信息，默认为全部fe节点或be节点配置项信息。
```
### Response
+
`GET /rest/v2/manager/node/configuration_name`
+
```
{
"msg": "success",
@@ -233,6 +246,7 @@ node 用于指定返回哪些节点的配置项信息，默认为全部fe节点
```
`GET /rest/v2/manager/node/node_list`
+
```
{
"msg": "success",
@@ -250,6 +264,7 @@ node 用于指定返回哪些节点的配置项信息，默认为全部fe节点
```
`POST /rest/v2/manager/node/configuration_info?type=fe`
+
```
{
"msg": "success",
@@ -300,10 +315,12 @@ node 用于指定返回哪些节点的配置项信息，默认为全部fe节点
### Examples
-1. 获取 fe agent_task_resend_wait_time_ms 配置项信息：
+1. 获取 fe `agent_task_resend_wait_time_ms` 配置项信息：
+
+ `POST /rest/v2/manager/node/configuration_info?type=fe`
+
+ Body:
- POST /rest/v2/manager/node/configuration_info?type=fe
- body:
```
{
"conf_name":[
@@ -313,6 +330,7 @@ node 用于指定返回哪些节点的配置项信息，默认为全部fe节点
```
Response:
+
```
{
"msg": "success",
@@ -354,6 +372,7 @@ node 用于指定返回哪些节点的配置项信息，默认为全部fe节点
用于修改 fe 或 be 节点配置值
### Request body
+
```
{
"config_name":{
@@ -364,15 +383,17 @@ node 用于指定返回哪些节点的配置项信息，默认为全部fe节点
"persist":
}
}
-
-config_name为对应的配置项；
-node为关键字，表示要修改的节点列表;
-value为配置的值；
-persist为 true 表示永久修改， false 表示临时修改。永久修改重启后能生效， 临时修改重启后失效。
```
+- `config_name` 为对应的配置项；
+- `node` 为关键字，表示要修改的节点列表;
+- `value` 为配置的值；
+- `persist` 为 true 表示永久修改， false 表示临时修改。永久修改重启后能生效， 临时修改重启后失效。
+
### Response
+
`GET /rest/v2/manager/node/configuration_name`
+
```
{
"msg": "",
@@ -390,15 +411,18 @@ persist为 true 表示永久修改， false 表示临时修改。永久修改重
"count": 0
}
-failed 表示修改失败的配置信息。
```
+
+- `failed` 表示修改失败的配置信息。
### Examples
-1. 修改 fe 127.0.0.1:8030 节点中 agent_task_resend_wait_time_ms 和
alter_table_timeout_second 配置值：
+1. 修改 fe 127.0.0.1:8030 节点中 `agent_task_resend_wait_time_ms` 和
`alter_table_timeout_second` 配置值：
+
+ `POST /rest/v2/manager/node/set_config/fe`
+
+ Body:
- POST /rest/v2/manager/node/set_config/fe
- body:
```
{
"agent_task_resend_wait_time_ms":{
@@ -419,6 +443,7 @@ failed 表示修改失败的配置信息。
```
Response:
+
```
{
"msg": "success",
@@ -436,8 +461,9 @@ failed 表示修改失败的配置信息。
"count": 0
}
- agent_task_resend_wait_time_ms 配置值修改成功，alter_table_timeout_second 修改失败。
```
+
+ `agent_task_resend_wait_time_ms` 配置值修改成功，`alter_table_timeout_second` 修改失败。
## 操作 be 节点
@@ -457,12 +483,13 @@ action：ADD/DROP/DECOMMISSION
"tag.location": "test"
}
}
-
-hostPorts 需要操作的一组 be 节点地址 ip:heartbeat_port
-properties 添加节点时传入的配置，目前只用于配置 tag, 不传使用默认 tag
```
+- `hostPorts` 需要操作的一组 be 节点地址 `ip:heartbeat_port`
+- `properties` 添加节点时传入的配置，目前只用于配置 tag, 不传使用默认 tag
+
### Response
+
```
{
"msg": "Error",
@@ -470,73 +497,77 @@ properties 添加节点时传入的配置，目前只用于配置 tag, 不传使
"data": "errCode = 2, detailMessage = Same backend already
exists[127.0.0.1:9050]",
"count": 0
}
-
-msg Success/Error
-code 0/1
-data ""/报错信息
```
### Examples
1. 添加 be 节点
- post /rest/v2/manager/node/ADD/be
- Request body
- ```
- {
- "hostPorts": ["127.0.0.1:9050"]
- }
- ```
+ `POST /rest/v2/manager/node/ADD/be`
+
+ Request
+
+ ```
+ {
+ "hostPorts": ["127.0.0.1:9050"]
+ }
+ ```
Response
- ```
- {
- "msg": "success",
- "code": 0,
- "data": null,
- "count": 0
- }
- ```
+
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
2. 删除 be 节点
- post /rest/v2/manager/node/DROP/be
- Request body
- ```
- {
- "hostPorts": ["127.0.0.1:9050"]
- }
- ```
+ `POST /rest/v2/manager/node/DROP/be`
+
+ Request
+
+ ```
+ {
+ "hostPorts": ["127.0.0.1:9050"]
+ }
+ ```
Response
- ```
- {
- "msg": "success",
- "code": 0,
- "data": null,
- "count": 0
- }
- ```
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
3. 下线 be 节点
- post /rest/v2/manager/node/DECOMMISSION/be
- Request body
- ```
- {
- "hostPorts": ["127.0.0.1:9050"]
- }
- ```
+ `POST /rest/v2/manager/node/DECOMMISSION/be`
+
+ Request
+
+ ```
+ {
+ "hostPorts": ["127.0.0.1:9050"]
+ }
+ ```
Response
- ```
- {
- "msg": "success",
- "code": 0,
- "data": null,
- "count": 0
- }
- ```
+
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
## 操作 fe 节点
@@ -560,6 +591,7 @@ hostPort 需要操作的 fe 节点地址 ip:edit_log_port
```
### Response
+
```
{
"msg": "Error",
@@ -567,18 +599,15 @@ hostPort 需要操作的 fe 节点地址 ip:edit_log_port
"data": "errCode = 2, detailMessage = frontend already exists name:
127.0.0.1:9030_1670495889415, role: FOLLOWER, 127.0.0.1:9030",
"count": 0
}
-
-msg Success/Error
-code 0/1
-data ""/报错信息
```
### Examples
1. 添加 FOLLOWER 节点
- post /rest/v2/manager/node/ADD/fe
- Request body
+ `POST /rest/v2/manager/node/ADD/fe`
+
+ Request
```
{
"role": "FOLLOWER",
@@ -587,6 +616,7 @@ data ""/报错信息
```
Response
+
```
{
"msg": "success",
@@ -598,16 +628,77 @@ data ""/报错信息
2. 删除 FOLLOWER 节点
- post /rest/v2/manager/node/DROP/fe
- Request body
+ `POST /rest/v2/manager/node/DROP/fe`
+
+ Request
+
+ ```
+ {
+ "role": "FOLLOWER",
+ "hostPort": "127.0.0.1:9030"
+ }
+ ```
+
+ Response
+
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
+
+## 操作 broker 节点
+
+`POST /rest/v2/manager/node/{action}/broker`
+
+自 3.0.7 支持。
+
+### Description
+
+用于添加/删除 broker 节点
+
+action：ADD/DROP/DROP_ALL
+
+### Request body
+
+```
+{
+ "brokerName": "your_broker_name",
+ "hostPortList": "broker_ip:broker_port"
+}
+```
+
+### Response
+
+```
+{
+ "msg": "Error",
+ "code": 1,
+ "data": "errCode = 2, detailMessage = xxxx",
+ "count": 0
+}
+```
+
+### Examples
+
+1. 添加 BROKER 节点
+
+ `POST /rest/v2/manager/node/ADD/broker`
+
+ Request
+
```
{
- "role": "FOLLOWER",
- "hostPort": "127.0.0.1:9030"
+ "brokerName": "hdfs_broker",
+ "hostPortList": "127.0.0.1:8001"
}
```
+
+ Response
- Response
```
{
"msg": "success",
@@ -615,4 +706,53 @@ data ""/报错信息
"data": null,
"count": 0
}
- ```
\ No newline at end of file
+ ```
+
+2. 删除 BROKER 节点
+
+ `POST /rest/v2/manager/node/DROP/broker`
+
+ Request
+
+ ```
+ {
+ "brokerName": "hdfs_broker",
+ "hostPortList": "127.0.0.1:8001"
+ }
+ ```
+
+ Response
+
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
+
+3. 删除一组 BROKER 节点
+
+ `POST /rest/v2/manager/node/DROP_ALL/broker`
+
+ Request
+
+ ```
+ {
+ "brokerName": "hdfs_broker",
+ "hostPortList": ""
+ }
+ ```
+
+ Response
+
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
+
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/open-api/fe-http/node-action.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/open-api/fe-http/node-action.md
index 2e578d8611a..da58072c4d0 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/open-api/fe-http/node-action.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/open-api/fe-http/node-action.md
@@ -48,6 +48,8 @@ under the License.
`POST /rest/v2/manager/node/{action}/fe`
+`POST /rest/v2/manager/node/{action}/broker` (3.0.7+)
+
## 获取 fe, be, broker 节点信息
`GET /rest/v2/manager/node/frontends`
@@ -174,31 +176,38 @@ brokers:
### Description
-configuration_name 用于获取节点配置项名称。
-node_list 用于获取节点列表。
-configuration_info 用于获取节点配置详细信息。
+- `configuration_name` 用于获取节点配置项名称。
+- `node_list` 用于获取节点列表。
+- `configuration_info` 用于获取节点配置详细信息。
### Query parameters
+
`GET /rest/v2/manager/node/configuration_name`
+
无
`GET /rest/v2/manager/node/node_list`
+
无
`POST /rest/v2/manager/node/configuration_info`
* type
+
值为 fe 或 be，用于指定获取 fe 的配置信息或 be 的配置信息。
### Request body
`GET /rest/v2/manager/node/configuration_name`
+
无
`GET /rest/v2/manager/node/node_list`
+
无
`POST /rest/v2/manager/node/configuration_info`
+
```
{
"conf_name": [
@@ -210,12 +219,16 @@ configuration_info 用于获取节点配置详细信息。
}
若不带body，body中的参数都使用默认值。
+
conf_name 用于指定返回哪些配置项的信息， 默认返回所有配置项信息；
+
node 用于指定返回哪些节点的配置项信息，默认为全部fe节点或be节点配置项信息。
```
### Response
+
`GET /rest/v2/manager/node/configuration_name`
+
```
{
"msg": "success",
@@ -233,6 +246,7 @@ node 用于指定返回哪些节点的配置项信息，默认为全部fe节点
```
`GET /rest/v2/manager/node/node_list`
+
```
{
"msg": "success",
@@ -250,6 +264,7 @@ node 用于指定返回哪些节点的配置项信息，默认为全部fe节点
```
`POST /rest/v2/manager/node/configuration_info?type=fe`
+
```
{
"msg": "success",
@@ -300,10 +315,12 @@ node 用于指定返回哪些节点的配置项信息，默认为全部fe节点
### Examples
-1. 获取 fe agent_task_resend_wait_time_ms 配置项信息：
+1. 获取 fe `agent_task_resend_wait_time_ms` 配置项信息：
+
+ `POST /rest/v2/manager/node/configuration_info?type=fe`
+
+ Body:
- POST /rest/v2/manager/node/configuration_info?type=fe
- body:
```
{
"conf_name":[
@@ -313,6 +330,7 @@ node 用于指定返回哪些节点的配置项信息，默认为全部fe节点
```
Response:
+
```
{
"msg": "success",
@@ -354,6 +372,7 @@ node 用于指定返回哪些节点的配置项信息，默认为全部fe节点
用于修改 fe 或 be 节点配置值
### Request body
+
```
{
"config_name":{
@@ -364,15 +383,17 @@ node 用于指定返回哪些节点的配置项信息，默认为全部fe节点
"persist":
}
}
-
-config_name为对应的配置项；
-node为关键字，表示要修改的节点列表;
-value为配置的值；
-persist为 true 表示永久修改， false 表示临时修改。永久修改重启后能生效， 临时修改重启后失效。
```
+- `config_name` 为对应的配置项；
+- `node` 为关键字，表示要修改的节点列表;
+- `value` 为配置的值；
+- `persist` 为 true 表示永久修改， false 表示临时修改。永久修改重启后能生效， 临时修改重启后失效。
+
### Response
+
`GET /rest/v2/manager/node/configuration_name`
+
```
{
"msg": "",
@@ -390,15 +411,18 @@ persist为 true 表示永久修改， false 表示临时修改。永久修改重
"count": 0
}
-failed 表示修改失败的配置信息。
```
+
+- `failed` 表示修改失败的配置信息。
### Examples
-1. 修改 fe 127.0.0.1:8030 节点中 agent_task_resend_wait_time_ms 和
alter_table_timeout_second 配置值：
+1. 修改 fe 127.0.0.1:8030 节点中 `agent_task_resend_wait_time_ms` 和
`alter_table_timeout_second` 配置值：
+
+ `POST /rest/v2/manager/node/set_config/fe`
+
+ Body:
- POST /rest/v2/manager/node/set_config/fe
- body:
```
{
"agent_task_resend_wait_time_ms":{
@@ -419,6 +443,7 @@ failed 表示修改失败的配置信息。
```
Response:
+
```
{
"msg": "success",
@@ -436,8 +461,9 @@ failed 表示修改失败的配置信息。
"count": 0
}
- agent_task_resend_wait_time_ms 配置值修改成功，alter_table_timeout_second 修改失败。
```
+
+ `agent_task_resend_wait_time_ms` 配置值修改成功，`alter_table_timeout_second` 修改失败。
## 操作 be 节点
@@ -457,12 +483,13 @@ action：ADD/DROP/DECOMMISSION
"tag.location": "test"
}
}
-
-hostPorts 需要操作的一组 be 节点地址 ip:heartbeat_port
-properties 添加节点时传入的配置，目前只用于配置 tag, 不传使用默认 tag
```
+- `hostPorts` 需要操作的一组 be 节点地址 `ip:heartbeat_port`
+- `properties` 添加节点时传入的配置，目前只用于配置 tag, 不传使用默认 tag
+
### Response
+
```
{
"msg": "Error",
@@ -470,73 +497,77 @@ properties 添加节点时传入的配置，目前只用于配置 tag, 不传使
"data": "errCode = 2, detailMessage = Same backend already
exists[127.0.0.1:9050]",
"count": 0
}
-
-msg Success/Error
-code 0/1
-data ""/报错信息
```
### Examples
1. 添加 be 节点
- post /rest/v2/manager/node/ADD/be
- Request body
- ```
- {
- "hostPorts": ["127.0.0.1:9050"]
- }
- ```
+ `POST /rest/v2/manager/node/ADD/be`
+
+ Request
+
+ ```
+ {
+ "hostPorts": ["127.0.0.1:9050"]
+ }
+ ```
Response
- ```
- {
- "msg": "success",
- "code": 0,
- "data": null,
- "count": 0
- }
- ```
+
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
2. 删除 be 节点
- post /rest/v2/manager/node/DROP/be
- Request body
- ```
- {
- "hostPorts": ["127.0.0.1:9050"]
- }
- ```
+ `POST /rest/v2/manager/node/DROP/be`
+
+ Request
+
+ ```
+ {
+ "hostPorts": ["127.0.0.1:9050"]
+ }
+ ```
Response
- ```
- {
- "msg": "success",
- "code": 0,
- "data": null,
- "count": 0
- }
- ```
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
3. 下线 be 节点
- post /rest/v2/manager/node/DECOMMISSION/be
- Request body
- ```
- {
- "hostPorts": ["127.0.0.1:9050"]
- }
- ```
+ `POST /rest/v2/manager/node/DECOMMISSION/be`
+
+ Request
+
+ ```
+ {
+ "hostPorts": ["127.0.0.1:9050"]
+ }
+ ```
Response
- ```
- {
- "msg": "success",
- "code": 0,
- "data": null,
- "count": 0
- }
- ```
+
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
## 操作 fe 节点
@@ -560,6 +591,7 @@ hostPort 需要操作的 fe 节点地址 ip:edit_log_port
```
### Response
+
```
{
"msg": "Error",
@@ -567,18 +599,15 @@ hostPort 需要操作的 fe 节点地址 ip:edit_log_port
"data": "errCode = 2, detailMessage = frontend already exists name:
127.0.0.1:9030_1670495889415, role: FOLLOWER, 127.0.0.1:9030",
"count": 0
}
-
-msg Success/Error
-code 0/1
-data ""/报错信息
```
### Examples
1. 添加 FOLLOWER 节点
- post /rest/v2/manager/node/ADD/fe
- Request body
+ `POST /rest/v2/manager/node/ADD/fe`
+
+ Request
```
{
"role": "FOLLOWER",
@@ -587,6 +616,7 @@ data ""/报错信息
```
Response
+
```
{
"msg": "success",
@@ -598,16 +628,77 @@ data ""/报错信息
2. 删除 FOLLOWER 节点
- post /rest/v2/manager/node/DROP/fe
- Request body
+ `POST /rest/v2/manager/node/DROP/fe`
+
+ Request
+
+ ```
+ {
+ "role": "FOLLOWER",
+ "hostPort": "127.0.0.1:9030"
+ }
+ ```
+
+ Response
+
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
+
+## 操作 broker 节点
+
+`POST /rest/v2/manager/node/{action}/broker`
+
+自 3.0.7 支持。
+
+### Description
+
+用于添加/删除 broker 节点
+
+action：ADD/DROP/DROP_ALL
+
+### Request body
+
+```
+{
+ "brokerName": "your_broker_name",
+ "hostPortList": "broker_ip:broker_port"
+}
+```
+
+### Response
+
+```
+{
+ "msg": "Error",
+ "code": 1,
+ "data": "errCode = 2, detailMessage = xxxx",
+ "count": 0
+}
+```
+
+### Examples
+
+1. 添加 BROKER 节点
+
+ `POST /rest/v2/manager/node/ADD/broker`
+
+ Request
+
```
{
- "role": "FOLLOWER",
- "hostPort": "127.0.0.1:9030"
+ "brokerName": "hdfs_broker",
+ "hostPortList": "127.0.0.1:8001"
}
```
+
+ Response
- Response
```
{
"msg": "success",
@@ -615,4 +706,53 @@ data ""/报错信息
"data": null,
"count": 0
}
- ```
\ No newline at end of file
+ ```
+
+2. 删除 BROKER 节点
+
+ `POST /rest/v2/manager/node/DROP/broker`
+
+ Request
+
+ ```
+ {
+ "brokerName": "hdfs_broker",
+ "hostPortList": "127.0.0.1:8001"
+ }
+ ```
+
+ Response
+
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
+
+3. 删除一组 BROKER 节点
+
+ `POST /rest/v2/manager/node/DROP_ALL/broker`
+
+ Request
+
+ ```
+ {
+ "brokerName": "hdfs_broker",
+ "hostPortList": ""
+ }
+ ```
+
+ Response
+
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
+
diff --git
a/versioned_docs/version-3.0/admin-manual/open-api/fe-http/node-action.md
b/versioned_docs/version-3.0/admin-manual/open-api/fe-http/node-action.md
index 6669bf4bf61..e267bafafc7 100644
--- a/versioned_docs/version-3.0/admin-manual/open-api/fe-http/node-action.md
+++ b/versioned_docs/version-3.0/admin-manual/open-api/fe-http/node-action.md
@@ -1,6 +1,6 @@
---
{
- "title": "Node Action",
+ "title": "Node Operations",
"language": "en"
}
---
@@ -48,7 +48,9 @@ under the License.
`POST /rest/v2/manager/node/{action}/fe`
-## Get information about fe, be, broker nodes
+`POST /rest/v2/manager/node/{action}/broker` (3.0.7+)
+
+## Get fe, be, broker Node Information
`GET /rest/v2/manager/node/frontends`
@@ -58,7 +60,7 @@ under the License.
### Description
-Used to get cluster to get fe, be, broker node information.
+Used to get fe, be, broker node information from the cluster.
### Response
@@ -164,7 +166,7 @@ brokers:
}
```
-## Get node configuration information
+## Get Node Configuration Information
`GET /rest/v2/manager/node/configuration_name`
@@ -174,31 +176,38 @@ brokers:
### Description
-configuration_name Used to get the name of the node configuration item.
-node_list Get the list of nodes.
-configuration_info to get the node configuration details.
+- `configuration_name` is used to get node configuration item names.
+- `node_list` is used to get the node list.
+- `configuration_info` is used to get detailed node configuration information.
+
+### Query Parameters
-### Query parameters
`GET /rest/v2/manager/node/configuration_name`
-none
+
+None
`GET /rest/v2/manager/node/node_list`
-none
+
+None
`POST /rest/v2/manager/node/configuration_info`
* type
- The value is fe or be, which specifies to get the configuration information
of fe or the configuration information of be.
-### Request body
+ Value is fe or be, used to specify getting fe configuration information or
be configuration information.
+
+### Request Body
`GET /rest/v2/manager/node/configuration_name`
-none
+
+None
`GET /rest/v2/manager/node/node_list`
-none
+
+None
`POST /rest/v2/manager/node/configuration_info`
+
```
{
"conf_name": [
@@ -209,15 +218,18 @@ none
]
}
-If no body is included, the parameters in the body use the default values.
-conf_name specifies which configuration items to return, the default is all
configuration items.
-node is used to specify which node's configuration information is returned,
the default is all fe nodes or be nodes configuration information.
+If no body is provided, all parameters in the body use default values.
+
+conf_name is used to specify which configuration items' information to return,
defaults to returning all configuration items' information;
+
+node is used to specify which nodes' configuration item information to return,
defaults to all fe nodes or be nodes configuration item information.
```
### Response
+
`GET /rest/v2/manager/node/configuration_name`
-```json
+```
{
"msg": "success",
"code": 0,
@@ -235,7 +247,7 @@ node is used to specify which node's configuration
information is returned, the
`GET /rest/v2/manager/node/node_list`
-```json
+```
{
"msg": "success",
"code": 0,
@@ -253,27 +265,27 @@ node is used to specify which node's configuration
information is returned, the
`POST /rest/v2/manager/node/configuration_info?type=fe`
-```json
-{
- "msg": "success",
- "code": 0,
- "data": {
- "column_names": [
- "Configuration Item",
- "Node",
- "Node Type",
- "Configuration Value Type",
- "MasterOnly",
- "Configuration Value",
- "Modifiable"
- ],
- "rows": [
- [
- ""
- ]
- ]
- },
- "count": 0
+```
+{
+ "msg": "success",
+ "code": 0,
+ "data": {
+ "column_names": [
+ "配置项",
+ "节点",
+ "节点类型",
+ "配置值类型",
+ "MasterOnly",
+ "配置值",
+ "可修改"
+ ],
+ "rows": [
+ [
+ ""
+ ]
+ ]
+ },
+ "count": 0
}
```
@@ -284,12 +296,12 @@ node is used to specify which node's configuration
information is returned, the
"code": 0,
"data": {
"column_names": [
- "Configuration Item",
- "Node",
- "Node Type",
- "Configuration Value Type",
- "Configuration Value",
- "Modifiable"
+ "配置项",
+ "节点",
+ "节点类型",
+ "配置值类型",
+ "配置值",
+ "可修改"
],
"rows": [
[
@@ -303,12 +315,13 @@ node is used to specify which node's configuration
information is returned, the
### Examples
-1. Get the fe agent_task_resend_wait_time_ms configuration information:
+1. Get fe `agent_task_resend_wait_time_ms` configuration item information:
- POST /rest/v2/manager/node/configuration_info?type=fe
- body:
+ `POST /rest/v2/manager/node/configuration_info?type=fe`
- ```json
+ Body:
+
+ ```
{
"conf_name":[
"agent_task_resend_wait_time_ms"
@@ -318,37 +331,37 @@ node is used to specify which node's configuration
information is returned, the
Response:
- ```json
- {
- "msg": "success",
- "code": 0,
- "data": {
- "column_names": [
- "Configuration Item",
- "Node",
- "Node Type",
- "Configuration Value Type",
- "MasterOnly",
- "Configuration Value",
- "Modifiable"
- ],
- "rows": [
- [
- "agent_task_resend_wait_time_ms",
- "127.0.0.1:8030",
- "FE",
- "long",
- "true",
- "50000",
- "true"
- ]
- ]
- },
- "count": 0
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": {
+ "column_names": [
+ "配置项",
+ "节点",
+ "节点类型",
+ "配置值类型",
+ "MasterOnly",
+ "配置值",
+ "可修改"
+ ],
+ "rows": [
+ [
+ "agent_task_resend_wait_time_ms",
+ "127.0.0.1:8030",
+ "FE",
+ "long",
+ "true",
+ "50000",
+ "true"
+ ]
+ ]
+ },
+ "count": 0
}
```
-## Modify configuration values
+## Modify Configuration Values
`POST /rest/v2/manager/node/set_config/fe`
@@ -360,7 +373,7 @@ Used to modify fe or be node configuration values
### Request body
-```json
+```
{
"config_name":{
"node":[
@@ -370,17 +383,18 @@ Used to modify fe or be node configuration values
"persist":
}
}
-
-config_name is the corresponding configuration item.
-node is a keyword indicating the list of nodes to be modified;
-value is the value of the configuration.
-persist is true for permanent modification and false for temporary
modification. persist means permanent modification, false means temporary
modification. permanent modification takes effect after reboot, temporary
modification fails after reboot.
```
+- `config_name` is the corresponding configuration item;
+- `node` is a keyword, indicating the list of nodes to be modified;
+- `value` is the configuration value;
+- `persist` is true for permanent modification, false for temporary
modification. Permanent modification takes effect after restart, temporary
modification becomes invalid after restart.
+
### Response
+
`GET /rest/v2/manager/node/configuration_name`
-``` json
+```
{
"msg": "",
"code": 0,
@@ -397,17 +411,19 @@ persist is true for permanent modification and false for
temporary modification.
"count": 0
}
-failed Indicates a configuration message that failed to be modified.
```
+
+- `failed` indicates configuration information that failed to modify.
### Examples
-1. Modify the agent_task_resend_wait_time_ms and alter_table_timeout_second
configuration values in the fe 127.0.0.1:8030 node:
+1. Modify `agent_task_resend_wait_time_ms` and `alter_table_timeout_second`
configuration values in fe 127.0.0.1:8030 node:
+
+ `POST /rest/v2/manager/node/set_config/fe`
- POST /rest/v2/manager/node/set_config/fe
- body:
+ Body:
- ```json
+ ```
{
"agent_task_resend_wait_time_ms":{
"node":[
@@ -427,6 +443,7 @@ failed Indicates a configuration message that failed to be
modified.
```
Response:
+
```
{
"msg": "success",
@@ -444,164 +461,163 @@ failed Indicates a configuration message that failed to
be modified.
"count": 0
}
- gent_task_resend_wait_time_ms configuration value modified successfully,
alter_table_timeout_second modification failed.
```
-## Operate be node
+ `agent_task_resend_wait_time_ms` configuration value was modified
successfully, `alter_table_timeout_second` modification failed.
+
+## Operate be Nodes
`POST /rest/v2/manager/node/{action}/be`
### Description
-Used to add/drop/offline be node
+Used to add/drop/decommission be nodes
action：ADD/DROP/DECOMMISSION
### Request body
-
-```json
+```
{
"hostPorts": ["127.0.0.1:9050"],
"properties": {
"tag.location": "test"
}
}
-
-hostPorts A set of be node addresses to be operated, ip:heartbeat_port
-properties The configuration passed in when adding a node is only used to
configure the tag. If not, the default tag is used
```
+- `hostPorts` a group of be node addresses to operate `ip:heartbeat_port`
+- `properties` configuration passed when adding nodes, currently only used for
configuring tag, uses default tag if not passed
+
### Response
-```json
+```
{
"msg": "Error",
"code": 1,
"data": "errCode = 2, detailMessage = Same backend already
exists[127.0.0.1:9050]",
"count": 0
}
-
-msg Success/Error
-code 0/1
-data ""/Error message
```
### Examples
-1. add be node
+1. Add be node
- post /rest/v2/manager/node/ADD/be
- Request body
+ `POST /rest/v2/manager/node/ADD/be`
- ```json
- {
- "hostPorts": ["127.0.0.1:9050"]
- }
- ```
+ Request
+
+ ```
+ {
+ "hostPorts": ["127.0.0.1:9050"]
+ }
+ ```
Response
- ```json
- {
- "msg": "success",
- "code": 0,
- "data": null,
- "count": 0
- }
- ```
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
-2. drop be node
+2. Drop be node
- post /rest/v2/manager/node/DROP/be
- Request body
+ `POST /rest/v2/manager/node/DROP/be`
- ```json
- {
- "hostPorts": ["127.0.0.1:9050"]
- }
- ```
+ Request
+
+ ```
+ {
+ "hostPorts": ["127.0.0.1:9050"]
+ }
+ ```
Response
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
- ```json
- {
- "msg": "success",
- "code": 0,
- "data": null,
- "count": 0
- }
- ```
+3. Decommission be node
-3. offline be node
+ `POST /rest/v2/manager/node/DECOMMISSION/be`
- post /rest/v2/manager/node/DECOMMISSION/be
- Request body
- ```json
- {
- "hostPorts": ["127.0.0.1:9050"]
- }
- ```
+ Request
+
+ ```
+ {
+ "hostPorts": ["127.0.0.1:9050"]
+ }
+ ```
Response
- ```json
- {
- "msg": "success",
- "code": 0,
- "data": null,
- "count": 0
- }
- ```
-## Operate fe node
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
+
+## Operate fe Nodes
`POST /rest/v2/manager/node/{action}/fe`
### Description
-Used to add/drop fe node
+Used to add/drop fe nodes
action：ADD/DROP
### Request body
-```json
+```
{
"role": "FOLLOWER",
"hostPort": "127.0.0.1:9030"
}
role FOLLOWER/OBSERVER
-hostPort The address of the fe node to be operated, ip:edit_log_port
+hostPort fe node address to operate ip:edit_log_port
```
### Response
-```json
+
+```
{
"msg": "Error",
"code": 1,
"data": "errCode = 2, detailMessage = frontend already exists name:
127.0.0.1:9030_1670495889415, role: FOLLOWER, 127.0.0.1:9030",
"count": 0
}
-
-msg Success/Error
-code 0/1
-data ""/Error message
```
### Examples
-1. add FOLLOWER node
+1. Add FOLLOWER node
+
+ `POST /rest/v2/manager/node/ADD/fe`
- post /rest/v2/manager/node/ADD/fe
- Request body
- ```json
+ Request
+ ```
{
"role": "FOLLOWER",
"hostPort": "127.0.0.1:9030"
}
```
+
+ Response
- Response
- ```json
+ ```
{
"msg": "success",
"code": 0,
@@ -610,23 +626,133 @@ data ""/Error message
}
```
-2. drop FOLLOWER node
+2. Drop FOLLOWER node
+
+ `POST /rest/v2/manager/node/DROP/fe`
+
+ Request
+
+ ```
+ {
+ "role": "FOLLOWER",
+ "hostPort": "127.0.0.1:9030"
+ }
+ ```
+
+ Response
+
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
+
+## Operate broker Nodes
+
+`POST /rest/v2/manager/node/{action}/broker`
+
+Supported since 3.0.7.
+
+### Description
+
+Used to add/drop broker nodes
+
+action：ADD/DROP/DROP_ALL
+
+### Request body
+
+```
+{
+ "brokerName": "your_broker_name",
+ "hostPortList": "broker_ip:broker_port"
+}
+```
+
+### Response
- post /rest/v2/manager/node/DROP/fe
- Request body
- ```json
+```
+{
+ "msg": "Error",
+ "code": 1,
+ "data": "errCode = 2, detailMessage = xxxx",
+ "count": 0
+}
+```
+
+### Examples
+
+1. Add BROKER node
+
+ `POST /rest/v2/manager/node/ADD/broker`
+
+ Request
+
+ ```
{
- "role": "FOLLOWER",
- "hostPort": "127.0.0.1:9030"
+ "brokerName": "hdfs_broker",
+ "hostPortList": "127.0.0.1:8001"
}
```
+
+ Response
- Response
- ```json
+ ```
{
"msg": "success",
"code": 0,
"data": null,
"count": 0
}
- ```
\ No newline at end of file
+ ```
+
+2. Drop BROKER node
+
+ `POST /rest/v2/manager/node/DROP/broker`
+
+ Request
+
+ ```
+ {
+ "brokerName": "hdfs_broker",
+ "hostPortList": "127.0.0.1:8001"
+ }
+ ```
+
+ Response
+
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
+
+3. Drop a group of BROKER nodes
+
+ `POST /rest/v2/manager/node/DROP_ALL/broker`
+
+ Request
+
+ ```
+ {
+ "brokerName": "hdfs_broker",
+ "hostPortList": ""
+ }
+ ```
+
+ Response
+
+ ```
+ {
+ "msg": "success",
+ "code": 0,
+ "data": null,
+ "count": 0
+ }
+ ```
+
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
