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 doris-meta/image/VERSION. - token

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

Request body

none

Response

  • No parameters provided

1. { 2. "msg": "OK", 3. "code": 0, 4. "data": null, 5. "count": 0 6. }

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

1. { 2. "msg": "OK", 3. "code": 0, 4. "data": { 5. "queryPort": 9030, 6. "rpcPort": 9020, 7. "arrowFlightSqlPort": 9040, 8. "maxReplayedJournal": 17287 9. }, 10. "count": 0 11. }

  • 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.
  • arrowFlightSqlPort is the Arrow Flight SQL port of the FE node.

Examples

  1. No parameters

``` 1. GET /api/bootstrap

  1. Response:
  2. {
  3. "msg": "OK",
  4. "code": 0,
  5. "data": null,
  6. "count": 0
  7. } ```
  8. Provide token and cluster_id

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

  1. Response:
  2. {
  3. "msg": "OK",
  4. "code": 0,
  5. "data": {
  6. "queryPort": 9030,
  7. "rpcPort": 9020,
  8. "arrowFlightSqlPort": 9040,
  9. "maxReplayedJournal": 17287
  10. },
  11. "count": 0
  12. } ```