Files

Mingyu Chen 1191048f5f [UI Part 2] Add HTTP API documents of Frontend (#4584 )

Origin:

bootstrap-action
cancel-load-action
check-decommission-action
check-storage-type-action
config-action
connection-action
get-ddl-stmt-action
get-load-info-action
get-load-state
get-log-file-action
get-small-file
ha-action
hardware-info-action
health-action
log-action
meta-action
meta-info-action
meta-replay-state-action
profile-action
query-detail-action
query-profile-action
row-count-action
session-action
set-config-action
show-data-action
show-proc-action
show-runtime-info-action
system-action
table-query-plan-action
table-row-count-action
table-schema-action

New:

logout-action
show-meta-info-action
statement-execution-action
upload-action

2020-09-16 15:02:38 +08:00

2.5 KiB

Raw Blame History

title, language

title	language
Bootstrap Action	en

Bootstrap Action

Request

GET /api/bootstrap

Description

It is used to judge whether the FE has started. When no parameters are provided, only whether the startup is successful is returned. If token and cluster_id are provided, more detailed information is returned.

Path parameters

none

Query parameters

cluster_id

The cluster id. It can be viewed in the file palo-meta/image/VERSION.
token

Cluster token. It can be viewed in the file palo-meta/image/VERSION.

Request body

none

Response

No parameters provided
```
{
	"msg": "OK",
	"code": 0,
	"data": null,
	"count": 0
}
```
A code of 0 means that the FE node has started successfully. Error codes other than 0 indicate other errors.
Provide token and cluster_id
```
{
	"msg": "OK",
	"code": 0,
	"data": {
		"queryPort": 9030,
		"rpcPort": 9020,
		"maxReplayedJournal": 17287
	},
	"count": 0
}
```
- queryPort is the MySQL protocol port of the FE node.
- rpcPort is the thrift RPC port of the FE node.
- maxReplayedJournal represents the maximum metadata journal id currently played back by the FE node.

Examples

No parameters

GET /api/bootstrap

Response:
{
	"msg": "OK",
	"code": 0,
	"data": null,
	"count": 0
}

Provide token and cluster_id

GET /api/bootstrap?cluster_id=935437471&token=ad87f6dd-c93f-4880-bcdb-8ca8c9ab3031

Response:
{
	"msg": "OK",
	"code": 0,
	"data": {
		"queryPort": 9030,
		"rpcPort": 9020,
		"maxReplayedJournal": 17287
	},
	"count": 0
}

2.5 KiB Raw Blame History