更新时间:2024-11-22 GMT+08:00
分享

查询作业列表

功能介绍

查询批处理或实时作业列表,每次查询返回的作业数量上限是100。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。

URI

  • URI格式

    GET /v1/{project_id}/jobs?jobType={jobType}&offset={offset}&limit={limit}&jobName={jobName}&tags={tags}

  • 参数说明

    参数名

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,获取方法请参见项目ID和账号ID

    jobType

    String

    作业类型:

    • REAL_TIME:实时处理
    • BATCH:批处理

    默认值:BATCH

    offset

    Integer

    分页列表的页数,默认值为0。取值范围大于等于0。

    limit

    Integer

    分页返回结果,指定每页最大记录数。范围[1,1000]

    默认值:10

    jobName

    String

    作业名称

    tags

    String

    作业标签列表,如果有多个标签,以英文逗号分隔。例如:tag1,tag2,tag3。

请求参数

表1 请求Header参数

参数名

是否必选

参数类型

说明

workspace

String

工作空间id。

  • 如果不设置该参数,默认查询default工作空间下的数据。
  • 如果需要查询其他工作空间的数据,需要带上该消息头。

响应参数

表2 参数说明

参数名

是否必选

参数类型

说明

total

Integer

作业数量。

jobs

List<Job>

作业列表,参考表3

表3 Job数据结构说明

参数名

是否必选

参数类型

说明

name

String

作业名称。

jobType

String

作业类型。

  • REAL_TIME:实时处理
  • BATCH :批处理

owner

String

作业责任人,长度不能超过128个字符。

priority

int

作业优先级,取值范围[0, 2],默认值是0。0代表高优先级,1代表中优先级,2代表低优先级。

status

String

作业状态。

当jobType为REAL_TIME时,有如下状态:

  • STARTING: 启动中
  • NORMAL :运行中
  • EXCEPTION:启动或停止异常
  • STOPPING :停止中
  • STOPPED: 已停止

当jobType为BATCH时,有如下状态:

  • SCHEDULING :调度中
  • STOPPED :已停止调度
  • PAUSED: 暂停调度

createUser

String

作业的创建者。

createTime

Long

作业的创建时间。

startTime

Long

作业的启动时间。

endTime

Long

作业配置的结束时间。

lastInstanceStatus

String

作业最近一次运行实例状态,当jobType为BATCH时才有本字段。

lastInstanceEndTime

Long

作业最近一次运行实例运行结束时间,当jobType为BATCH时才有本字段。

lastUpdateTime

Long

作业最后一次更新时间。

lastUpdateUser

String

作业最后一次更新用户。

path

String

作业的路径。

singleNodeJobFlag

boolean

作业是否为单任务作业。

请求示例

查询作业列表。

GET /v1/ff6b627b9d7b45b48f773be511c1a2b8/jobs

响应示例

  • 成功响应
    {
        "jobs": [
            {
                "createTime": 1680783636000,
                "createUser": "test_user",
                "jobType": "BATCH",
                "lastInstanceEndTime": 1682519407000,
                "lastInstanceStatus": "success",
                "lastUpdateUser": "test_user",
                "name": "myJob",
                "owner": "test_user",
                "path": "/",
                "priority": 0,
                "singleNodeJobFlag": false,
                "status": "SCHEDULING"
            }
        ],
        "total": 1
    }
  • 失败响应

    HTTP状态码 400

    {
        "error_code":"DLF.3051",
        "error_msg":"The request parameter is invalid."
    }

相关文档