You need to enable JavaScript to run this app.
文档中心
文档备案控制台
E-MapReduce

E-MapReduce

请输入
  • 文档首页
    • E-MapReduceAPI 参考EMR Serverless API参考Open API
复制全文
下载 pdf
我的收藏
EMR Serverless API参考
Open API
复制全文
下载 pdf
我的收藏
Open API

本文档提供 Serverless Spark 中 资源队列 相关的 OpenAPI。

说明

  • OpenAPI 调用方可参考 API 调用指南
  • API Version 统一为 2024-03-25
  • Service：emr_serverless

资源队列

队列列表

接口描述

获取当前租户下的资源队列列表，支持筛选

请求参数

  • 请求方式： GET
  • Action： ListQueue
  • Params：

参数

类型

是否必须

描述

QueueName

String

N

队列名称；默认为空，即不筛选，返回全部队列

Status

String

N

查询状态；默认为空，即不筛选，返回全部状态的队列
详细的状态对应码请参见 资源队列状态 Status

StartTime

String

N

查询开通时间的左区间，"yyyy-MM-dd"
系统会自动补齐为：yyyy-MM-dd 00:00:00

EndTime

String

N

查询开通时间的右区间，"yyyy-MM-dd"
系统会自动补齐为：yyyy-MM-dd 23:59:59

返回参数

资源队列 Queue

队列详情

接口描述

获取当前租户某个队列的详细信息

请求参数

  • 请求方式： GET
  • Action： GetQueue
  • Params：

参数

类型

是否必须

描述

Id

String

Y

队列id

返回参数

资源队列 Queue

作业管理

提交作业

接口描述

创建并提交作业

请求参数

  • 请求方式： HTTP POST
  • Action: QueryCreateQuery
  • Params:

参数

类型

是否必选

描述

name

String

Y

作业名

query

String

Y

sql编辑器内的内容

conf

String

N

配置参数，json string，如：

{"las.execute.queuename": "公共队列", "serverless.compute.group.name": "Default"}

conf 也可以set在 query中，效果相同。query中set 的参数与conf重复时，query中set的优先级高。

user

String

Y

提交作业的用户名，需与系统账号权限匹配

skipCostAnalysis

Boolean

N

是否跳过成本预估分析，默认false

skipDispatch

Boolean

N

是否跳过任务调度预处理，默认false

priority

Int

N

作业优先级，默认0，越小优先级越高

返回参数

参数

类型

描述

jobId

Int

提交成功后生成的作业 ID，后续查询 / 终止需用到此 ID

{
    "jobId": ${jobId}
}

查询作业

接口描述

根据作业 ID 查询作业信息

请求参数

  • 请求方式： HTTP GET
  • Action: QueryGetJobV2
  • Params:

参数

类型

是否必选

描述

Id

String

Y

作业ID

返回参数

字段名

类型

描述

SqlType

String

任务类型，DDL、DQL、DML

Id

String

作业 ID

Name

String

作业名称

DataleapTaskId

String

关联dataleap任务 ID

DurationStage

Int

运行耗时分组

BoltCuh

Double

消耗的总 Bolt CUH 资源量

Duration

String

运行耗时

SubmitLogEnabled

Boolean

提交日志是否可用

QueueRole

String

队列权限

PrestoScanSize

Int

presto 扫描数据量

Submitter

String

作业提交人

TrackingUrlEnabled

Boolean

UI 是否可用

Origin

String

作业来源，如 Dataleap

QueueName

String

队列名

GroupName

String

计算组名

GroupId

String

计算组 ID

StartTime

String

作业开始时间

SubmitterType

String

提交类型

Runtime

String

runtime 类型，如 java、bolt

Cuh

Double

作业消耗的总 CUH

JobType

String

任务类型

EngineType

String

执行引擎类型（如 Presto、Spark）

Conf

String

作业配置

DriverLogEnabled

Boolean

执行日志是否可用

FinishTime

String

作业结束时间

QueueId

String

队列 ID

Json

String

作业内容

Status

String

作业状态，详细的状态对应码请参见 作业状态 Status

终止作业

接口描述

终止运行中的作业

