Call ListKyuubiSparkApplications API on EMR Serverless Spark - EMR Serverless Spark - Alibaba Cloud - E-MapReduce

Queries the Spark applications submitted by Kyuubi.

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

none

*All Resource

*

None

Request syntax

GET /api/v1/kyuubi/{workspaceId}/{kyuubiServiceId}/applications HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
workspaceId	string	No	The workspace ID.	w-d2d82aa09155****
kyuubiServiceId	string	No	The Kyuubi service ID.	kb-c7141f10c3f549fc9f8b8ae562b8****

Request parameters

Parameter	Type	Required	Description	Example
nextToken	string	No	The token for the next page.	1
maxResults	integer	No	The maximum number of records to retrieve at a time.	20
applicationId	string	No	The ID of the Spark application submitted by Kyuubi, used for search.	spark-339f844005b6404c95f9f7c7a13b****
applicationName	string	No	The name of the Spark application submitted by Kyuubi, used for search.	kyuubi-connection-spark-sql-anonymous-fa9a5e73-b4b1-474a-b****
startTime	object	No	The start time range of the task.
startTime	integer	No	The start point of the task start time range. The value is a UNIX timestamp in milliseconds.	1709740800000
endTime	integer	No	The end point of the task start time range. The value is a UNIX timestamp in milliseconds.	1710432000000
resourceQueueId	string	No	The resource queue ID used to filter Spark applications.	root_queue
minDuration	integer	No	The minimum execution duration of the application, in milliseconds.	60000
orderBy	array	No	The list of sort fields.
	string	No	The sort field.	startTime
sort	string	No	The sort order. A value of asc indicates ascending order, and desc indicates descending order.	asc
endTime	object	No	The end time range of the task.
startTime	integer	No	The start point of the task end time range. The value is a UNIX timestamp in seconds.	1774209636
endTime	integer	No	The end point of the task end time range. The value is a UNIX timestamp in seconds.	1774209636
states	string	No	The list of Spark application states used for filtering.	["ERROR"]
latestSqlStatementStatuses	string	No	The list of statuses of the latest SQL statement used for filtering.	["SUCCESS"]

Response elements

Element	Type	Description	Example
	object	The response structure.
applications	array<object>	The list of application details.
	object	The application details.
applicationId	string	The ID of the Spark application submitted by Kyuubi.	spark-339f844005b6404c95f9f7c7a13b****
applicationName	string	The name of the Spark application submitted by Kyuubi.	kyuubi-connection-spark-sql-anonymous-fa9a5e73-b4b1-474a-b****
webUI	string	The URL of the Spark application UI.	https://emr-spark-ui-cn-hangzhou.data.aliyun.com/history/w-cf351f3b6dcb**-spark-339f844005b6404c95f9f7c7a13b/jobs/?spm=emr-serverless-spark.gateway_sessions.0.0.711344e3QfMVTz&token=NS9CU1lpWGl1Q2RRdi9sZUtuS3hy**
state	string	The state of the Spark application. Valid values: STARTING: The application is starting. RUNNING: The application is running. TERMINATED: The application is terminated.	STARTING
startTime	string	The start time of the task. The format is YYYY-MM-DD HH:mm:ss.	2025-02-12 19:59:16
endTime	string	The end time of the task. The format is YYYY-MM-DD HH:mm:ss.	2025-02-12 20:02:02
cuHours	number	The number of compute units (CUs) consumed during the task execution. This value is an estimate. The actual value is subject to the bill.	0.238302
mbSeconds	integer	The total memory allocated to the task multiplied by the task execution duration in seconds.	3513900
vcoreSeconds	integer	The total number of vcores allocated to the task multiplied by the task execution duration in seconds.	780
resourceQueueId	string	The name of the resource queue in which the Spark task runs.	dev_queue
exitReason	string	The exit reason of the application.	Exit Code: 137, Exit Reason: OOMKilled
latestSqlStatementStatus	string	The execution status of the latest SQL statement in the application.	SUCCESS
runLog	RunLog	The application log.	{"driverStdOut":"oss://bucket/path/to/stdout","driverStdError":"oss://bucket/path/to/stderr","driverSyslog":"oss://bucket/path/to/syslog","driverStartup":"oss://bucket/path/to/startup"}
kyuubiServiceId	string	The ID of the Kyuubi service that submitted the Spark application.	kb-2b93ec*******c9440c
tags	array	The list of tags for the Spark application.
	Tag	The tag.
priority	string	The priority of the Spark application.	5
requestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944****
nextToken	string	The token for the next page.	1
maxResults	integer	The maximum number of records to retrieve at a time.	20
totalCount	integer	The total number of records.	200

Examples

Success response

JSON format

{
  "applications": [
    {
      "applicationId": "spark-339f844005b6404c95f9f7c7a13b****",
      "applicationName": "kyuubi-connection-spark-sql-anonymous-fa9a5e73-b4b1-474a-b****",
      "webUI": "https://emr-spark-ui-cn-hangzhou.data.aliyun.com/history/w-cf351f3b6dcb****-spark-339f844005b6404c95f9f7c7a13b****/jobs/?spm=emr-serverless-spark.gateway_sessions.0.0.711344e3QfMVTz&token=NS9CU1lpWGl1Q2RRdi9sZUtuS3hy****",
      "state": "STARTING",
      "startTime": "2025-02-12 19:59:16",
      "endTime": "2025-02-12 20:02:02",
      "cuHours": 0.238302,
      "mbSeconds": 3513900,
      "vcoreSeconds": 780,
      "resourceQueueId": "dev_queue",
      "exitReason": "Exit Code: 137, Exit Reason: OOMKilled",
      "latestSqlStatementStatus": "SUCCESS",
      "runLog": {
        "driverStdOut": "oss://bucket/path/to/stdout",
        "driverStdError": "oss://bucket/path/to/stderr",
        "driverSyslog": "oss://bucket/path/to/syslog",
        "driverStartup": "oss://bucket/path/to/startup"
      },
      "kyuubiServiceId": "kb-2b93ec*******c9440c",
      "tags": [
        {
          "key": "workflowId",
          "value": "wf-123test"
        }
      ],
      "priority": "5"
    }
  ],
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "nextToken": "1",
  "maxResults": 20,
  "totalCount": 200
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.