ListLivyCompute - E-MapReduce - Alibaba Cloud Documentation Center

Lists Livy Gateways.

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

list

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
workspaceBizId	string	No	The workspace ID.	w-8adde60aa809701f
environmentId	string	No	The environment ID.	ev-cq31c7tlhtgm9nrrlj4g
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 that the request is successful. For other values, see the message parameter for error details.	1000000
message	string	The error message.	ok
data	object	The returned data.
livyComputes	array<object>	A list of Livy Gateways.
	object
computeId	string	The ID of the Livy Gateway.	lc-xxxxxxxxxxxx
name	string	The name.	test
queueName	string	The queue name.	root_queue
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
gmtCreate	integer	The time when the resource was created.	1749456094000
startTime	integer	The time when the resource was started.	1749456094000
endpointInner	string	The internal endpoint.	emr-spark-livy-gateway-cn-hangzhou-internal.aliyun.com/api/v1/workspace/w-xxxxxxxxx/livycompute/lc-xxxxxxxxxxx

Examples

Success response

JSON format

{
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "code": "1000000",
  "message": "ok",
  "data": {
    "livyComputes": [
      {
        "computeId": "lc-xxxxxxxxxxxx",
        "name": "test",
        "queueName": "root_queue",
        "status": "RUNNING",
        "endpoint": "emr-spark-livy-gateway-cn-hangzhou.data.aliyun.com/api/v1/workspace/w-xxxxxxxxx/livycompute/lc-xxxxxxxxxxx",
        "createdBy": "alice",
        "gmtCreate": 1749456094000,
        "startTime": 1749456094000,
        "endpointInner": "emr-spark-livy-gateway-cn-hangzhou-internal.aliyun.com/api/v1/workspace/w-xxxxxxxxx/livycompute/lc-xxxxxxxxxxx"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.