Apache Zeppelin Helium REST API

概述

Apache Zeppelin 提供了多个 REST API 用于交互和远程激活 Zeppelin 功能。 所有 REST API 都从以下端点开始可用 http://[zeppelin-server]:[zeppelin-port]/api。 请注意，Apache Zeppelin 的 REST API 接收或返回 JSON 对象，建议您安装一些 JSON 查看器，例如 JSONView。

如果您在使用Apache Zeppelin时发现需要额外的REST API，请提交问题或发送电子邮件给我们。

Helium REST API 列表

获取所有可用的helium包

描述 此GET方法返回配置的注册表中所有可用的helium包。
URL http://[zeppelin-server]:[zeppelin-port]/api/helium/package
成功代码 200
失败代码 500
示例JSON响应 

{
  "status": "OK",
  "message": "",
  "body": {
    "zeppelin.clock": [
      {
        "registry": "local",
        "pkg": {
          "type": "APPLICATION",
          "name": "zeppelin.clock",
          "description": "Clock (example)",
          "artifact": "zeppelin-examples\/zeppelin-example-clock\/target\/zeppelin-example
-clock-0.7.0-SNAPSHOT.jar",
          "className": "org.apache.zeppelin.example.app.clock.Clock",
          "resources": [
            [
              ":java.util.Date"
            ]
          ],
          "icon": "icon"
        },
        "enabled": false
      }
    ]
  }
}


（注：由于提供的HTML内容为空，没有需要翻译的文本，因此输出与输入相同。）

获取所有启用的氦气包

描述 此GET方法返回配置的注册表中所有启用的helium包。
URL http://[zeppelin-server]:[zeppelin-port]/api/helium/enabledPackage
成功代码 200
失败代码 500
示例JSON响应 

{
  "status": "OK",
  "message": "",
  "body": {
    "zeppelin.clock": [
      {
        "registry": "local",
        "pkg": {
          "type": "APPLICATION",
          "name": "zeppelin.clock",
          "description": "Clock (example)",
          "artifact": "zeppelin-examples\/zeppelin-example-clock\/target\/zeppelin-example
-clock-0.7.0-SNAPSHOT.jar",
          "className": "org.apache.zeppelin.example.app.clock.Clock",
          "resources": [
            [
              ":java.util.Date"
            ]
          ],
          "icon": "icon"
        },
        "enabled": false
      }
    ]
  }
}


（注：由于提供的HTML内容为空，没有需要翻译的文本，因此输出与输入相同。）

获取单个氦气包

描述 此GET方法返回指定的helium包信息
URL http://[zeppelin-server]:[zeppelin-port]/api/helium/package/[Package Name]
成功代码 200
失败代码 500
示例JSON响应 

{
  "status": "OK",
  "message": "",
  "body": {
    "zeppelin.clock": [
      {
        "registry": "local",
        "pkg": {
          "type": "APPLICATION",
          "name": "zeppelin.clock",
          "description": "Clock (example)",
          "artifact": "zeppelin-examples\/zeppelin-example-clock\/target\/zeppelin-example
-clock-0.7.0-SNAPSHOT.jar",
          "className": "org.apache.zeppelin.example.app.clock.Clock",
          "resources": [
            [
              ":java.util.Date"
            ]
          ],
          "icon": "icon"
        },
        "enabled": false
      }
    ]
  }
}


（注：由于提供的HTML内容为空，没有需要翻译的文本，因此输出与输入相同。）

在段落上建议使用Helium包

描述 此GET方法返回段落的建议氦包。
URL http://[zeppelin-server]:[zeppelin-port]/api/helium/suggest/[Note ID]/[Paragraph ID]
成功代码 200
失败代码 404 当笔记或段落不存在时
500
示例JSON响应 

