Page History

接口名称

功能描述

RequestMapping

是否鉴权

MetaService

fe 元数据相关API，除`/dump` 以外，都为fe 节点之间内部通讯用，/dump 用于获取image 文件的存储路径

1. GET /image (/info) (/version) (/put) (/journal_id) (/role) (/check)

2. GET /dump

否（checkFromValidFe）1
否（executeCheckPassword ）2

BackendsAction

返回be 列表，包括IP、PORT 等信息

GET /api/backends

是（executeCheckPassword）
checkGlobalAuth-PrivPredicate.ADMIN

GetSmallFileAction

下载在文件管理器中的文件

GET /api/get_small_file?token=xxx&file_id=xxx

否（executeCheckPassword + checkGlobalAuth-PrivPredicate.ADMIN）

HealthAction

返回集群当前存活与宕机的be 节点数

GET /api/health

否（executeCheckPassword）

MetaInfoAction

获取集群内的元数据信息
数据库列表
表列表
表结构

1. GET /api/meta/namespaces/<ns>/databases

2. GET /api/meta/namespaces/<ns>/databases/<db>/tables

3. GET /api/meta/namespaces/<ns>/databases/<db>/tables/<tbl_name>/schema

是（checkWithCookie）
checkGlobalAuth-PrivPredicate.ADMIN

ShowAction

获取集群/数据库的相关信息
元数据信息
PROC 信息
JVM 的Runtime 信息
集群/数据库的数据量

1. GET /api/show_meta_info?action=xxx

2. GET /api/show_proc

3. GET /api/show_runtime_info

4. GET /api/show_data/<db>

否（executeCheckPassword + checkGlobalAuth-PrivPredicate.ADMIN）1，3，4
是（executeCheckPassword + checkGlobalAuth-PrivPredicate.ADMIN）2

StmtExecutionAction

1. 执行sql 语句并返回结果

2. 获取sql 中相关表的建表语句

1. POST /api/query/<ns>/<db>

2. POST /api/query_schema/<ns>/<db>

是（checkWithCookie）
checkDbAuth-PrivPredicate.ADMIN 1

MetricsAction

获取metrics

GET /metrics

否（executeCheckPassword）

BootstrapFinishAction

判断fe 是否启动完成

GET /api/bootstrap

否（executeCheckPassword）

ExtraBasepathAction

返回接口API 的base path

GET /api/basepath

否（executeCheckPassword）

ImportAction

查看格式为CSV 或PARQUET 的文件内容

POST /api/import/file_review

否（executeCheckPassword）

StatisticAction

获取集群统计信息、库表数量等

GET /rest/v2/api/cluster_overview

否（executeCheckPassword）