GetLivyCompute - E-MapReduce - Alibaba Cloud Documentation Center

Retrieves the Livy Gateway information.

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

Request syntax

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

Path 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

Request parameters

Parameter	Type	Required	Description	Example
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 return code of the request. The value 1000000 indicates that the request succeeded. Other values indicate that the request failed. For details about the error, see the message field.	1000000
message	string	The error message.	ok
data	object	The returned result.
computeId	string	The ID of the Livy Gateway.	lc-xxxxxxxxxxxxx
name	string	The name.	test
livyVersion	string	The Livy version. Valid values: 0.8.0 : Livy 0.8.0	0.8.0
releaseVersion	string	The Spark DPI engine version number. This field 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 2 4	1
memoryLimit	string	The memory size of the Livy Server. Valid values: 4Gi 8Gi 16Gi	4Gi
autoStopConfiguration	object	The auto-stop configuration.
enable	boolean	Specifies whether to automatically start after creation. Valid values: true: Yes. false: No.	false
idleTimeoutMinutes	integer	The number of idle minutes after which the Livy Gateway automatically stops.	300
authType	string	The authentication method. Valid values: Token : Token authentication.	Token
status	string	The running status. Valid values: STARTING : Starting. FAILED : Failed. RUNNING : Running. STOPPED : Stopped. STOPPING : Stopping.	RUNNING
endpoint	string	The public network connection address.	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 Spark DPI engine version number.	esr-4.3.0 (Spark 3.5.2, Scala 2.12)
fusion	boolean	Specifies whether the fusion feature is enabled.	false
startTime	integer	The start time. The value is a UNIX timestamp in milliseconds.	1749456094000
gmtCreate	integer	The creation time.	1749456094000
environmentId	string	The runtime environment ID.	ev-cq31c7tlhtgm9nrrlj4g
endpointInner	string	The internal network connection address.	emr-spark-livy-gateway-cn-hangzhou-internal.aliyun.com/api/v1/workspace/w-xxxxxxxxx/livycompute/lc-xxxxxxxxxxx
networkName	string	The network connectivity name.	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 network address 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.