{
  "status": "OK",
  "message": "",
  "body": {
    "available": [
      {
        "registry": "local",
        "pkg": {
          "type": "APPLICATION",
          "name": "zeppelin.clock",
          "description": "Clock (example)",
          "artifact": "zeppelin-examples\/zeppelin-example-clock\/target\/zeppelin-example
-clock-0.7.0-SNAPSHOT.jar",
          "className": "org.apache.zeppelin.example.app.clock.Clock",
          "resources": [
            [
              ":java.util.Date"
            ]
          ],
          "icon": "icon"
        },
        "enabled": true
      }
    ]
  }
}


（注：由于提供的HTML内容为空，没有需要翻译的文本，因此输出与输入相同。）

在段落上加载Helium包

描述 此POST方法将氦包加载到目标段落。
URL http://[zeppelin-server]:[zeppelin-port]/api/helium/load/[Note ID]/[Paragraph ID]
成功代码 200
失败代码 404 当笔记或段落不存在时
500
示例JSON响应 

{
  "status": "OK",
  "message": "",
  "body": "app_2C5FYRZ1E-20170108-040449_2068241472zeppelin_clock"
}


（注：由于提供的HTML内容为空，没有需要翻译的文本，因此输出与输入相同。）

加载捆绑的可视化脚本

描述 此GET方法返回捆绑的helium可视化javascript。当提供refresh=true（可选）时，Zeppelin会重新构建捆绑包。否则，它将从缓存中提供
URL http://[zeppelin-server]:[zeppelin-port]/api/helium/bundle/load/[Package Name][?refresh=true]
成功代码 200 响应体是可执行的javascript
失败代码 200 响应体是以ERROR:开头的错误消息字符串

启用包

描述 此POST方法用于启用一个helium包。需要在输入负载中提供工件名称
URL http://[zeppelin-server]:[zeppelin-port]/api/helium/enable/[Package Name]
成功代码 200
失败代码 500
示例输入 
zeppelin-examples/zeppelin-example-clock/target/zeppelin-example-clock-0.7.0-SNAPSHOT.jar
示例JSON响应 

{"status":"OK"}


（注：由于提供的HTML内容为空，没有需要翻译的文本，因此输出与输入相同。）

禁用包

描述 此POST方法用于禁用氦气包。
URL http://[zeppelin-server]:[zeppelin-port]/api/helium/disable/[Package Name]
成功代码 200
失败代码 500
示例JSON响应 

{"status":"OK"}


（注：由于提供的HTML内容为空，没有需要翻译的文本，因此输出与输入相同。）

获取可视化显示顺序

描述 此GET方法返回启用的可视化包的显示顺序。
URL http://[zeppelin-server]:[zeppelin-port]/api/helium/order/visualization
成功代码 200
失败代码 500
示例JSON响应 

{"status":"OK","body":["zeppelin_horizontalbar","zeppelin-bubblechart"]}


（注：由于提供的HTML内容为空，没有需要翻译的文本，因此输出与输入相同。）

设置可视化显示顺序

描述 此POST方法设置可视化包的显示顺序。
URL http://[zeppelin-server]:[zeppelin-port]/api/helium/order/visualization
成功代码 200
失败代码 500
示例JSON输入 

["zeppelin-bubblechart", "zeppelin_horizontalbar"]

示例 JSON 响应 

{"status":"OK"}


（注：由于提供的HTML内容为空，没有需要翻译的文本，因此输出与输入相同。）

获取所有Helium包的配置

描述 此GET方法返回所有Helium包的配置
URL http://[zeppelin-server]:[zeppelin-port]/api/helium/config
成功代码 200
失败代码 500

### 获取特定包的配置

描述 此GET方法返回指定包名称和工件的配置
URL http://[zeppelin-server]:[zeppelin-port]/api/helium/config/[Package Name]/[Artifact]
成功代码 200
失败代码 500

为特定包设置配置

描述 此POST方法更新指定包名称和工件的配置
URL http://[zeppelin-server]:[zeppelin-port]/api/helium/config/[Package Name]/[Artifact]
成功代码 200
失败代码 500


### 获取单个包的拼写配置

描述 此GET方法返回指定的包Spell配置
URL http://[zeppelin-server]:[zeppelin-port]/api/helium/spell/config/[Package Name]
成功代码 200
失败代码 500