文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据开发API（V1）/ 作业开发API/ 立即执行作业
更新时间：2025-05-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

立即执行作业

功能介绍

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

调试

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

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工作空间下的数据。
  • 如果需要查询其他工作空间的数据，需要带上该消息头。
    说明：
    • 多个DataArts Studio实例需要指定工作空间。
    • 当工作空间里面没有default工作空间时，工作空间为必填参数，否则会报错。
表3 参数说明

参数名

是否必选

参数类型

说明

jobParams

否

List<JobParam>

作业立即执行的参数。
表4 JobParam数据结构说明

参数名

是否必选

参数类型

说明

name

是

String

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

value

是

String

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

type

否

String

参数类型。

  • variable：变量
  • constants：常量

响应参数

表5 参数说明

参数名

是否必选

参数类型

说明

instanceId

是

Long

作业实例id。

请求示例

单次执行作业myJob。作业中的参数为aaa，参数值为111，作业中的参数为bbb，参数值为222。 
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."
}
父主题： 作业开发API

相关文档