Elgato_dark/zeppelin
1
0
Fork 0
mirror of https://github.com/apache/zeppelin synced 2026-05-24 09:38:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
zeppelin/docs/rest-api/rest-interpreter.md
1ambda e33be25256 [ZEPPELIN-1684] Add GET /interpreter/setting/id REST API 
### What is this PR for?

Due to the lack of this missing API, some front-end code retrieve all settings. This is inefficient.
We can modify those codes by adding this API.

Also, i refactored the whole `InterpreterRestApiTest`

### What type of PR is it?
[Feature | Documentation | Refactoring]

### What is the Jira issue?
[ZEPPELIN-1684](https://issues.apache.org/jira/browse/ZEPPELIN-1684)

### How should this be tested?

You can run unit test `InterpreterRestApiTest`

### Screenshots (if appropriate)

Updated doc screenshots

<img width="900" alt="new_api_doc" src="https://cloud.githubusercontent.com/assets/4968473/20423419/74eeb2a0-adb3-11e6-9a69-58e33457d514.png">

### Questions:
* Does the licenses files need update? - NO
* Is there breaking changes for older versions? - NO
* Does this needs documentation? - YES, but done.

Author: 1ambda <1amb4a@gmail.com>

Closes #1655 from 1ambda/feat/create-interpreter-get-api and squashes the following commits:

89ff7fd [1ambda] style: Apply zeppelin checkstyle xml
c901287 [1ambda] docs: Add new api to rest-interpreter.html
2641a73 [1ambda] refactor: InterpreterRestApiTest
e63c80e [1ambda] refactor: testSettingsCRUD
9bc24fd [1ambda] feat: Add /interpreter/setting/id API and test
2016-11-20 08:02:12 -08:00

12 KiB
Raw Blame History

layout title description group
page Apache Zeppelin Interpreter REST API This page contains Apache Zeppelin Interpreter REST API information. rest-api

{% include JB/setup %}

Apache Zeppelin Interpreter REST API

Overview

Apache Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality. All REST APIs are available starting with the following endpoint http://[zeppelin-server]:[zeppelin-port]/api. Note that Apache Zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewers such as JSONView.

If you work with Apache Zeppelin and find a need for an additional REST API, please file an issue or send us an email.

Interpreter REST API List

The role of registered interpreters, settings and interpreters group are described in here.

List of registered interpreters

Description This ```GET``` method returns all the registered interpreters available on the server.
URL ```http://[zeppelin-server]:[zeppelin-port]/api/interpreter```
Success code 200
Fail code 500
Sample JSON response 
{
  "status": "OK",
  "message": "",
  "body": {
    "md.md": {
      "name": "md",
      "group": "md",
      "className": "org.apache.zeppelin.markdown.Markdown",
      "properties": {},
      "path": "/zeppelin/interpreter/md"
    },
    "spark.spark": {
      "name": "spark",
      "group": "spark",
      "className": "org.apache.zeppelin.spark.SparkInterpreter",
      "properties": {
        "spark.executor.memory": {
          "defaultValue": "1g",
          "description": "Executor memory per worker instance. ex) 512m, 32g"
        },
        "spark.cores.max": {
          "defaultValue": "",
          "description": "Total number of cores to use. Empty value uses all available core."
        },
      },
      "path": "/zeppelin/interpreter/spark"
    },
    "spark.sql": {
      "name": "sql",
      "group": "spark",
      "className": "org.apache.zeppelin.spark.SparkSqlInterpreter",
      "properties": {
        "zeppelin.spark.maxResult": {
          "defaultValue": "1000",
          "description": "Max number of Spark SQL result to display."
        }
      },
      "path": "/zeppelin/interpreter/spark"
    }
  }
}

### List of registered interpreter settings
Description This ```GET``` method returns all the interpreters settings registered on the server.
URL ```http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting```
Success code 200
Fail code 500
Sample JSON response 
{
  "status": "OK",
  "message": "",
  "body": [
    {
      "id": "2AYUGP2D5",
      "name": "md",
      "group": "md",
      "properties": {
        "_empty_": ""
      },
      "interpreterGroup": [
        {
          "class": "org.apache.zeppelin.markdown.Markdown",
          "name": "md"
        }
      ],
      "dependencies": []
    },  
    {
      "id": "2AY6GV7Q3",
      "name": "spark",
      "group": "spark",
      "properties": {
        "spark.cores.max": "",
        "spark.executor.memory": "1g",
      },
      "interpreterGroup": [
        {
          "class": "org.apache.zeppelin.spark.SparkInterpreter",
          "name": "spark"
        },
        {
          "class": "org.apache.zeppelin.spark.SparkSqlInterpreter",
          "name": "sql"
        }
      ],
      "dependencies": [
        {
          "groupArtifactVersion": "com.databricks:spark-csv_2.10:1.3.0"
        }
      ]
    }
  ]
}

### Get a registered interpreter setting by the setting id
Description This ```GET``` method returns a registered interpreter setting on the server.
URL ```http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[setting ID]```
Success code 200
Fail code 400 if such interpreter setting id does not exist
500 for any other errors
Sample JSON response 
{
  "status": "OK",
  "message": "",
  "body": {
    "id": "2AYW25ANY",
    "name": "Markdown setting name",
    "group": "md",
    "properties": {
      "propname": "propvalue"
    },
    "interpreterGroup": [
      {
        "class": "org.apache.zeppelin.markdown.Markdown",
        "name": "md"
      }
    ],
    "dependencies": [
      {
        "groupArtifactVersion": "groupId:artifactId:version",
        "exclusions": [
          "groupId:artifactId"
        ]
      }
    ]
  }
}

### Create a new interpreter setting
Description This ```POST``` method adds a new interpreter setting using a registered interpreter to the server.
URL ```http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting```
Success code 201
Fail code 400 if the input json is empty
500 for any other errors
Sample JSON input 
{
  "name": "Markdown setting name",
  "group": "md",
  "properties": {
    "propname": "propvalue"
  },
  "interpreterGroup": [
    {
      "class": "org.apache.zeppelin.markdown.Markdown",
      "name": "md"
    }
  ],
  "dependencies": [
    {
      "groupArtifactVersion": "groupId:artifactId:version",
      "exclusions": [
        "groupId:artifactId"
      ]
    }
  ]
}
Sample JSON response 
{
  "status": "CREATED",
  "message": "",
  "body": {
    "id": "2AYW25ANY",
    "name": "Markdown setting name",
    "group": "md",
    "properties": {
      "propname": "propvalue"
    },
    "interpreterGroup": [
      {
        "class": "org.apache.zeppelin.markdown.Markdown",
        "name": "md"
      }
    ],
    "dependencies": [
      {
        "groupArtifactVersion": "groupId:artifactId:version",
        "exclusions": [
          "groupId:artifactId"
        ]
      }
    ]
  }
}

### Update an interpreter setting
Description This ```PUT``` method updates an interpreter setting with new properties.
URL ```http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[interpreter ID]```
Success code 200
Fail code 500
Sample JSON input 
{
  "name": "Markdown setting name",
  "group": "md",
  "properties": {
    "propname": "Otherpropvalue"
  },
  "interpreterGroup": [
    {
      "class": "org.apache.zeppelin.markdown.Markdown",
      "name": "md"
    }
  ],
  "dependencies": [
    {
      "groupArtifactVersion": "groupId:artifactId:version",
      "exclusions": [
        "groupId:artifactId"
      ]
    }
  ]
}
Sample JSON response 
{
  "status": "OK",
  "message": "",
  "body": {
    "id": "2AYW25ANY",
    "name": "Markdown setting name",
    "group": "md",
    "properties": {
      "propname": "Otherpropvalue"
    },
    "interpreterGroup": [
      {
        "class": "org.apache.zeppelin.markdown.Markdown",
        "name": "md"
      }
    ],
    "dependencies": [
      {
        "groupArtifactVersion": "groupId:artifactId:version",
        "exclusions": [
          "groupId:artifactId"
        ]
      }
    ]
  }
}

### Delete an interpreter setting
Description This ```DELETE``` method deletes an given interpreter setting.
URL ```http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[interpreter ID]```
Success code 200
Fail code 500
Sample JSON response {"status":"OK"}

### Restart an interpreter
Description This ```PUT``` method restarts the given interpreter id.
URL ```http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/restart/[interpreter ID]```
Success code 200
Fail code 500
Sample JSON input (Optional) 
{
  "noteId": "2AVQJVC8N"
}
Sample JSON response {"status":"OK"}

### Add a new repository for dependency resolving
Description This ```POST``` method adds new repository.
URL ```http://[zeppelin-server]:[zeppelin-port]/api/interpreter/repository```
Success code 201
Fail code 500
Sample JSON input 
{
  "id": "securecentral",
  "url": "https://repo1.maven.org/maven2",
  "snapshot": false
}
Sample JSON response {"status":"OK"}

### Delete a repository for dependency resolving
Description This ```DELETE``` method delete repository with given id.
URL ```http://[zeppelin-server]:[zeppelin-port]/api/interpreter/repository/[repository ID]```
Success code 200
Fail code 500