GetRunningJobs - 获取运行态的作业列表

指定时间范围内,所有仍处于“运行中”的作业的运行态数据展示。

调试

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

授权信息

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

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

请求语法

GET /api/v1/jobs/runningJobs HTTP/1.1

请求参数

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

查询开始时间点。该时间是指作业的提交时间。

  • 请求参数 fromto 定义的时间区间遵循双闭原则,即该时间区间既包括区间开始时间点也包括区间结束时间点。如果 fromto 的值相同,则为无效区间,函数直接返回空。
  • Unix 时间戳格式,表示从 1970-1-1 00:00:00 UTC 计算起的秒数。
1683785928
tolong

查询结束时间点。该时间是指作业的提交时间。

  • 请求参数 fromto 定义的时间区间遵循双闭原则,即该时间区间既包括区间开始时间点也包括区间结束时间点。如果 fromto 的值相同,则为无效区间,函数直接返回空。
  • Unix 时间戳格式,表示从 1970-1-1 00:00:00 UTC 计算起的秒数。
1683612946
jobOwnerListarray

作业的执行者列表

itemstring

作业的执行者列表

ALIYUN$xxx@test.aliyunid.com
quotaNicknameListarray

作业使用的配额昵称列表

itemstring

作业使用的配额昵称列表

my_quota
pageNumberlong

页码

1
pageSizelong

每页返回数目,默认为 10,最大为 20

10

返回参数

名称类型描述示例值
object

PopResult

requestIdstring

请求 id。

0bc3b4ab16684833172127321e2c25
httpCodeinteger

业务成功与否。如果非空且不是 200,那么表示业务处理失败。

200
errorCodestring
  • 当 success 为 false,返回业务错误码;

  • 当 success 为 true,返回空值。

success
errorMsgstring

错误描述信息。

0A3B1FD2006A24C8D8BE65CDAC028298
dataobject

返回结果。

runningJobInfoListarray<object>

执行状态的作业列表

runningJobInfoListobject

执行状态的作业

instanceIdstring

实例 ID。

2023050206371544gomgtp3ljcr4
jobOwnerstring

提交作业的账号

ALIYUN$xxx@test.aliyunid.com
projectstring

maxcompute 项目名称

project_20221021123044_981b
quotaNicknamestring

作业使用的配额昵称

my_quota
cuSnapshotdouble

作业的 cu 快照占比

0.45
memorySnapshotdouble

作业的内存快照占比

0.45
submittedAtTimelong

作业的提交时间

1689746864
runningAtTimelong

作业的开始运行时间

1689746864
progressdouble

任务进度。

0
totalCountlong

返回结果的总数量。

64
pageNumberlong

当前页码。

2
pageSizelong

每页显示条数。

10

示例

正常返回示例

JSON格式

{
  "requestId": "0bc3b4ab16684833172127321e2c25",
  "httpCode": 200,
  "errorCode": "success",
  "errorMsg": "0A3B1FD2006A24C8D8BE65CDAC028298",
  "data": {
    "runningJobInfoList": [
      {
        "instanceId": "2023050206371544gomgtp3ljcr4",
        "jobOwner": "ALIYUN$xxx@test.aliyunid.com",
        "project": "project_20221021123044_981b",
        "quotaNickname": "my_quota",
        "cuSnapshot": 0.45,
        "memorySnapshot": 0.45,
        "submittedAtTime": 1689746864,
        "runningAtTime": 1689746864,
        "progress": 0
      }
    ],
    "totalCount": 64,
    "pageNumber": 2,
    "pageSize": 10
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-08-26API 内部配置变更,不影响调用查看变更详情