ListJobRuns - 获取Spark任务列表

调用ListJobRuns获取Spark任务列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
emr-serverless-spark:ListJobRunslist
*全部资源
*

请求语法

GET /api/v1/workspaces/{workspaceId}/jobRuns HTTP/1.1

请求参数

名称类型必填描述示例值
nextTokenstring

标记当前开始读取的位置。

DD6B1B2A-5837-5237-ABE4-FF0C89568980
maxResultsinteger

一次获取的最大记录数。

20
workspaceIdstring

工作空间 ID。

w-d2d82aa09155****
namestring

任务名称。

emr-spark-demo-job
creatorstring

创建用户 UID。

150978934701****
jobRunIdstring

任务 ID。

j-xxx
tagsarray<object>

标签列表。

Tagobject

标签对象。

keystring

标签键。

tag_key
valuestring

标签值。

value
statesarray

任务状态。

Stringstring

任务状态。取值范围:

  • Submitted:已提交。
  • Pending:待处理。
  • Running:运行中。
  • Success:成功。
  • Failed:失败。
  • Cancelling:取消中。
  • Cancelled:已取消。
  • CancelFailed:取消失败。
Running
startTimeobject

任务开始时间范围。

startTimelong

任务开始时间范围的起点。

1709740800000
endTimelong

任务开始时间范围的终点。

1710432000000
endTimeobject

任务结束时间范围。

startTimelong

任务结束时间范围的起点。

1709740800000
endTimelong

任务结束时间范围的终点。

1710432000000
resourceQueueIdstring

Spark 任务运行的资源队列名称。

dev_queue
regionIdstring

地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

返回数据

jobRunsarray<object>

Spark 任务列表。

Runobject

Spark 任务对象。

workspaceIdstring

工作空间 ID。

w-d2d82aa09155****
jobRunIdstring

任务 ID。

jr-231231
namestring

任务名称。

jobName
statestring

任务状态。

Running
stateChangeReasonobject

状态变化原因。

codestring

错误码。

0
messagestring

错误信息。

connection refused
submitTimelong

任务提交时间。

1684119314000
endTimelong

任务结束时间。

1684119314000
codeTypestring

任务代码类型。取值范围:

SQL

JAR

PYTHON

SQL
webUIstring

作业 Web UI。

http://spark-ui
executionTimeoutSecondsinteger

运行超时时间。

3600
creatorstring

创建用户 UID。

150978934701****
tagsarray

标签。

TagTag

任务标签.

logRunLog

运行日志路径。

releaseVersionstring

运行任务的 Spark 引擎版本。

esr-native-3.4.0
jobDriverJobDriver

Spark Driver 相关信息。

configurationOverridesobject

Spark 高级配置。

configurationsarray

Spark Conf 列表。

ConfigurationConfiguration

Spark Conf 对象。

requestIdstring

请求 ID。

DD6B1B2A-5837-5237-ABE4-FF0C8944****
nextTokenstring

返回读取到的数据位置。

DD6B1B2A-5837-5237-ABE4-FF0C89568980
maxResultsinteger

本次请求所返回的最大记录条数。

20
totalCountinteger

本次请求条件下的数据总量。

200

示例

正常返回示例

JSON格式

{
  "jobRuns": [
    {
      "workspaceId": "w-d2d82aa09155****",
      "jobRunId": "jr-231231",
      "name": "jobName",
      "state": "Running",
      "stateChangeReason": {
        "code": "0",
        "message": "connection refused\n"
      },
      "submitTime": 1684119314000,
      "endTime": 1684119314000,
      "codeType": "SQL",
      "webUI": "http://spark-ui",
      "executionTimeoutSeconds": 3600,
      "creator": "150978934701****",
      "tags": [
        {
          "key": "workflowId",
          "value": "wf-123test"
        }
      ],
      "log": {
        "driverStdOut": "",
        "driverStdError": "",
        "driverSyslog": "",
        "driverStartup": ""
      },
      "releaseVersion": "esr-native-3.4.0",
      "jobDriver": {
        "sparkSubmit": {
          "entryPoint": "",
          "entryPointArguments": [
            ""
          ],
          "sparkSubmitParameters": ""
        }
      },
      "configurationOverrides": {
        "configurations": [
          {
            "configFileName": "",
            "configItemKey": "",
            "configItemValue": ""
          }
        ]
      },
      "displayReleaseVersion": "",
      "fusion": true
    }
  ],
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "nextToken": "DD6B1B2A-5837-5237-ABE4-FF0C89568980",
  "maxResults": 20,
  "totalCount": 200
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-08-20OpenAPI 返回结构发生变更查看变更详情
2024-05-31OpenAPI 入参发生变更查看变更详情
2024-05-17API 内部配置变更,不影响调用查看变更详情