更新时间:2023-06-15 GMT+08:00

立即执行作业

功能介绍

本接口用于立即执行作业,验证作业是否能执行成功。

URI

  • URI格式

    POST /v1/{project_id}/jobs/{job_name}/run-immediate

  • 参数说明
    表1 URI参数说明

    参数名

    是否必选

    参数类型

    说明

    project_id

    String

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

    job_name

    String

    作业名称

请求消息

表2 请求Header参数

参数名

是否必选

参数类型

说明

workspace

String

工作空间id。

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

参数说明

参数名

是否必选

参数类型

说明

jobParams

List<JobParam>

作业启动的参数。

JobParam数据结构说明

参数名

是否必选

参数类型

说明

name

String

参数名称,长度不能超过64个字符。

value

String

参数值,长度不能超过1024个字符。

响应消息

表3 参数说明

参数名

是否必选

参数类型

说明

instanceId

Long

作业实例id

示例

单次执行作业myJob。

  • 请求
    POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/myJob/run-immediate
    {
        "jobParams":[
            {
                "name":"aaa",
                "value":"111"
            },
            {
                "name":"bbb",
                "value":"222"
            }
        ]
    }
  • 成功响应
    {
        "instanceId":132343
    }
  • 失败响应

    HTTP状态码 400

    {
        "error_code":"DLF.0100",
        "error_msg":"The job does not exists."
    }