You need to enable JavaScript to run this app.
导航
Open API
最近更新时间:2024.05.14 15:11:21首次发布时间:2024.05.14 10:37:06

本文档提供 Serverless Spark 中 资源队列 相关的 OpenAPI,具体包含:

  • 队列列表、队列详情

  • 作业列表、作业详情

  • OpenAPI 调用方可参考 API 调用指南

  • API Version 统一为 2024-03-25

  • Service:emr_serverless

资源队列

队列列表

接口描述

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

请求参数

  • 请求方式: GET

  • Action: ListQueue

  • Params:

参数类型是否必须描述
QueueNameStringN队列名称;默认为空,即不筛选,返回全部队列

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:

参数类型是否必须描述
IdStringY队列id

返回参数

资源队列 Queue

作业管理

作业列表

接口描述

获取所有提交过的作业

请求参数

  • 请求方式: GET

  • Action: ListJob

  • Params:

参数类型是否必须描述
MatchesStringN作业Id/作业名称
QueueStringN按照队列名字筛选,默认为全部

Status

String

N

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

DurationStage

int

N

按照耗时筛选,枚举值含义如下:

  • 0:<5min

  • 1: 5~30min

  • 2: 30min ~ 2h

  • 3: >2h

JobType

String

N

按照作业类型筛选,枚举值如下:

  • SQL

  • SparkJar

Origin

String

N

按照作业来源筛选,枚举值如下:

  • Dataleap

  • Client

  • EMR Web UI

LimitintNlimit,分页每页数量,默认值为20
OffsetintNoffset,分页的页数,从1开始

StartTime

String

N

查询提交时间的左区间,"yyyy-MM-dd"
系统会自动补齐为:yyyy-MM-dd 00:00:00

EndTime

String

N

查询提交时间的右区间,"yyyy-MM-dd"
系统会自动补齐为:yyyy-MM-dd 23:59:59

返回参数

作业 Job

作业详情

接口描述

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

请求参数

  • 请求方式: GET

  • Action: GetJobDetail

  • Params:

参数类型是否必须描述
IdStringY作业id
JobTypeStringY作业类型

返回参数

作业 Job

DataTypes 描述文件

通用操作响应 OperateResponse

参数类型描述
Successboolean是否操作成功

通用列表实体 DataList

参数类型描述
Queue/JobList[]T数据实体 Array
Limitintlimit
Offsetintoffset
Totalinttotal

资源队列 Queue

字段名类型备注
IdString队列ID
NameString队列名称
RegionString可用区域

Type

String

队列类型:

  • public: 公共队列

  • private: 独占队列

StatusString队列状态,参见 资源队列状态 Status
CreateTimeString开通时间

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

NameString作业名称
StatusInt任务状态,详细的状态对应码请参见 作业状态 Status

JobType

String

作业类型,枚举:

  • SQL

  • SparkJar

QueueNameString队列
SubmitterString提交人

SubmitterType

String

提交人身份类型

  • Account

  • User

StartTimeString提交时间
FinishTimeString结束时间
DurationString耗时, HH:mm:ss

DurationStage

int

耗时阶段,枚举值含义如下:

  • 0:<5min

  • 1: 5~30min

  • 2: 30min ~ 2h

  • 3: >2h

Origin

String

来源

  • Dataleap

  • Client

  • EMR Web UI

JsonString作业信息

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状态码状态
0已创建
1提交中
2运行中
3停止中
4已终止
5已完成
6已失败