本文档提供 Serverless Spark 中 资源队列 相关的 OpenAPI,具体包含:
队列列表、队列详情
作业列表、作业详情
OpenAPI 调用方可参考 API 调用指南
API Version 统一为 2024-03-25
Service:emr_serverless
获取当前租户下的资源队列列表,支持筛选
请求方式: GET
Action: ListQueue
Params:
参数 | 类型 | 是否必须 | 描述 |
---|---|---|---|
QueueName | String | N | 队列名称;默认为空,即不筛选,返回全部队列 |
Status | String | N | 查询状态;默认为空,即不筛选,返回全部状态的队列 |
StartTime | String | N | 查询开通时间的左区间,"yyyy-MM-dd" |
EndTime | String | N | 查询开通时间的右区间,"yyyy-MM-dd" |
获取当前租户某个队列的详细信息
请求方式: GET
Action: GetQueue
Params:
参数 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Id | String | Y | 队列id |
获取所有提交过的作业
请求方式: GET
Action: ListJob
Params:
参数 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Matches | String | N | 作业Id/作业名称 |
Queue | String | N | 按照队列名字筛选,默认为全部 |
Status | String | N | 按照作业状态筛选,默认为全部; |
DurationStage | int | N | 按照耗时筛选,枚举值含义如下:
|
JobType | String | N | 按照作业类型筛选,枚举值如下:
|
Origin | String | N | 按照作业来源筛选,枚举值如下:
|
Limit | int | N | limit,分页每页数量,默认值为20 |
Offset | int | N | offset,分页的页数,从1开始 |
StartTime | String | N | 查询提交时间的左区间,"yyyy-MM-dd" |
EndTime | String | N | 查询提交时间的右区间,"yyyy-MM-dd" |
获取某个查询作业的详细信息
请求方式: GET
Action: GetJobDetail
Params:
参数 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Id | String | Y | 作业id |
JobType | String | Y | 作业类型 |
参数 | 类型 | 描述 |
---|---|---|
Success | boolean | 是否操作成功 |
参数 | 类型 | 描述 |
---|---|---|
Queue/JobList | []T | 数据实体 Array |
Limit | int | limit |
Offset | int | offset |
Total | int | total |
字段名 | 类型 | 备注 |
---|---|---|
Id | String | 队列ID |
Name | String | 队列名称 |
Region | String | 可用区域 |
Type | String | 队列类型:
|
Status | String | 队列状态,参见 资源队列状态 Status |
CreateTime | String | 开通时间 |
ExpiredTime | String | 有效期至,具体含义如下:
|
RemainingTime | String | 剩余时长,不同队列状态表达的含义不同:
格式HH:mm:ss, 比如还有18秒钟:" 00:00:18" |
Period | String | 购买时长,包年包月时返回,不同值的含义如下:
|
AutoRenewal | Int | 是否自动续费,包年包月时生效,默认值为0:
|
ResourceType | Int | 独占队列资源类型,仅包年包月时生效,默认值为0
|
SparkQuantity | Int | 数据处理资源单元N,参数示例: |
SparkJarQuantity | Int | 数据处理资源单元N,参数示例: |
ElasticSparkQuantity | Int | 弹性资源单元上限Max,参数示例: |
RoleName | String | 当前用户对于此资源队列拥有的权限
|
字段名 | 类型 | 备注 |
---|---|---|
Id | String | 任务ID |
Name | String | 作业名称 |
Status | Int | 任务状态,详细的状态对应码请参见 作业状态 Status |
JobType | String | 作业类型,枚举:
|
QueueName | String | 队列 |
Submitter | String | 提交人 |
SubmitterType | String | 提交人身份类型
|
StartTime | String | 提交时间 |
FinishTime | String | 结束时间 |
Duration | String | 耗时, HH:mm:ss |
DurationStage | int | 耗时阶段,枚举值含义如下:
|
Origin | String | 来源
|
Json | String | 作业信息 |
SqlType | String | 作业sql类型: |
EngineType | String | 引擎类型: |
Status | 状态码 | 状态 |
---|---|---|
-1 | 未开通 | |
0 | 正常 | |
1 | 欠费停服 | |
2 | 欠费已释放 | |
3 | 服务创建中 | |
4 | 已欠费 | |
5 | 试用中(暂不支持) | |
6 | 已到期 | |
7 | 到期停服 | |
8 | 到期释放 | |
9 | 创建失败 | |
其他 | 异常信息 |
Status | 状态码 | 状态 |
---|---|---|
0 | 已创建 | |
1 | 提交中 | |
2 | 运行中 | |
3 | 停止中 | |
4 | 已终止 | |
5 | 已完成 | |
6 | 已失败 |