API概览

本产品(emr-serverless-spark/2023-08-08)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

权限管理

API

标题

API概述

AddMembers 添加成员 调用AddMembersRAM用户或RAM角色添加到工作空间作为新成员。
ListMembers 获取成员列表 调用ListMembers查看工作空间成员列表。
GrantRoleToUsers 赋予用户角色 调用GrantRoleToUsers为用户授予指定角色权限。

会话管理

API

标题

API概述

GetSessionCluster 获取会话详情 获取会话详情。
CreateSessionCluster 创建会话 创建会话。
StopSessionCluster 终止会话 终止session集群。
StartSessionCluster 启动会话 启动session集群。
ListSessionClusters 获取会话列表 获取会话列表。

Gateway

API

标题

API概述

Kyuubi Gateway Kyuubi Gateway
ListKyuubiSparkApplications 获取Kyuubi提交的Spark应用详情列表 ListKyuubiSparkApplications
DeleteKyuubiToken 删除Kyuubi Gateway认证Token 删除Kyuubi Gateway认证Token。
UpdateKyuubiToken 更新Kyuubi Gateway认证Token 更新Kyuubi Gateway认证Token。
GetKyuubiToken 获取Kyuubi Gateway认证Token 获取Kyuubi Gateway认证Token。
CreateKyuubiToken 创建Kyuubi Gateway认证Token 创建Kyuubi Gateway认证Token。
ListKyuubiServices 列出Kyuubi Gateway信息 列出Kyuubi Gateway。
ListKyuubiToken 列出Kyuubi Gateway认证Token 列出KyuubiServer认证Token。
Livy Gateway Livy Gateway
DeleteLivyCompute 删除Livy Gateway 删除Livy Gateway。
CreateLivyCompute 创建Livy Gateway 创建Livy compute。
UpdateLivyCompute 更新Livy Gateway 更新Livy Gateway。
ListLivyCompute 列出Livy Gateway 列出Livy Gateway。
StartLivyCompute 启动Livy Gateway 启动Livy Gateway。
RefreshLivyComputeToken 更新Livy GatewayToken 更新Livy GatewayToken。
GetLivyComputeToken 获取Livy GatewayToken 获取Livy GatewayToken。
CreateLivyComputeToken 创建Livy GatewayToken 创建Livy GatewayToken。
DeleteLivyComputeToken 删除Livy GatewayToken 删除Livy GatewayToken。
StopLivyCompute 停止Livy Gateway 停止Livy Gateway。
ListLivyComputeToken 列出Livy GatewayToken 列出Livy GatewayToken。
GetLivyCompute 获取Livy Gateway信息 获取Livy Gateway信息。

数据开发

API

标题

API概述

GetTemplate 获取EMR Serverless Spark任务模板信息 获取任务模板。
TerminateSqlStatement 终止SQL查询 终止正在执行的SQL查询。
CreateSqlStatement 创建SQL查询 创建SQL查询。
GetSqlStatement 获取SQL查询详情 获取SQL查询详情。
ListSqlStatementContents 查询SQL会话执行结果 获取sql statement内容。

工作空间管理

API

标题

API概述

CreateWorkspace 创建工作空间 创建工作空间。
ListWorkspaces 获取工作空间列表 调用ListWorkspaces获取工作空间列表。
ListWorkspaceQueues 获取工作空间队列列表 查看工作空间的队列列表。
EditWorkspaceQueue 编辑工作空间队列 编辑工作空间队列。

Spark版本管理

API

标题

API概述

ListReleaseVersions 获取spark版本列表 获取发布版本列表。

Spark任务管理

API

标题

API概述

ListLogContents 查询日志内容 获取日志内容。
GetCuHours 获取工作空间队列CU GetCuHours
GetDoctorApplication 获取作业诊断信息 get doctor application for serverless spark
CancelJobRun 终止Spark任务 调用CancelJobRun终止正在运行的Spark任务。
ListJobRuns 获取Spark任务列表 调用ListJobRuns获取Spark任务列表。
GetJobRun 获取Spark任务详情 调用GetJobRun获取任务详情。
StartJobRun 启动Spark任务 调用StartJobRun启动Spark任务。

任务编排

API

标题

API概述

StartProcessInstance 手动运行工作流 手动运行工作流。
UpdateProcessDefinitionWithSchedule 更新工作流定义和调度 更新工作流定义和定时调度。
CreateProcessDefinitionWithSchedule 创建工作流定义和调度 创建工作流定义。