文档首页/ 推荐系统 RES/ API参考/ API（V1不推荐）/ 作业相关API/ 查询作业列表
更新时间：2023-05-24 GMT+08:00
查看PDF
分享

查询作业列表

功能介绍

该接口用于查询作业列表。

可支持查询作业的类型包括：组合作业、召回作业、过滤作业、特征工程作业、排序作业、近线作业和效果评估任务。

URI

GET/v1/{project_id}/jobs?type={type}&current-page={current-page}&page-size={page-size}&start-time={start-time}&end-time={end-time}

参数说明请参见表1。

表1 URI参数说明

名称

是否必选

类型

说明

project_id

是

String

项目编号，用于资源隔离。获取方法请参见获取项目ID。

type

是

String

查询训练作业的类型retrieval、filter、etl、ranking、nearline、standard、evaluation。

current-page

是

Long

当前页面。

page-size

是

Long

页面条数。

start-time

否

String

开始时间。

end-time

否

String

结束时间。

job-name

否

String

作业名称

job-status

否

String

作业状态

sortby

否

String

排序字段

order

否

String

排序方式：asc,desc

workspace_id

否

String

工作空间ID，默认为0

请求消息

暂不涉及。

响应消息

响应参数请参见表2。

表2 响应参数说明

参数名称

是否必选

参数类型

说明

is_success

是

Boolean

是否成功。

jobs

是

List

请参见表3，返回的作业信息。

total_items

是

Integer

作业总条数。
表3 jobs参数说明

参数名称

是否必选

参数类型

说明

job_id

是

String

训练作业ID。

job_name

是

String

训练作业名称，只能由数字，字母，下划线，中划线组成，最大长度为20字符。

job_description

否

String

训练作业描述，最大长度为256字符。

project_id

是

String

项目编号，用于资源隔离。

user_id

是

String

用户ID。

operating_time

是

Long

操作时间。

request_info

是

Object

请求体。

response_info

是

Object

返回体。

job_status

是

String

作业状态。

resource

是

String

资源，现在支持DLI。

is_use

是

int

是否被使用：

  • 1，被使用。
  • 0，没有被使用。

type

是

String

训练作业类型。

示例

  • 成功响应示例 
    {
"jobs": [
{
"job_id": "5d041e988e7442eb98c4b14cb3fbdc62",
"job_name": "evaluate-cqian",
"project_id": "b09d59c4e8724078a5e8efa65049e78f",
"user_id": "03cfcb78b4b34ba79c9d5aa43dcfb49a",
"operating_time": 1550563630482,
"request_info": {
"job_name": "evaluate-cqian",
"job_description": "",
"user_behaviors": {
"table_type_id": "GENERAL_FORMAT",
"data_format": "json",
"data_source_url": "<数据源存储路径>"
},
"indicators": [
{
"indicator_name": "clickPV",
"indicator_params": {}
},
{
"indicator_name": "consumePV",
"indicator_params": {}
},
{
"indicator_name": "avgBhvCount",
"indicator_params": {
"behavior_type": "consume"
}
},
{
"indicator_name": "avgBhvDuration",
"indicator_params": {}
},
{
"indicator_name": "userAmount",
"indicator_params": {}
},
{
"indicator_name": "activeUserAmount",
"indicator_params": {
"behavior_type": "consume",
"threshold": 5
}
}
],
"start_time": 1512983142000,
"end_time": 1526457087000,
"interval": 30,
"result_path": "<输出数据的存储都路径>",
"offline_platform": {
"platform": "DLI",
"platform_parameter": {
"cluster_name": "res_cluster"
},
"config_load_path": "<配置源路径>",
"computing_resource": ""
}
},
"response_info": {
"is_success": true,
"job_id": "5d041e988e7442eb98c4b14cb3fbdc62"
},
"job_status": "SUCCEEDED",
"resource": "DLI",
"is_use": 0,
"type": "evaluation"
}
],
"is_success": true,
"total_items": 191
}
  • 失败响应示例 
    {
    "is_success": false,
    "error_code": "res.3106",
    "error_msg": "The start time or end time is error."
}

状态码

状态码请参见状态码。

父主题： 作业相关API

相关文档