解释器 API

原文链接 : http://zeppelin.apache.org/docs/0.7.2/rest-api/rest-interpreter.html

译文链接 : http://www.apache.wiki/pages/viewpage.action?pageId=10030697

贡献者 : 小瑶 ApacheCN Apache中文网

Overview ( 概述 )

Apache Zeppelin 提供了几个 REST API ，用于交互和远程激活 zeppelin 功能。所有 REST API 都可以从以下端点。请注意，Apache Zeppelin REST API 接收或返回 JSON 对象，建议您安装 JSON 查看器如 JSONView 。

如果您使用 Apache Zeppelin 并发现需要一个额外的 REST API ，请 提出问题或向我们发送电子邮件 。

解释器REST API列表

这里介绍了 registered interpreters ， settings ( 设置 ) 和 interpreters group 的作用。

注册解释器人员名单

| 描述 | 该 GET 方法返回服务器上可用的 all the registered interpreters ( 所有已注册的解释器 ) 。 | | URL | http://[zeppelin-server]:[zeppelin-port]/api/interpreter | | 成功代码 | 200 | | 失败代码 | 500 | | JSON 响应示例 | 

  1. {
  2.   "status": "OK",
  3.   "message": "",
  4.   "body": {
  5.     "md.md": {
  6.       "name": "md",
  7.       "group": "md",
  8.       "className": "org.apache.zeppelin.markdown.Markdown",
  9.       "properties": {},
  10.       "path": "/zeppelin/interpreter/md"
  11.     },
  12.     "spark.spark": {
  13.       "name": "spark",
  14.       "group": "spark",
  15.       "className": "org.apache.zeppelin.spark.SparkInterpreter",
  16.       "properties": {
  17.         "spark.executor.memory": {
  18.           "defaultValue": "1g",
  19.           "description": "Executor memory per worker instance. ex) 512m, 32g"
  20.         },
  21.         "spark.cores.max": {
  22.           "defaultValue": "",
  23.           "description": "Total number of cores to use. Empty value uses all available core."
  24.         },
  25.       },
  26.       "path": "/zeppelin/interpreter/spark"
  27.     },
  28.     "spark.sql": {
  29.       "name": "sql",
  30.       "group": "spark",
  31.       "className": "org.apache.zeppelin.spark.SparkSqlInterpreter",
  32.       "properties": {
  33.         "zeppelin.spark.maxResult": {
  34.           "defaultValue": "1000",
  35.           "description": "Max number of Spark SQL result to display."
  36.         }
  37.       },
  38.       "path": "/zeppelin/interpreter/spark"
  39.     }
  40.   }
  41. }

|

注册解释器设定清单

| 描述 | 该 GET 方法返回服务器上注册的所有解释器设置。 | | URL | http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting | | 成功代码 | 200 | | 失败代码 | 500 | | JSON 响应示例 | 

  1. {
  2.   "status": "OK",
  3.   "message": "",
  4.   "body": [
  5.     {
  6.       "id": "2AYUGP2D5",
  7.       "name": "md",
  8.       "group": "md",
  9.       "properties": {
  10.         "empty": ""
  11.       },
  12.       "interpreterGroup": [
  13.         {
  14.           "class": "org.apache.zeppelin.markdown.Markdown",
  15.           "name": "md"
  16.         }
  17.       ],
  18.       "dependencies": []
  19.     },
  21.     {
  22.       "id": "2AY6GV7Q3",
  23.       "name": "spark",
  24.       "group": "spark",
  25.       "properties": {
  26.         "spark.cores.max": "",
  27.         "spark.executor.memory": "1g",
  28.       },
  29.       "interpreterGroup": [
  30.         {
  31.           "class": "org.apache.zeppelin.spark.SparkInterpreter",
  32.           "name": "spark"
  33.         },
  34.         {
  35.           "class": "org.apache.zeppelin.spark.SparkSqlInterpreter",
  36.           "name": "sql"
  37.         }
  38.       ],
  39.       "dependencies": [
  40.         {
  41.           "groupArtifactVersion": "com.databricks:spark-csv_2.10:1.3.0"
  42.         }
  43.       ]
  44.     }
  45.   ]
  46. }

|

通过设置 ID 获取注册的解释器设置

| 描述 | 该 GET 方法在服务器上返回已注册的解释器设置 | | URL | http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[setting ID] | | 成功代码 | 200 | | 失败代码 | 400 如果这样的解释器设置 id 不存在500 任何其他错误 | | JSON 响应示例 | 

  1. {
  2.   "status": "OK",
  3.   "message": "",
  4.   "body": {
  5.     "id": "2AYW25ANY",
  6.     "name": "Markdown setting name",
  7.     "group": "md",
  8.     "properties": {
  9.       "propname": "propvalue"
  10.     },
  11.     "interpreterGroup": [
  12.       {
  13.         "class": "org.apache.zeppelin.markdown.Markdown",
  14.         "name": "md"
  15.       }
  16.     ],
  17.     "dependencies": [
  18.       {
  19.         "groupArtifactVersion": "groupId:artifactId:version",
  20.         "exclusions": [
  21.           "groupId:artifactId"
  22.         ]
  23.       }
  24.     ]
  25.   }
  26. }