请求参数

  • 请求方式： HTTP POST
  • Action: QueryCancelQueryV2
  • Params：

参数

类型

是否必选

描述

Id

String

Y

作业ID

返回参数

参数

类型

描述

Success

Boolean

  • 终止作业为异步操作，Success=true仅代表 “指令已接收”，需通过 “查询作业接口” 确认作业最终状态，详细的状态对应码请参见 作业状态 Status。
  • 已执行的 SQL 操作（如 DML 的插入 / 删除）可能部分生效，需自行校验数据一致性。

分批获取数据结果

请求参数

  • 请求方式： HTTP GET
  • Action: QueryFetchResultsByBatch
  • Params：

参数

类型

是否必选

描述

taskId

String

Y

作业 ID

position

String

Y

偏移地址

limit

String

Y

读取记录数

skipLines

String

Y

固定为 0

返回参数

字段名

类型

描述

position

String

偏移地址

isFinished

Boolean

是否结束

rows

int

行数

作业列表

接口描述

获取所有提交过的作业

请求参数

  • 请求方式： HTTP GET
  • Action: ListJobInstances
  • Params：

参数

类型

是否必须

描述

Queue

String

N

按照队列名字筛选，默认为全部

ComputeComponent

String

N

按照队列名字筛选，默认为全部

Status

String

N

按照作业状态筛选，默认为全部；
详细的状态对应码请参见 作业状态 Status

JobType

String

N

按照作业类型筛选，枚举值如下：

  • SQL
  • SparkJar

MatchName

String

N

根据作业名匹配

MatchId

String

N

根据作业id 匹配

Limit

String

N

读取记录数

Offset

String

N

0

返回参数

字段名

类型

描述

Id

String

任务ID

Name

String

任务名

Origin

String

任务来源，如Dataleap

Status

String

任务状态，枚举参见下表

Submitter

String

作业提交人

SqlType

String

作业类型，DDL、DQL、DML

StartTime

String

开始时间

Json

String

作业内容

EngineType

String

引擎类型，Spark、Presto、Ray、Hive、CustomJon

TrackingUrlEnabled

Boolean

UI 是否可用

SubmitLogEnabled

Boolean

提交日志是否可用

DriverLogEnabled

Boolean

执行日志是否可用

Duration

String

运行时长

FinishTime

String

结束时间

QueueRole

String

队列权限

DurationStage

String

运行时长分组

DataleapTaskId

String

关联dataleap任务id

QueueName

String

队列名

SubmitterType

String

提交人类型，Account、User

QueueId

String

队列ID

GroupId

String

计算组ID

Runtime

String

runtime类型，如java、bolt

Cuh

Number

消耗CUH

BoltCuh

Number

消耗Bolt CUH

PrestoScanSize

Number

presto扫描数据量

GroupName

String

计算组名

LastOperator

String

操作人

作业详情

接口描述

获取某个查询作业的详细信息

请求参数

  • 请求方式： GET
  • Action： GetJobDetail
  • Params：

参数

类型

是否必须

描述

Id

String

Y

作业id

JobType

String

Y

作业类型

返回参数

作业 Job

获取作业 Driver 日志

接口描述

  • 按批获取 Driver 日志

请求参数

  • 请求方式： GET

  • Action：FetchDriverLog

  • Params：

    参数

    类型

    是否必须

    描述

    Id

    String

    Y

    作业Id

    Limit

    int

    Y

    本次获取日志数据时读取的最大行数。
    超出行数限制后，会记录当前获取到的日志内容的 position，您可以结合 position 参数继续获取后续日志数据，实现分页查询。

    Position

    String

    Y

    偏移量，bytes，初始为0，后续访问使用接口返回的 position

    Order

    String

    N

    获取日志时，对获取的日志内容进行排序，支持：

    • asc：升序（默认值）
    • desc：降序

    FileName

    String

    N

    文件名，具体含义：

    • 不传值：执行日志（默认不传值）
    • syslog：Spark 作业-Driver 日志-syslog
    • stdout：Spark 作业-Driver 日志-stdout

返回参数

DataTypes.Log

参数

类型

描述

Position

String

当前读取位置，下批次获取日志时需要传入此值

Rows

[]String

日志行

