Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Trigger Session Heartbeat

/versionv1/sessions/:session_handle/heartbeat

Verb: POST

Response code: 200 OK

Trigger heartbeat to tell the server that the client is active, and to keep the session alive as long as configured timeout value.

If a session does not receive a heartbeat or any other operations, the session will be destroyed when the timeout is reached.

Request body

{}

Response body

{}

...

/v1/info

Verb: GET

Response code: 200 OK

Get meta data for this cluster

Request body

{}

Response body

{

"product_name": "Apache Flink",

"version": "1.16" # Flink version

}

Get Version

/api_versions

Verb: GET

Response code: 200 OK

Get the current avaliable versions for the Rest Endpoint. The client can choose one of the return version as the protocol for later communicate.

Request body

{}

Response body

{

"versions": ["v1", "v2"] # The rest endpoint support version.

}

Options

Please using the following options to configure the REST endpint.

...

Parameter

Requried

Description

-he, --hostendpoint

Yes

The gateway address

-p, --port

Yes

The gatewary :port


User can start up the SQL Client with the command in the bash.

Code Block
languagebash
./sql-client.sh gateway -he 127.0.0.1 -p :9092


Usage

With the SQL Gateway, users can just use the SQL to do everything. 

...