Versions Compared

Key

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


Status

Current state"Under DiscussionAccepted"

Discussion thread: https://lists.apache.org/thread/gr7soo29z884r1scnz77r2hwr2xmd9b0

Vote thread: https://lists.apache.org/thread/x2q63b5f61tfslrcro6ww4ol80ryk1f2

JIRAhere (<- link to 

Jira
serverASF JIRA
serverId5aa69414-a9e9-3523-82ec-879b028fb15b
keyFLINK-15472
)

...

/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.

...

to manipulate the sql gateway.

CommandParmeterDescription
start-Dkey=value

Start the gateway and write the pid of the startted sql gateway into the pid file. 


Users can specify the -Dkey=value to specify the parameters. For example, users can specify `-Dsql-gateway.endpoint.rest.address=127.0.0.1` 

stop(none)Stop the last in the pid file.
stop-all(none)Stop all the server in the running pid file.


Then users can start the sql client to communicate with the SQL Gateway in the local or remote environment.

...