# Helium API
原文鏈接 : [http://zeppelin.apache.org/docs/0.7.2/rest-api/rest-helium.html](http://zeppelin.apache.org/docs/0.7.2/rest-api/rest-helium.html)
譯文鏈接 : [http://www.apache.wiki/pages/viewpage.action?pageId=10031086](http://www.apache.wiki/pages/viewpage.action?pageId=10031086)
貢獻者 : [片刻](/display/~jiangzhonglian) [ApacheCN](/display/~apachecn) [Apache中文網](/display/~apachechina)
## 概觀
Apache Zeppelin提供了幾個REST API，用于交互和遠程激活zeppelin功能。所有REST API都可以從以下端點開始`http://[zeppelin-server]:[zeppelin-port]/api`。需要注意的是Apache的齊柏林飛艇的REST API接收或返回JSON對象，建議你安裝一些JSON觀眾如[JSONView](https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc)。
如果您使用Apache Zeppelin并發現需要一個額外的REST API，請[提出問題或向我們發送電子郵件](http://zeppelin.apache.org/community.html)。
[?](http://zeppelin.apache.org/docs/0.7.2/rest-api/rest-helium.html#helium-rest-api-list)
## 氦REST API列表
### 所有可用氦氣包的清單
| 描述 | 此`GET`方法返回已配置注冊表中的所有可用氦包。 |
| 網址 | `http://[zeppelin-server]:[zeppelin-port]/api/helium/all` |
| 成功代碼 | 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
}
],
"zeppelin-bubblechart": [
{
"registry": "local",
"pkg": {
"type": "VISUALIZATION",
"name": "zeppelin-bubblechart",
"description": "Animated bubble chart",
"artifact": ".\/..\/helium\/zeppelin-bubble",
"icon": "icon"
},
"enabled": true
},
{
"registry": "local",
"pkg": {
"type": "VISUALIZATION",
"name": "zeppelin-bubblechart",
"description": "Animated bubble chart",
"artifact": "zeppelin-bubblechart@0.0.2",
"icon": "icon"
},
"enabled": false
}
],
"zeppelin_horizontalbar": [
{
"registry": "local",
"pkg": {
"type": "VISUALIZATION",
"name": "zeppelin_horizontalbar",
"description": "Horizontal Bar chart (example)",
"artifact": ".\/zeppelin-examples\/zeppelin-example-horizontalbar",
"icon": "icon"
},
"enabled": true
}
]
}
}?
```
|
### 建議氦氣應用
| 描述 | 該`GET`方法返回段落的建議氦氣應用。 |
| 網址 | `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
}
]
}
}
```
|
### **在一個段落上加載氦氣應用程序**
| 描述 | 此`GET`方法在成功時返回氦應用程序ID。 |
| 網址 | `http://[zeppelin-server]:[zeppelin-port]/api/helium/load/[Note ID]/[Paragraph ID]` |
| 成功代碼 | 200 |
| 失敗代碼 | 404的注釋或段落不存在
500任何其他錯誤 |
| 示例JSON響應 |
```
{
"status": "OK",
"message": "",
"body": "app2C5FYRZ1E-20170108-0404492068241472zeppelin_clock"
}
```
|
### **加載捆綁的可視化腳本**
| 描述 | 此`GET`方法返回捆綁的氦可視化javascript。當提供refresh = true（可選）時，Zeppelin重建包。否則，從緩存提供 |
| 網址 | `http://[zeppelin-server]:[zeppelin-port]/api/helium/visualizations/load[?refresh=true]` |
| 成功代碼 | 200回復體是可執行的javascript |
| 失敗代碼 | 200響應體是錯誤消息字符串以ERROR開頭： |
### **啟用包**
| 描述 | 這種`POST`方法可以實現氦氣包裝。需要輸入有效載荷中的工件名稱 |
| 網址 | `http://[zeppelin-server]:[zeppelin-port]/api/helium/enable/[Package Name]` |
| 成功代碼 | 200 |
| 失敗代碼 | 500 |
| 樣品輸入 |
```
飛艇-實例/飛艇-例如時鐘/目標/飛艇-例如時鐘-0.7.0-SNAPSHOT.jar
```
|
| 示例JSON響應 |
```
{"status":"OK"}
```
|
### **禁用包**
| 描述 | 該`POST`方法禁用氦氣包。 |
| 網址 | `http://[zeppelin-server]:[zeppelin-port]/api/helium/disable/[Package Name]` |
| 成功代碼 | 200 |
| 失敗代碼 | 500 |
| 示例JSON響應 |
```
{"status":"OK"}
```
|
### 獲取可視化顯示順序[](http://zeppelin.apache.org/docs/0.7.2/rest-api/rest-helium.html#get-visualization-display-order)
| 描述 | 此`GET`方法返回啟用的可視化包的顯示順序。 |
| 網址 | `http://[zeppelin-server]:[zeppelin-port]/api/helium/visualizationOrder` |
| 成功代碼 | 200 |
| 失敗代碼 | 500 |
| 示例JSON響應 | {"status":"OK","body":["zeppelin_horizontalbar","zeppelin-bubblechart"]} |
### 設置可視化顯示順序[](http://zeppelin.apache.org/docs/0.7.2/rest-api/rest-helium.html#set-visualization-display-order)
| 描述 | 此`POST`方法設置可視化包顯示順序。 |
| 網址 | `http://[zeppelin-server]:[zeppelin-port]/api/helium/visualizationOrder` |
| 成功代碼 | 200 |
| 失敗代碼 | 500 |
| 示例JSON輸入 | ["zeppelin-bubblechart", "zeppelin_horizontalbar"] |
| 示例JSON響應 |
```
{"status":"OK"}
```
|
- 快速入門
- 什么是Apache Zeppelin?
- 安裝
- 配置
- 探索Apache Zeppelin UI
- 教程
- 動態表單
- 發表你的段落
- 自定義Zeppelin主頁
- 升級Zeppelin版本
- 從源碼編譯
- 使用Flink和Spark Clusters安裝Zeppelin教程
- 解釋器
- 概述
- 解釋器安裝
- 解釋器依賴管理
- 解釋器的模擬用戶
- 解釋員執行Hook（實驗）
- Alluxio 解釋器
- Beam 解釋器
- BigQuery 解釋器
- Cassandra CQL 解釋器
- Elasticsearch 解釋器
- Flink 解釋器
- Geode/Gemfire OQL 解釋器
- HBase Shell 解釋器
- HDFS文件系統 解釋器
- Hive 解釋器
- Ignite 解釋器
- JDBC通用 解釋器
- Kylin 解釋器
- Lens 解釋器
- Livy 解釋器
- Markdown 解釋器
- Pig 解釋器
- PostgreSQL, HAWQ 解釋器
- Python 2＆3解釋器
- R 解釋器
- Scalding 解釋器
- Scio 解釋器
- Shell 解釋器
- Spark 解釋器
- 系統顯示
- 系統基本顯示
- 后端Angular API
- 前端Angular API
- 更多
- 筆記本存儲
- REST API
- 解釋器 API
- 筆記本 API
- 筆記本資源 API
- 配置 API
- 憑據 API
- Helium API
- Security ( 安全 )
- Shiro 授權
- 筆記本 授權
- 數據源 授權
- Helium 授權
- Advanced ( 高級 )
- Zeppelin on Vagrant VM ( Zeppelin 在 Vagrant 虛擬機上 )
- Zeppelin on Spark Cluster Mode( Spark 集群模式下的 Zeppelin )
- Zeppelin on CDH ( Zeppelin 在 CDH 上 )
- Contibute ( 貢獻 )
- Writing a New Interpreter ( 寫一個新的解釋器 )
- Writing a new Visualization (Experimental) ( 編寫新的可視化（實驗） )
- Writing a new Application (Experimental) ( 寫一個新的應用程序( 實驗 ) )
- Contributing to Apache Zeppelin ( Code ) ( 向 Apache Zeppelin 貢獻( 代碼 ) )
- Contributing to Apache Zeppelin ( Website ) ( 向 Apache Zeppelin 貢獻(website) )