openLooKeng REST API

This chapter defines the openLooKeng REST API. openLooKeng uses REST for all communication within a openLooKeng installation. JSON-based REST services facilitate communication between the client and the openLooKeng coordinator as well as for communicate between a openLooKeng coordinator and multiple openLooKeng workers. In this chapter you will find detailed descriptions of the APIs offered by openLooKeng as well as example requests and responses.

REST API Overview

In openLooKeng, everything is exposed as a REST API in openLooKeng and HTTP is the method by which all component communicate with each other.

The openLooKeng REST API contains several, high-level resources that correspond to the components of a openLooKeng installation.

Query Resource

The query resource takes a SQL query. It is available at the path /v1/query and accepts several HTTP methods.

Node Resource

The node resource returns information about worker nodes in a openLooKeng installation. It is available at the path /v1/node.

Stage Resource

When a openLooKeng coordinator receives a query it creates distribute system of stages which collaborate with one another to execute a query. The Stage resource is used by the coordinator to create a network of corresponding stages. It is also used by stages to coordinate with one another.

Statement Resource

This is the standard resource used by the client to execute a statement. When executing a statement, the openLooKeng client will call this resource repeatedly to get the status of an ongoing statement execution as well as the results of a completed statement.

Task Resource

A stage contains a number of components, one of which is a task. This resource is used by internal components to coordinate the execution of stages.

有奖捉虫

“有虫”文档片段

0/500

存在的问题

文档存在风险与错误

● 拼写,格式,无效链接等错误;

● 技术原理、功能、规格等描述和软件不一致,存在错误;

● 原理图、架构图等存在错误;

● 版本号不匹配:文档版本或内容描述和实际软件不一致;

● 对重要数据或系统存在风险的操作,缺少安全提示;

● 排版不美观,影响阅读;

内容描述不清晰

● 描述存在歧义;

● 图形、表格、文字等晦涩难懂;

● 逻辑不清晰,该分类、分项、分步骤的没有给出;

内容获取有困难

● 很难通过搜索引擎,openLooKeng官网,相关博客找到所需内容;

示例代码有错误

● 命令、命令参数等错误;

● 命令无法执行或无法完成对应功能;

内容有缺失

● 关键步骤错误或缺失,无法指导用户完成任务,比如安装、配置、部署等;

● 逻辑不清晰,该分类、分项、分步骤的没有给出

● 图形、表格、文字等晦涩难懂

● 缺少必要的前提条件、注意事项等;

● 描述存在歧义

0/500

您对文档的总体满意度

非常不满意
非常满意

请问是什么原因让您参与到这个问题中

您的邮箱

创Issue赢奖品
根据您的反馈,会自动生成issue模板。您只需点击按钮,创建issue即可。
有奖捉虫