文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据开发API（V1）/ 作业开发API/ 启动作业
更新时间：2024-11-05 GMT+08:00
查看PDF
分享

启动作业

功能介绍

本接口用于执行调度一个作业。

调试

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

URI

  • URI格式

    POST /v1/{project_id}/jobs/{job_name}/start

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

    参数名

    是否必选

    参数类型

    说明

    project_id

    是

    String

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

    job_name

    是

    String

    作业名称。

请求参数

表2 请求Header参数

参数名

是否必选

参数类型

说明

workspace

否

String

工作空间id。

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

参数名

是否必选

类型

描述

jobParams

否

List<JobParam>

作业启动的参数。

start_date

否

Long

启动日期。比如：20241030

ignore_first_self_dep

否

boolean

忽略首天依赖。
表4 JobParam数据结构说明

参数名

是否必选

参数类型

说明

name

是

String

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

value

是

String

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

paramType

否

String

参数类型。

  • variable：变量
  • constants：常量

响应参数

无

请求示例

启动作业myJob。 
POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/myJob/start
{
  "jobParams": [
    {
      "name": "string",
      "value": "string",
      "paramType": "variable"
    }
  ]
}

响应示例

  • 成功响应

    HTTP状态码 204

  • 失败响应

    HTTP状态码 400

    {
    "error_code":"DLF.0100",
    "error_msg":"The job does not exists."
}
父主题： 作业开发API

相关文档