# 笔记本资源 API
原文链接 : [http://zeppelin.apache.org/docs/0.7.2/index.html](http://zeppelin.apache.org/docs/0.7.2/index.html)
译文链接 : [http://www.apache.wiki/pages/viewpage.action?pageId=10031071](http://www.apache.wiki/pages/viewpage.action?pageId=10031071)
贡献者 : [片刻](/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)。
## 笔记本资源库REST API列表
### 列出所有可用的笔记本存储库
| 描述 | 该`GET`方法返回所有可用的笔记本存储库。 |
| 网址 | `http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories` |
| 成功代码 | 200 |
| 失败代码 | 500 |
| 示例JSON响应 |
```
{
"status": "OK",
"message": "",
"body": [
{
"name": "GitNotebookRepo",
"className": "org.apache.zeppelin.notebook.repo.GitNotebookRepo",
"settings": [
{
"type": "INPUT",
"value": [],
"selected": "ZEPPELIN_HOME/zeppelin/notebook/",
"name": "Notebook Path"
}
]
}
]
}
```
|
### 重新加载笔记本存储库
| 描述 | 该`GET`方法触发了重新加载和播放音符列表。 |
| 网址 | `http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories/reload` |
| 成功代码 | 200 |
| 失败代码 | 500 |
| 示例JSON响应 |
```
{
"status": "OK",
"message": ""
}
```
|
### 更新一个特定的笔记本存储库
| 描述 | 此`PUT`方法更新一个特定的笔记本存储库。 |
| 网址 | `http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories` |
| 成功代码 | 200 |
| 失败代码 | 当指定的笔记本存储库 对于任何其他错误的
无效有效载荷
500 不存在406 时,404 |
| 示例JSON输入 |
```
{
"name":"org.apache.zeppelin.notebook.repo.GitNotebookRepo",
"settings":{
"Notebook Path":"/tmp/notebook/"
}
}
```
|
| 示例JSON响应 |
```
{
"status": "OK",
"message": "",
"body": {
"name": "GitNotebookRepo",
"className": "org.apache.zeppelin.notebook.repo.GitNotebookRepo",
"settings": [
{
"type": "INPUT",
"value": [],
"selected": "/tmp/notebook/",
"name": "Notebook Path"
}
]
}
}
```
|
- 快速入门
- 什么是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) )