API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (emr-serverless-spark/2023-08-08) follows the ROA standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
Permission Management
|
API |
Title |
Description |
| ListMembers | ListMembers | Retrieves the list of members in the workspace. |
| GrantRoleToUsers | GrantRoleToUsers | Assigns a specified role to users. |
Session Management
|
API |
Title |
Description |
| CreateSessionCluster | CreateSessionCluster | Creates a session cluster. |
| StartSessionCluster | StartSessionCluster | Starts a session cluster. |
| ListSessionClusters | ListSessionClusters | Queries the list of sessions. |
Gateway
|
API |
Title |
Description |
| Kyuubi Gateway | Kyuubi Gateway | |
| ListKyuubiSparkApplications | ListKyuubiSparkApplications | Lists Kyuubi Spark applications. |
| CancelKyuubiSparkApplication | CancelKyuubiSparkApplication | Cancels a Kyuubi Spark application. |
| DeleteKyuubiToken | DeleteKyuubiToken | Deletes a Kyuubi Gateway authentication token. |
| UpdateKyuubiToken | UpdateKyuubiToken | Updates a Kyuubi Gateway authentication token. |
| GetKyuubiToken | GetKyuubiToken | Retrieves a Kyuubi Gateway authentication token. |
| CreateKyuubiToken | CreateKyuubiToken | Creates a Kyuubi Gateway authentication token. |
| ListKyuubiToken | ListKyuubiToken | Lists KyuubiServer authentication tokens. |
| ListKyuubiServices | ListKyuubiServices | Lists Kyuubi Gateways. |
| CreateKyuubiService | CreateKyuubiService | Creates a Kyuubi gateway. |
| GetKyuubiService | GetKyuubiService | Retrieves the details of a Kyuubi Gateway. |
| UpdateKyuubiService | UpdateKyuubiService | Updates a Kyuubi Gateway. |
| DeleteKyuubiService | DeleteKyuubiService | Deletes a Kyuubi gateway. |
| StartKyuubiService | StartKyuubiService | Starts the Kyuubi Gateway. |
| StopKyuubiService | StopKyuubiService | Stops a Kyuubi Gateway. |
| Livy Gateway | Livy Gateway | |
| DeleteLivyCompute | DeleteLivyCompute | Deletes a Livy gateway. |
| CreateLivyCompute | CreateLivyCompute | Creates a Livy compute. |
| UpdateLivyCompute | UpdateLivyCompute | Updates a Livy Gateway. |
| ListLivyCompute | ListLivyCompute | Lists Livy Gateways. |
| StartLivyCompute | StartLivyCompute | Starts a Livy gateway. |
| RefreshLivyComputeToken | RefreshLivyComputeToken | Refreshes the token for a Livy Gateway. |
| GetLivyComputeToken | GetLivyComputeToken | Retrieves a token for a Livy Gateway. |
| CreateLivyComputeToken | CreateLivyComputeToken | Creates a token for a Livy Gateway. |
| DeleteLivyComputeToken | DeleteLivyComputeToken | Deletes a token for a Livy Gateway. |
| StopLivyCompute | StopLivyCompute | Stops a Livy Gateway. |
| ListLivyComputeToken | ListLivyComputeToken | Lists Livy Gateway tokens. |
| GetLivyCompute | GetLivyCompute | Retrieves information about a Livy Gateway. |
SQL Compute Management
|
API |
Title |
Description |
| TerminateSqlStatement | TerminateSqlStatement | Terminates an SQL query task. |
| CreateSqlStatement | CreateSqlStatement | Creates an SQL statement. |
| ListSqlStatementContents | ListSqlStatementContents | Retrieves the execution results of an SQL statement. |
Workspace Management
|
API |
Title |
Description |
| CreateWorkspace | CreateWorkspace | Creates a workspace. |
| ListWorkspaces | ListWorkspaces | Retrieves a list of workspaces. |
| ListWorkspaceQueues | ListWorkspaceQueues | Lists the queues in a workspace. |
| EditWorkspaceQueue | EditWorkspaceQueue | Edits a workspace queue. |
Spark Task Management
|
API |
Title |
Description |
| ListJobExecutors | ListJobExecutors | Lists the executors of a job. |
| ListLogContents | Query Log Content | Get Log Content |
| GetDoctorApplication | GetDoctorApplication | Obtains job analysis information on E-MapReduce (EMR) Doctor. |
| ListJobRuns | ListJobRuns | Call the ListJobRuns operation to retrieve a list of Spark jobs. |
| GetJobRun | GetJobRun | Retrieves the details of a job. |
| StartJobRun | StartJobRun | Starts a Spark Job. |
Task orchestration
|
API |
Title |
Description |
| StartProcessInstance | StartProcessInstance | Starts a workflow manually. |
| UpdateProcessDefinitionWithSchedule | UpdateProcessDefinitionWithSchedule | Updates a workflow definition and its timed scheduling. |
| CreateProcessDefinitionWithSchedule | CreateProcessDefinitionWithSchedule | Creates a workflow definition. |
| GenerateTaskCodes | GenerateTaskCodes | Publishes a workflow and its scheduling configuration. |
Other
|
API |
Title |
Description |
| ListCatalogs | ListCatalogs | Returns a list of data catalogs. |
| ListTemplate | ListTemplate | Lists job templates. |
Others
|
API |
Title |
Description |
| AddMembers | AddMembers | Adds a RAM user or RAM role to a workspace as a member. |
| CancelJobRun | CancelJobRun | Terminates a Spark job. |
| GetCuHours | GetCuHours | Queries the number of CU-hours consumed by a queue during a specified cycle. |
| GetSessionCluster | GetSessionCluster | Queries the information about a session. |
| GetSqlStatement | GetSqlStatement | Queries the status of an SQL query task. |
| GetTemplate | GetTemplate | Queries task templates. |
| ListReleaseVersions | ListReleaseVersions | Queries the list of published versions of E-MapReduce (EMR) Serverless Spark. |
| StopSessionCluster | StopSessionCluster | Stops a session. |