|

创建一个新的解释器设置

| 描述 | 此 POST 方法使用注册的解释器将新的解释器设置添加到服务器。 | | URL | http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting | | 成功代码 | 201 | | 失败代码 | 400 如果输入 JSON 为空500 则为其他任何错误 | | 示例 JSON 输入 | 

  1. {
  2.   "name": "Markdown setting name",
  3.   "group": "md",
  4.   "properties": {
  5.     "propname": "propvalue"
  6.   },
  7.   "interpreterGroup": [
  8.     {
  9.       "class": "org.apache.zeppelin.markdown.Markdown",
  10.       "name": "md"
  11.     }
  12.   ],
  13.   "dependencies": [
  14.     {
  15.       "groupArtifactVersion": "groupId:artifactId:version",
  16.       "exclusions": [
  17.         "groupId:artifactId"
  18.       ]
  19.     }
  20.   ]
  21. }

| | 示例 JSON 响应 | 

  1. {
  2.   "status": "CREATED",
  3.   "message": "",
  4.   "body": {
  5.     "id": "2AYW25ANY",
  6.     "name": "Markdown setting name",
  7.     "group": "md",
  8.     "properties": {
  9.       "propname": "propvalue"
  10.     },
  11.     "interpreterGroup": [
  12.       {
  13.         "class": "org.apache.zeppelin.markdown.Markdown",
  14.         "name": "md"
  15.       }
  16.     ],
  17.     "dependencies": [
  18.       {
  19.         "groupArtifactVersion": "groupId:artifactId:version",
  20.         "exclusions": [
  21.           "groupId:artifactId"
  22.         ]
  23.       }
  24.     ]
  25.   }
  26. }

|

更新解释器设置

| 描述 | 此 PUT 方法使用新属性更新解释器设置 | | URL | http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[interpreter ID] | | 成功代码 | 200 | | 失败代码 | 500 | | 示例 JSON 输入 | 

  1. {
  2.   "name": "Markdown setting name",
  3.   "group": "md",
  4.   "properties": {
  5.     "propname": "Otherpropvalue"
  6.   },
  7.   "interpreterGroup": [
  8.     {
  9.       "class": "org.apache.zeppelin.markdown.Markdown",
  10.       "name": "md"
  11.     }
  12.   ],
  13.   "dependencies": [
  14.     {
  15.       "groupArtifactVersion": "groupId:artifactId:version",
  16.       "exclusions": [
  17.         "groupId:artifactId"
  18.       ]
  19.     }
  20.   ]
  21. }

| | 示例 JSON 响应 | 

  1. {
  2.   "status": "OK",
  3.   "message": "",
  4.   "body": {
  5.     "id": "2AYW25ANY",
  6.     "name": "Markdown setting name",
  7.     "group": "md",
  8.     "properties": {
  9.       "propname": "Otherpropvalue"
  10.     },
  11.     "interpreterGroup": [
  12.       {
  13.         "class": "org.apache.zeppelin.markdown.Markdown",
  14.         "name": "md"
  15.       }
  16.     ],
  17.     "dependencies": [
  18.       {
  19.         "groupArtifactVersion": "groupId:artifactId:version",
  20.         "exclusions": [
  21.           "groupId:artifactId"
  22.         ]
  23.       }
  24.     ]
  25.   }
  26. }

|

删除解释器设置

| 描述 | 此 DELETE 方法删除给定的解释器设置 | | URL | http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[interpreter ID] | | 成功代码 | 200 | | 失败代码 | 500 | | 示例 JSON 响应 | {“status”:”OK”} |

重新启动解释器

| 描述 | 此 PUT 方法重新启动给定的解释器标识。 | | URL | http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/restart/[interpreter ID] | | 成功代码 | 200 | | 失败代码 | 500 | | JSON 输入示例（可选） | 

  1. { 
  2.   “noteId”：“2AVQJVC8N” 
  3. }

| | 示例 JSON 响应 | {“status”:”OK”} |

添加用于依赖关系解析的新存储库

| 描述 | 此 POST 方法添加新的存储库。 | | URL | http://[zeppelin-server]:[zeppelin-port]/api/interpreter/repository | | 成功代码 | 201 | | 失败代码 | 500 | | 示例 JSON 输入 | 

  1. {
  2.   "id": "securecentral",
  3.   "url": "https://repo1.maven.org/maven2",
  4.   "snapshot": false
  5. }

| | 示例 JSON 响应 | {“status”:”OK”} |

删除依赖关系解析的存储库

| 描述 | 此 DELETE 方法删除具有给定 ID 的存储库。 | | URL | http://[zeppelin-server]:[zeppelin-port]/api/interpreter/repository/[repository ID] | | 成功代码 | 200 | | 失败代码 | 500 |