GET /rest/v2/manager/node/frontends
GET /rest/v2/manager/node/backends
GET /rest/v2/manager/node/brokers
GET /rest/v2/manager/node/configuration_name
GET /rest/v2/manager/node/node_list
POST /rest/v2/manager/node/configuration_info
POST /rest/v2/manager/node/set_config/fe
POST /rest/v2/manager/node/set_config/be
POST /rest/v2/manager/node/{action}/be
POST /rest/v2/manager/node/{action}/fe
GET /rest/v2/manager/node/frontends
GET /rest/v2/manager/node/backends
GET /rest/v2/manager/node/brokers
Used to get cluster to get fe, be, broker node information.
frontends: { "msg": "success", "code": 0, "data": { "column_names": [ "Name", "IP", "HostName", "EditLogPort", "HttpPort", "QueryPort", "RpcPort", "ArrowFlightSqlPort", "Role", "IsMaster", "ClusterId", "Join", "Alive", "ReplayedJournalId", "LastHeartbeat", "IsHelper", "ErrMsg", "Version" ], "rows": [ [ ... ] ] }, "count": 0 }
backends: { "msg": "success", "code": 0, "data": { "column_names": [ "BackendId", "Cluster", "IP", "HostName", "HeartbeatPort", "BePort", "HttpPort", "BrpcPort", "LastStartTime", "LastHeartbeat", "Alive", "SystemDecommissioned", "ClusterDecommissioned", "TabletNum", "DataUsedCapacity", "AvailCapacity", "TotalCapacity", "UsedPct", "MaxDiskUsedPct", "ErrMsg", "Version", "Status" ], "rows": [ [ ... ] ] }, "count": 0 }
brokers: { "msg": "success", "code": 0, "data": { "column_names": [ "Name", "IP", "HostName", "Port", "Alive", "LastStartTime", "LastUpdateTime", "ErrMsg" ], "rows": [ [ ... ] ] }, "count": 0 }
GET /rest/v2/manager/node/configuration_name
GET /rest/v2/manager/node/node_list
POST /rest/v2/manager/node/configuration_info
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.
GET /rest/v2/manager/node/configuration_name
none
GET /rest/v2/manager/node/node_list
none
POST /rest/v2/manager/node/configuration_info
GET /rest/v2/manager/node/configuration_name
none
GET /rest/v2/manager/node/node_list
none
POST /rest/v2/manager/node/configuration_info
{ "conf_name": [ "" ], "node": [ "" ] } 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.
GET /rest/v2/manager/node/configuration_name
{ "msg": "success", "code": 0, "data": { "backend":[ "" ], "frontend":[ "" ] }, "count": 0 }
GET /rest/v2/manager/node/node_list
{ "msg": "success", "code": 0, "data": { "backend": [ "" ], "frontend": [ "" ] }, "count": 0 }
POST /rest/v2/manager/node/configuration_info?type=fe
{ "msg": "success", "code": 0, "data": { "column_names": [ "配置项", "节点", "节点类型", "配置值类型", "MasterOnly", "配置值", "可修改" ], "rows": [ [ "" ] ] }, "count": 0 }
POST /rest/v2/manager/node/configuration_info?type=be
{ "msg": "success", "code": 0, "data": { "column_names": [ "配置项", "节点", "节点类型", "配置值类型", "配置值", "可修改" ], "rows": [ [ "" ] ] }, "count": 0 }
Get the fe agent_task_resend_wait_time_ms configuration information:
POST /rest/v2/manager/node/configuration_info?type=fe
body:
{ "conf_name":[ "agent_task_resend_wait_time_ms" ] }
Response:
{ "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 }
POST /rest/v2/manager/node/set_config/fe
POST /rest/v2/manager/node/set_config/be
Used to modify fe or be node configuration values
{ "config_name":{ "node":[ "" ], "value":"", "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.
GET /rest/v2/manager/node/configuration_name
{ "msg": "", "code": 0, "data": { "failed":[ { "config_name":"name", "value"="", "node":"", "err_info":"" } ] }, "count": 0 } failed Indicates a configuration message that failed to be modified.
Modify the agent_task_resend_wait_time_ms and alter_table_timeout_second configuration values in the fe 127.0.0.1:8030 node:
POST /rest/v2/manager/node/set_config/fe body:
{ "agent_task_resend_wait_time_ms":{ "node":[ "127.0.0.1:8030" ], "value":"10000", "persist":"true" }, "alter_table_timeout_second":{ "node":[ "127.0.0.1:8030" ], "value":"true", "persist":"true" } }
Response:
{ "msg": "success", "code": 0, "data": { "failed": [ { "config_name": "alter_table_timeout_second", "node": "10.81.85.89:8837", "err_info": "Unsupported configuration value type.", "value": "true" } ] }, "count": 0 } gent_task_resend_wait_time_ms configuration value modified successfully, alter_table_timeout_second modification failed.
POST /rest/v2/manager/node/{action}/be
Used to add/drop/offline be node
action:ADD/DROP/DECOMMISSION
{ "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
{ "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
add be node
post /rest/v2/manager/node/ADD/be Request body
{ "hostPorts": ["127.0.0.1:9050"] }
Response
{ "msg": "success", "code": 0, "data": null, "count": 0 }
drop be node
post /rest/v2/manager/node/DROP/be Request body
{ "hostPorts": ["127.0.0.1:9050"] }
Response
{ "msg": "success", "code": 0, "data": null, "count": 0 }
offline be node
post /rest/v2/manager/node/DECOMMISSION/be Request body
{ "hostPorts": ["127.0.0.1:9050"] }
Response
{ "msg": "success", "code": 0, "data": null, "count": 0 }
POST /rest/v2/manager/node/{action}/fe
Used to add/drop fe node
action:ADD/DROP
{ "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
{ "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
add FOLLOWER node
post /rest/v2/manager/node/ADD/fe Request body
{ "role": "FOLLOWER", "hostPort": "127.0.0.1:9030" }
Response
{ "msg": "success", "code": 0, "data": null, "count": 0 }
drop FOLLOWER node
post /rest/v2/manager/node/DROP/fe Request body
{ "role": "FOLLOWER", "hostPort": "127.0.0.1:9030" }
Response
{ "msg": "success", "code": 0, "data": null, "count": 0 }