Apache Livy · Schema

Session

An interactive Spark session

Big DataInteractive ComputingOpen SourceRESTSpark

Properties

Name	Type	Description
id	integer	Session identifier
appId	string	Spark application ID
owner	string	Session owner
proxyUser	string	Proxy user for the session
kind	string	Session type
log	array	Recent log lines
state	string	Session state
appInfo	object	Spark application information

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-livy/refs/heads/main/json-schema/rest-api-session-schema.json",
  "title": "Session",
  "description": "An interactive Spark session",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Session identifier",
      "example": 0
    },
    "appId": {
      "type": "string",
      "description": "Spark application ID",
      "example": "application_1234567890_0001"
    },
    "owner": {
      "type": "string",
      "description": "Session owner",
      "example": "hdfs"
    },
    "proxyUser": {
      "type": "string",
      "description": "Proxy user for the session",
      "example": "alice"
    },
    "kind": {
      "type": "string",
      "description": "Session type",
      "enum": [
        "spark",
        "pyspark",
        "sparkr",
        "sql"
      ],
      "example": "pyspark"
    },
    "log": {
      "type": "array",
      "description": "Recent log lines",
      "items": {
        "type": "string"
      }
    },
    "state": {
      "type": "string",
      "description": "Session state",
      "enum": [
        "not_started",
        "starting",
        "idle",
        "busy",
        "shutting_down",
        "error",
        "dead",
        "killed",
        "success"
      ],
      "example": "idle"
    },
    "appInfo": {
      "type": "object",
      "description": "Spark application information"
    }
  }
}