更新时间:2026-04-30 GMT+08:00
分享

查询作业列表-ListDataJobs

功能介绍

查询作业列表

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    octopus:dataJob:list

    List

    workspace *

    -

    -

    -

URI

GET /v1.0/{project_id}/data/jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,获取方法请参见获取项目ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

workspace_id

否

String

参数解释:

工作空间ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

0

data_id

否

String

参数解释:

数据ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

id

否

Long

参数解释:

作业ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

output_types

否

Array of strings

参数解释:

输出类型

约束限制:

类型不超过10个

processor_name

否

String

参数解释:

算子名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

status

否

String

参数解释:

作业状态

约束限制:

不涉及

取值范围:

  • QUEUING:排队中

  • SUBMIT_FAILED:提交失败

  • RUNNING:运行中

  • RUN_FAILED:运行异常

  • FINISHED:已完成

  • STOPPED:已停止

  • LAUNCHING:启动中

  • UPLOADING:上传中

  • UPLOAD_FAILED:上传失败

默认取值:

不涉及

start_time

否

Long

参数解释:

最小创建时间,UTC标准时间毫秒时间戳

约束限制:

不涉及

取值范围:

1000000000000-2000000000000

默认取值:

不涉及

end_time

否

Long

参数解释:

最大创建时间,UTC标准时间毫秒时间戳

约束限制:

不涉及

取值范围:

1000000000000-2000000000000

默认取值:

不涉及

limit

否

Integer

参数解释:

列表返回的最大记录数

约束限制:

最小为1,最大为200

取值范围:

不涉及

默认取值:

10

offset

否

Integer

参数解释:

查询偏移量,与limit配合使用。假如设置offset为11,limit为10,即从第12条数据开始查询,一次最多读取10条记录。当offset超过总记录数时,列表返回为空

约束限制:

最小值0

取值范围:

不涉及

默认取值:

0

sort

否

String

参数解释:

排序方式

约束限制:

不涉及

取值范围:

  • CREATE_ASC:创建时间升序

  • CREATE_DESC:创建时间降序

  • UPDATE_ASC:更新时间升序

  • UPDATE_DESC:更新时间降序

默认取值:

UPDATE_DESC

cluster_type

否

String

参数解释:

集群类型

约束限制:

不涉及

取值范围:

  • CCE

  • MODELARTS

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

Content-Type

是

String

参数解释:

内容类型。填application/json

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

payload

DataJobPayload object

参数解释:

实际返回信息

meta_info

RespMetaInfo object

参数解释:

元数据

表5 DataJobPayload

参数

参数类型

描述

list

Array of DataJobListVo objects

参数解释:

作业列表

page_info

PageInfo object

参数解释:

分页信息

表6 DataJobListVo

参数

参数类型

描述

id

Long

参数解释:

作业ID

取值范围:

不涉及

processor_id

Long

参数解释:

算子ID

取值范围:

不涉及

processor_name

String

参数解释:

算子名称

取值范围:

不涉及

output_type

String

参数解释:

输出类型

取值范围:

  • DATA_MARK:数据标记

  • OPEN_DATA:数据回放

  • DATA_SET:数据集

  • REPLAY_SIM:回放仿真

  • PLOT_DATA:数据图表

data_id

String

参数解释:

数据ID

取值范围:

不涉及

status

String

参数解释:

作业状态

取值范围:

  • QUEUING:排队中

  • SUBMIT_FAILED:提交失败

  • RUNNING:运行中

  • RUN_FAILED:运行异常

  • FINISHED:已完成

  • STOPPED:已停止

  • LAUNCHING:启动中

  • UPLOADING:上传中

  • UPLOAD_FAILED:上传失败

create_at

Long

参数解释:

创建时间,UTC标准时间毫秒时间戳

取值范围:

不涉及

update_at

Long

参数解释:

更新时间,UTC标准时间毫秒时间戳

取值范围:

不涉及

start_at

Long

参数解释:

开始运行时间,作业未开始运行不返回该字段,UTC标准时间毫秒时间戳

取值范围:

不涉及

end_at

Long

参数解释:

运行结束时间,作业未结束不返回该字段,UTC标准时间毫秒时间戳

