All Products
Search

This Product

    E-MapReduce:GetLivyCompute

    Document Center

    E-MapReduce:GetLivyCompute

    Last Updated:Oct 12, 2025

    Retrieves information about a Livy Gateway.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    emr-serverless-spark:GetLivyCompute

    get

    *All Resource

    *

    None

    None

    Request syntax

    GET /api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId} HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    workspaceBizId

    string

    No

    The workspace ID.

    w-8adde60aa809701f

    livyComputeId

    string

    No

    The ID of the Livy Gateway.

    lc-i8xogcdfa4fk3yn1

    regionId

    string

    No

    The region ID.

    cn-hangzhou

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    requestId

    string

    The request ID.

    DD6B1B2A-5837-5237-ABE4-FF0C8944****

    code

    string

    The response code. A value of 1000000 indicates a successful request. Other values indicate a failed request. Check the message parameter for the error details.

    1000000

    message

    string

    The error message.

    ok

    data

    object

    The returned data.

    computeId

    string

    The ID of the Livy Gateway.

    lc-xxxxxxxxxxxxx

    name

    string

    The name.

    test

    livyVersion

    string

    The Livy version.

    0.8.0

    releaseVersion

    string

    The version number of the Spark engine. This parameter is deprecated. Use displayReleaseVersion instead.

    esr-4.3.0 (Spark 3.5.2, Scala 2.12, Java Runtime)

    queueName

    string

    The queue name.

    root_queue

    cpuLimit

    string

    The number of CPU cores for the Livy server.

    Valid values:

    • 1 :

      1

    • 2 :

      2

    • 4 :

      4

    1

    memoryLimit

    string

    The memory size of the Livy server.

    Valid values:

    • 16Gi :

      16Gi

    • 4Gi :

      4Gi

    • 8Gi :

      8Gi

    4Gi

    autoStopConfiguration

    object

    The auto-stop configuration.

    enable

    boolean

    Indicates whether to automatically start the gateway after it is created.

    • true: Yes.

    • false: No.

    false

    idleTimeoutMinutes

    integer

    The number of minutes after which the Livy Gateway is automatically stopped if it is idle.

    300

    authType

    string

    The authentication method.

    Token

    status

    string

    The running status.

    RUNNING

    endpoint

    string

    The public endpoint.

    emr-spark-livy-gateway-cn-hangzhou.data.aliyun.com/api/v1/workspace/w-xxxxxxxxx/livycompute/lc-xxxxxxxxxxx

    createdBy

    string

    The name of the creator.

    alice

    ramUserId

    string

    The ID of the creator.

    10000001

    displayReleaseVersion

    string

    The version number of the Spark engine.

    esr-4.3.0 (Spark 3.5.2, Scala 2.12)

    fusion

    boolean

    Indicates whether the fusion switch is enabled.

    false

    startTime

    integer

    The start time.

    1749456094000

    gmtCreate

    integer

    The creation time.

    1749456094000

    environmentId

    string

    The ID of the runtime environment.

    ev-cq31c7tlhtgm9nrrlj4g

    endpointInner

    string

    The internal endpoint.

    emr-spark-livy-gateway-cn-hangzhou-internal.aliyun.com/api/v1/workspace/w-xxxxxxxxx/livycompute/lc-xxxxxxxxxxx

    networkName

    string

    The name of the network connection.

    test

    livyServerConf

    string

    The Livy Gateway configuration in JSON format. The following files are supported:

    • sparkDefaultsConf

    • sparkBlackListConf

    • livyConf

    • livyClientConf

    { "sparkDefaultsConf": "spark.driver.cores 1\nspark.driver.memory 4g\nspark.executor.cores 1\nspark.executor.memory 4g\n", "sparkBlackListConf": "spark.driver.cores\nspark.driver.memory", "livyConf": "livy.server.session.timeout 1h\n", "livyClientConf": "livy.rsc.sql.num-rows 1000\n" }

    enablePublic

    boolean

    The status of the public endpoint switch.

    true

    Examples

    Success response

    JSON format

    {
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "code": "1000000",
  "message": "ok",
  "data": {
    "computeId": "lc-xxxxxxxxxxxxx",
    "name": "test",
    "livyVersion": "0.8.0",
    "releaseVersion": "esr-4.3.0 (Spark 3.5.2, Scala 2.12, Java Runtime)\n",
    "queueName": "root_queue",
    "cpuLimit": "1",
    "memoryLimit": "4Gi",
    "autoStopConfiguration": {
      "enable": false,
      "idleTimeoutMinutes": 300
    },
    "authType": "Token",
    "status": "RUNNING",
    "endpoint": "emr-spark-livy-gateway-cn-hangzhou.data.aliyun.com/api/v1/workspace/w-xxxxxxxxx/livycompute/lc-xxxxxxxxxxx",
    "createdBy": "alice",
    "ramUserId": "10000001",
    "displayReleaseVersion": "esr-4.3.0 (Spark 3.5.2, Scala 2.12)",
    "fusion": true,
    "startTime": 1749456094000,
    "gmtCreate": 1749456094000,
    "environmentId": "ev-cq31c7tlhtgm9nrrlj4g",
    "endpointInner": "emr-spark-livy-gateway-cn-hangzhou-internal.aliyun.com/api/v1/workspace/w-xxxxxxxxx/livycompute/lc-xxxxxxxxxxx",
    "networkName": "test",
    "livyServerConf": "\t\n{\n  \"sparkDefaultsConf\": \"spark.driver.cores     1\\nspark.driver.memory    4g\\nspark.executor.cores   1\\nspark.executor.memory  4g\\n\",\n  \"sparkBlackListConf\": \"spark.driver.cores\\nspark.driver.memory\",\n  \"livyConf\": \"livy.server.session.timeout  1h\\n\",\n  \"livyClientConf\": \"livy.rsc.sql.num-rows  1000\\n\"\n}",
    "enablePublic": true
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.