查询作业列表-QueryJobsList

功能介绍

查询作业列表

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目id，获取方法请参见获取项目ID

表2 Query参数
参数	是否必选	参数类型	描述
workspace_id	否	String	工作空间id
data_id	否	String	数据ID
id	否	Long	作业ID
output_types	否	Array of strings	输出类型，类型不超过10个
processor_name	否	String	算子名称
status	否	String	作业状态
start_time	否	Long	最小创建时间，UTC标准时间毫秒时间戳
end_time	否	Long	最大更新时间，UTC标准时间毫秒时间戳
limit	否	Integer	返回个数上限
offset	否	Integer	查询偏移量
sort	否	String	排序方式
cluster_type	否	String	集群类型

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

响应参数

状态码：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_id	String	数据id
status	String	作业状态
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	集群类型
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
    }
  }
}