apache/kyuubi
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity
292457edf8
kyuubi/docs/client/rest/rest_api.md
Fei Wang 14b9fd5e75 [KYUUBI #3722] Set default parameters for BatchesResource in server side 
### _Why are the changes needed?_

Set the same default values for BatchesResource in server side.
### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #3722 from turboFei/batch_user_defaults.

Closes #3722

496e61a55 [Fei Wang] default in server side

Authored-by: Fei Wang <fwang12@ebay.com>
Signed-off-by: Fei Wang <fwang12@ebay.com>
2022-10-30 17:53:31 +08:00

19 KiB
Raw Blame History

REST API v1

Note that: now the api version is v1 and the base uri is /api/v1.

Session Resource

GET /sessions

Get the list of all live sessions

Response Body

Name Description Type
identifier The session identifier String
user The user name that created the session String
ipAddr The client IP address that created the session String
conf The configuration of the session Map
createTime The session that created at this timestamp Long
duration The interval that last access time subtract created time Long
idleTime The interval of no operation Long

GET /sessions/${sessionHandle}

Get a session event

Response Body

The KyuubiSessionEvent.

GET /sessions/${sessionHandle}/info/${infoType}

Get an information detail of a session

Request Parameters

Name Description Type
infoType The id of Hive Thrift GetInfo Int

Response Body

Name Description Type
infoType The type of session information String
infoValue The value of session information String

GET /sessions/count

Get the current open session count

Response Body

Name Description Type
openSessionCount The count of opening session Int

GET /sessions/execPool/statistic

Get statistic info of background executors

Response Body

Name Description Type
execPoolSize The current number of threads in the pool Int
execPoolActiveCount The approximate number of threads that are actively executing tasks Int

POST /sessions

Create a session

Request Parameters

Name Description Type
protocolVersion The protocol version of Hive CLI service Int
user The user name String
password The user password String
ipAddr The user client IP address String
configs The configuration of the session Map

Response Body

Name Description Type
identifier The session handle identifier String

DELETE /sessions/${sessionHandle}

Close a session.

POST /sessions/${sessionHandle}/operations/statement

Create an operation with EXECUTE_STATEMENT type

Request Body

Name Description Type
statement The SQL statement that you execute String
runAsync The flag indicates whether the query runs synchronously or not Boolean
queryTimeout The interval of query time out Long

Response Body

Name Description Type
identifier The identifier of operation String

POST /sessions/${sessionHandle}/operations/typeInfo

Create an operation with GET_TYPE_INFO type

Response Body

Name Description Type
identifier The identifier of operation String

POST /sessions/${sessionHandle}/operations/catalogs

Create an operation with GET_CATALOGS type

Response Body

Name Description Type
identifier The identifier of operation String

POST /sessions/${sessionHandle}/operations/schemas

Create an operation with GET_SCHEMAS type

Request Body

Name Description Type
catalogName The catalog name String
schemaName The schema name String

Response Body

Name Description Type
identifier The identifier of operation String

POST /sessions/${sessionHandle}/operations/tables

Request Body

Name Description Type
catalogName The catalog name String
schemaName The schema name String
tableName The table name String
tableTypes The type of table, for example: TABLE or VIEW String

Response Body

Name Description Type
identifier The identifier of operation String

POST /sessions/${sessionHandle}/operations/tableTypes

Request Parameters

Response Body

Name Description Type
identifier The identifier of operation String

POST /sessions/${sessionHandle}/operations/columns

Request Body

Name Description Type
catalogName The catalog name String
schemaName The schema name String
tableName The table name String
columnName The column name String

Response Body

Name Description Type
identifier The identifier of operation String

POST /sessions/${sessionHandle}/operations/functions

Request Body

Name Description Type
catalogName The catalog name String
schemaName The schema name String
functionName The function name String

Response Body

Name Description Type
identifier The identifier of operation String

POST /sessions/${sessionHandle}/operations/primaryKeys

Request Parameters

Name Description Type
catalogName The catalog name String
schemaName The schema name String
tableName The table name String

Response Body

Name Description Type
identifier The identifier of operation String

POST /sessions/${sessionHandle}/operations/crossReference

Name Description Type
identifier The identifier of operation String

Request Body

Name Description Type
primaryCatalog The primary catalog name String
primarySchema The primary schema name String
primaryTable The primary table name String
foreignCatalog The foreign catalog name String
foreignSchema The foreign schema name String
foreignTable The foreign table name String

Response Body

Name Description Type
identifier The identifier of operation String

Batch Resource

GET /batches

Returns all the batches.

Request Parameters

Name Description Type
batchType The batch type, such as spark/flink, if no batchType is specified,
return all types		 String
batchState The valid batch state can be one of the following:
PENDING, RUNNING, FINISHED, ERROR, CANCELED		 String
batchUser The user name that created the batch String
createTime Return the batch that created after this timestamp Long
endTime Return the batch that ended before this timestamp Long
from The start index to fetch batches Int
size Number of batches to fetch, 100 by default Int

Response Body

Name Description Type
from The start index of fetched batches Int
total Number of batches fetched Int
batches Batch List List

POST /batches

Create a new batch.

Request Body

Name Description Type
batchType The batch type, such as Spark, Flink String
resource The resource containing the application to execute Path (required)
className Application main class String(required)
name The name of this batch. String
conf Configuration properties Map of key=val
args Command line arguments for the application List of Strings

Response Body

The created Batch object.

GET /batches/{batchId}

Returns the batch information.

Response Body

The Batch.

DELETE /batches/${batchId}

Kill the batch if it is still running.

Request Parameters

Name Description Type
hive.server2.proxy.user the proxy user to impersonate String(optional)

Response Body

Name Description Type
success Whether killed the batch successfully Boolean
msg The kill batch message String

GET /batches/${batchId}/localLog

Gets the local log lines from this batch.

Request Parameters

Name Description Type
from Offset Int
size Max number of log lines to return, 100 by default Int

Response Body

Name Description Type
logRowSet The log lines List of Strings
rowCount The log row count Int

Admin Resource

POST /admin/refresh/hadoop_conf

Refresh the Hadoop configurations of the Kyuubi server.

DELETE /admin/engine

Delete the specified engine.

Request Parameters

Name Description Type
type the engine type String(optional)
sharelevel the engine share level String(optional)
subdomain the engine subdomain String(optional)
hive.server2.proxy.user the proxy user to impersonate String(optional)

GET /admin/engine

Get a list of satisfied engines.

Request Parameters

Name Description Type
type the engine type String(optional)
sharelevel the engine share level String(optional)
subdomain the engine subdomain String(optional)
hive.server2.proxy.user the proxy user to impersonate String(optional)

Response Body

The Engine List.

REST Objects

Batch

Name Description Type
id The batch id String
user The user created the batch String
batchType The batch type String
name The batch name String
appId The batch application Id String
appUrl The batch application tracking url String
appState The batch application state String
appDiagnostic The batch application diagnostic String
kyuubiInstance The kyuubi instance that created the batch String
state The kyuubi batch operation state String
createTime The batch create time Long
endTime The batch end time, if it has not been terminated, the value is 0 Long

KyuubiSessionEvent

Name Description Type
sessionId The session id String
clientVersion The client version Int
sessionType The session type String
sessionName The session name, if user not specify it, we use empty string instead String
user The session user name String
clientIP The client ip address String
serverIP A unique Kyuubi server id, e.g. kyuubi server ip address and port, it is useful if has multi-instance Kyuubi Server String
conf The session config Map
startTime The session create time Long
remoteSessionId The remote engine session id String
engineId The engine id. For engine on yarn, it is applicationId String
openedTime The session opened time Long
endTime The session end time Long
totalOperations How many queries and meta calls Int
exception The session exception, such as the exception that occur when opening session Throwable
eventType The type of session event String

Engine

Name Description Type
version The version of the Kyuubi server that creates this engine instance String
user The user created the engine String
engineType The engine type String
sharelevel The engine share level String
subdomain The engine subdomain String
instance host:port for the engine node String
namespace The namespace used to expose the engine to KyuubiServers String