IsFinished

boolean

是否结束，可用于判断是否已经获取到最后一页日志

响应示例如下：

{
    "ResponseMetadata": {
        "RequestId": "2026042215055365694AA12B1AB4267AB2",
        "Action": "FetchDriverLog",
        "Version": "2024-03-25",
        "Service": "emr_serverless",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "Rows": [],
        "Position": "0,1776840957177,450105590065,9519986",
        "IsFinished": true,
        "Limit": 100,
        "Offset": null,
        "Total": null
    }
}

DataTypes 描述文件

通用操作响应 OperateResponse

参数

类型

描述

Success

boolean

是否操作成功

通用列表实体 DataList

参数

类型

描述

Queue/JobList

[]T

数据实体 Array

Limit

int

limit

Offset

int

offset

Total

int

total

资源队列 Queue

字段名

类型

备注

Id

String

队列ID

Name

String

队列名称

Region

String

可用区域

Type

String

队列类型：

  • public： 公共队列
  • private： 独占队列

Status

String

队列状态，参见 资源队列状态 Status

CreateTime

String

开通时间

ExpiredTime

String

有效期至，具体含义如下：

  • 公共队列：不返回此字段
  • 独占队列：合同到期时间

RemainingTime

String

剩余时长，不同队列状态表达的含义不同：

  • 公共队列：不返回此字段
  • 正常/创建中：距离合同到期时间
  • 已欠费：距离停服时间
  • 欠费停服：距离释放时间
  • 已到期：距离停服时间
  • 到期停服：距离释放时间

格式HH:mm:ss, 比如还有18秒钟：" 00:00:18"

Period

String

购买时长，包年包月时返回，不同值的含义如下：

  • M_1： 1个月
  • M_3：3个月
  • M_6：6个月
  • Y_1： 1年
  • Y_2： 2年
  • Y_3： 3年

AutoRenewal

Int

是否自动续费，包年包月时生效，默认值为0:

  • 0：否
  • 1：是

ResourceType

Int

独占队列资源类型，仅包年包月时生效，默认值为0

  • 0: 固定资源
  • 1: 弹性资源

SparkQuantity

Int

数据处理资源单元N，参数示例：
[N] x 16 = xxx CU，本参数传 N

SparkJarQuantity

Int

数据处理资源单元N，参数示例：
[N] x 16 = xxx CU，本参数传 N

ElasticSparkQuantity

Int

弹性资源单元上限Max，参数示例：
[Max] x 16 = xxx CU，本参数传 Max

RoleName

String

当前用户对于此资源队列拥有的权限

  • admin
  • developer
  • viewer
  • none(无任何权限)

作业 Job

字段名

类型

备注

Id

String

任务ID

Name

String

作业名称

Status

String

任务状态，详细的状态对应码请参见 作业状态 Status

JobType

String

作业类型，枚举：

  • SQL
  • SparkJar

QueueName

String

队列

Submitter

String

提交人

SubmitterType

String

提交人身份类型

  • Account
  • User

StartTime

String

提交时间

FinishTime

String

结束时间

Duration

String

耗时, HH:mm:ss

DurationStage

int

耗时阶段，枚举值含义如下：

  • 0：<5min
  • 1: 5~30min
  • 2: 30min ~ 2h
  • 3: >2h

Origin

String

来源

  • Dataleap
  • Client
  • EMR Web UI

Json

String

作业信息

SqlType

String

作业sql类型：
DDL/DML/DQL/-

EngineType

String

引擎类型：
Spark/SparkJar

资源队列状态 Status

Status

状态码

状态

-1

未开通

0

正常

1

欠费停服

2

欠费已释放

3

服务创建中

4

已欠费

5

试用中(暂不支持)

6

已到期

7

到期停服

8

到期释放

9

创建失败

其他

异常信息

作业状态 Status

Status

状态码

状态

Created

已创建

Submitting

提交中

Processing

运行中

Stopping

停止中

Cancelled

已终止

Success

已完成

Failed

已失败

SubmitFailed

提交失败

ResourceInitializing

启动中

最近更新时间：2026.04.22 15:38:36
这个页面对您有帮助吗？
有用
有用
无用
无用