取值范围:

不涉及

msg_code

Integer

参数解释:

错误码,作业状态正常不返回该字段(1:内部异常,10003:镜像不存在,10005:pvc不存在,10009:算子不存在,10011:获取实例资源异常,106:创建容器配置失败,107:镜像拉取失败,108:无效镜像,109:容器启动异常,110:创建容器失败,111:未选择数据仓库,201:数据包不存在,202:资源不可用,203:数据包类型异常,204:数据包状态不符合要求,205:场景片段不存在或源文件不存在,206:数据来源与算子类型不匹配,99999:作业运行失败)

取值范围:

不涉及

msg_error

String

参数解释:

错误原因,作业状态正常不返回该字段

取值范围:

不涉及

submitting_duration

Long

参数解释:

提交时长,毫秒单位(作业创建到k8s开始运行的时长)

取值范围:

不涉及

running_duration

Long

参数解释:

运行时长,作业未开始运行不返回该字段,毫秒单位(k8s运行时长)

取值范围:

不涉及

resource_spec

String

参数解释:

资源规格

取值范围:

不涉及

project_id

String

参数解释:

项目ID

取值范围:

不涉及

data_source

String

参数解释:

输入数据来源

取值范围:

不涉及

workspace_id

String

参数解释:

工作空间ID

取值范围:

不涉及

cluster_type

String

参数解释:

集群类型

取值范围:

  • CCE

  • MODELARTS

cluster_id

String

参数解释:

集群ID

取值范围:

不涉及

表7 PageInfo

参数

参数类型

描述

offset

Integer

参数解释:

查询偏移量

取值范围:

不涉及

limit

Integer

参数解释:

返回个数上限

取值范围:

不涉及

total

Integer

参数解释:

资源总数

取值范围:

不涉及

表8 RespMetaInfo

参数

参数类型

描述

current_time

String

参数解释:

请求时间,UTC时间格式,时间为UTC标准时间

取值范围:

不涉及

请求示例

查询作业列表

GET https://{endpoint}/v1.0/{project_id}/data/jobs?limit=10&offset=0

响应示例

状态码:200

查询成功

{
  "meta_info" : {
    "current_time" : "2022-01-01T08:08:29Z"
  },
  "payload" : {
    "list" : [ {
      "id" : 1000,
      "processor_id" : 10000,
      "processor_name" : "myProcessor",
      "output_type" : "OPEN_DATA",
      "data_id" : "DPK0000001",
      "data_source" : "DATA_PACKAGE",
      "status" : "FINISHED",
      "create_at" : 1640966400000,
      "update_at" : 1640966400000,
      "start_at" : 1640966400000,
      "end_at" : 1640966400000,
      "project_id" : "087679f0aaxxxxxxxxxxxxxx2f5e902b",
      "submitting_duration" : 10000,
      "running_duration" : 10000,
      "resource_spec" : "4Core_8GiB",
      "cluster_type" : "CCE",
      "cluster_id" : "087679f0aaxxxxxxxxxxxxxx2f5e902b"
    }, {
      "id" : 1000,
      "processor_id" : 10000,
      "processor_name" : "myProcessor",
      "output_type" : "OPEN_DATA",
      "data_id" : "DPK0000001",
      "data_source" : "DATA_PACKAGE",
      "status" : "RUN_FAILED",
      "create_at" : 1640966400000,
      "update_at" : 1640966400000,
      "start_at" : 1640966400000,
      "end_at" : 1640966400000,
      "project_id" : "087679f0aaxxxxxxxxxxxxxx2f5e902b",
      "msg_code" : 1,
      "msg_error" : "内部异常",
      "submitting_duration" : 10000,
      "running_duration" : 10000,
      "resource_spec" : "1Core_1GiB",
      "cluster_type" : "CCE",
      "cluster_id" : "087679f0aaxxxxxxxxxxxxxx2f5e902b"
    } ],
    "page_info" : {
      "offset" : 0,
      "limit" : 10,
      "total" : 20
    }
  }
}

状态码

状态码

描述

200

查询成功

400

请求参数错误

403

权限校验失败

500

系统内部错误

错误码

请参见错误码。

相关文档