调用ListJobRuns获取Spark任务列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
emr-serverless-spark:ListJobRuns | list | *全部资源 * |
| 无 |
请求语法
GET /api/v1/workspaces/{workspaceId}/jobRuns HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
nextToken | string | 否 | 标记当前开始读取的位置。 | DD6B1B2A-5837-5237-ABE4-FF0C89568980 |
maxResults | integer | 否 | 一次获取的最大记录数。 | 20 |
workspaceId | string | 是 | 工作空间 ID。 | w-d2d82aa09155**** |
name | string | 否 | 任务名称。 | emr-spark-demo-job |
creator | string | 否 | 创建用户 UID。 | 150978934701**** |
jobRunId | string | 否 | 任务 ID。 | j-xxx |
tags | array<object> | 否 | 标签列表。 | |
Tag | object | 否 | 标签对象。 | |
key | string | 否 | 标签键。 | tag_key |
value | string | 否 | 标签值。 | value |
states | array | 否 | 任务状态。 | |
String | string | 否 | 任务状态。取值范围:
| Running |
startTime | object | 否 | 任务开始时间范围。 | |
startTime | long | 否 | 任务开始时间范围的起点。 | 1709740800000 |
endTime | long | 否 | 任务开始时间范围的终点。 | 1710432000000 |
endTime | object | 否 | 任务结束时间范围。 | |
startTime | long | 否 | 任务结束时间范围的起点。 | 1709740800000 |
endTime | long | 否 | 任务结束时间范围的终点。 | 1710432000000 |
resourceQueueId | string | 否 | Spark 任务运行的资源队列名称。 | dev_queue |
regionId | string | 否 | 地域 ID。 | cn-hangzhou |
返回参数
示例
正常返回示例
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-20 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-05-31 | OpenAPI 入参发生变更 | 查看变更详情 |
2024-05-17 | API 内部配置变更,不影响调用 | 查看变更详情 |