CreateLivyCompute - E-MapReduce - Alibaba Cloud Documentation Center

Creates a Livy compute.

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:CreateLivyCompute

create

*All Resource

*

None

Request syntax

PUT /api/interactive/v1/workspace/{workspaceBizId}/livycompute HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
workspaceBizId	string	No	The workspace ID.	w-8adde60aa809701f

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
name	string	No	The name of the Livy Gateway.	testGateway
livyVersion	string	No	The Livy version.	0.8.0
releaseVersion	string	No	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	No	The name of the submission queue.	root_queue
cpuLimit	string	No	The number of CPU cores for the Livy server. Valid values: 1 : 1 2 : 2 4 : 4	1
memoryLimit	string	No	The memory size of the Livy server. Valid values: 16Gi : 16 Gi 4Gi : 4 Gi 8Gi : 8 Gi	4Gi
autoStartConfiguration	object	No	The automatic startup configuration.
enable	boolean	No	Specifies whether to automatically start the Livy Gateway after it is created. true: Yes. false: No.	false
autoStopConfiguration	object	No	The automatic stop configuration.
enable	boolean	No	Specifies whether to automatically stop the Livy Gateway. true: Yes. false: No.	false
idleTimeoutMinutes	integer	No	The number of minutes after which the Livy Gateway is automatically stopped if it is idle.	300
authType	string	No	The authentication method.	Token
displayReleaseVersion	string	No	The version number of the Spark engine.	esr-4.3.0 (Spark 3.5.2, Scala 2.12)
fusion	boolean	No	Specifies whether to enable acceleration with the Fusion engine.	false
environmentId	string	No	The ID of the runtime environment.	ev-ctfq0fem1hkhgv4hapng
networkName	string	No	The name of the network connection.	test
livyServerConf	string	No	The configuration of the Livy Gateway. This parameter is in JSON format and supports the following files: 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	No	Specifies whether to enable the public endpoint.	true
regionId	string	No	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response body.
requestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944****
code	string	The status code of the request. A value of 1000000 indicates that the request was successful. Other values indicate that the request failed. For more information, see the message parameter.	1000000
message	string	The error message.	ok
data	object	The returned data.
livyComputeId	string	The ID of the Livy Gateway.	lc-i8xogcdfa4fk3yn1

Examples

Success response

JSON format

{
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "code": "1000000",
  "message": "ok",
  "data": {
    "livyComputeId": "lc-i8xogcdfa4fk3yn1"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.