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. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Permission Management
|
API |
Title |
Description |
| AddMembers | AddMembers | Adds a Resource Access Management (RAM) user or a RAM role to a workspace as a member. |
| ListMembers | ListMembers | Retrieves the list of members in the workspace. |
| GrantRoleToUsers | GrantRoleToUsers | Assigns a specified role to users. |
Session Management
|
API |
Title |
Description |
| GetSessionCluster | GetSessionCluster | Retrieves session details. |
| CreateSessionCluster | CreateSessionCluster | Creates a session cluster. |
| StartSessionCluster | StartSessionCluster | Starts a session cluster. |
| ListSessionClusters | ListSessionClusters | Retrieves a list of session clusters. |
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 | Obtains an authentication token for Kyuubi Gateway. |
| 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 | |
| ListLivyComputeSessions | ListLivyComputeSessions | Lists the historical sessions for a 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. |
| GetSqlStatement | GetSqlStatement | Retrieves the details of an SQL query. |
| ListSqlStatementContents | ListSqlStatementContents | Retrieves the execution results of an SQL statement. |
Workspace Management
|
API |
Title |
Description |
| ListWorkspaceQueues | ListWorkspaceQueues | Lists the queues in a workspace. |
| EditWorkspaceQueue | EditWorkspaceQueue | Updates a Workspace Queue. |
Spark version management
|
API |
Title |
Description |
| ListReleaseVersions | ListReleaseVersions | Retrieves a list of release versions. |
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 | Get the details of a job. |
| StartJobRun | StartJobRun | Starts a Spark Job. |
| GetRunConfiguration | GetRunConfiguration | Retrieves the configuration of 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. |
Cluster Management
|
API |
Title |
Description |
| Ray clusters | Ray clusters | |
| UpdateRayCluster | UpdateRayCluster | Updates a Ray cluster. |
| GetRayCluster | GetRayCluster | Retrieves the details of a Ray cluster, including its configuration, runtime state, node information, and connection endpoints. |
| ListRayCluster | ListRayCluster | Lists Ray clusters. |
| StopRayCluster | StopRayCluster | Stops a Ray cluster. |
| StartRayCluster | StartRayCluster | Starts a Ray cluster. |
| DeleteRayCluster | DeleteRayCluster | Deletes a Ray cluster. |
| CreateRayCluster | CreateRayCluster | Creates a Ray cluster. |
Network connection
|
API |
Title |
Description |
| ListNetworkServices | ListNetworkServices | Lists network connections. |
| CreateNetworkService | CreateNetworkService | Creates a network service. |
Other
|
API |
Title |
Description |
| ListCatalogs | ListCatalogs | View the list of data catalogs |
| ListExecutorLogs | ListExecutorLogs | Lists the log files for a job executor. |
| ActivateAICenter | ActivateAICenter | Activates the AI center. |
| ChangeResourceGroup | ChangeResourceGroup | Moves an instance to a different resource group. |
| CreateWorkspace | CreateWorkspace | Creates a workspace. |
| GetAICenterState | GetAICenterState | Gets the state of an AI center. |
| GetTemplate | GetTemplate | Retrieves a task template. |
| ListTemplate | ListTemplate | Lists job templates. |
| ListWorkspaces | ListWorkspaces | Call `ListWorkspaces` to get a list of workspaces. |
| UpdateWorkspace | UpdateWorkspace | Update workspace properties |
Others
|
API |
Title |
Description |
| CancelJobRun | CancelJobRun | Terminates a Spark job. |
| GetCuHours | GetCuHours | Queries the number of CU-hours consumed by a queue during a specified cycle. |
| StopSessionCluster | StopSessionCluster | Stops a session. |
该文章对您有帮助吗？