更新时间:2024-12-02 GMT+08:00

创建补数据实例

功能介绍

创建一个补数据实例。

URI

  • URI格式

    POST /v2/{project_id}/factory/supplement-data

  • 参数说明

    参数名

    是否必选

    参数类型

    说明

    project_id

    String

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

请求参数

表1 请求Header参数

参数名

是否必选

参数类型

说明

workspace

String

工作空间id。

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

X-Auth-Token

String

IAM Token

最小长度:0

最大长度:4096

Content-Type

String

发送的实体的MIME类型。

表2 Body参数说明

参数名

是否必选

参数类型

说明

name

String

补数据任务的名称。

job_name

String

作业名称,即补数据任务需要补哪个作业的名称。

start_date

String

补数据的开始日期,格式如"2023-08-21T00:00:00 +08"

end_date

String

补数据的结束日期,格式如"2023-08-21T23:59:59 +08"

parallel

int

补数据实例的并行周期数,取值范围[1,5]。

设置同时执行的补数据实例数量,最多可同时执行5个实例。

depend_jobs

List<JobDTO>

参考表3

is_day_granularity

Boolean

是否按照天粒度补数据,true表示是,false表示否。

priority

int

设置补数据作业的优先级。当系统资源不充足时,可以优先满足优先级较高的作业的计算资源,数字越大优先级越高,当前只支持对DLI SQL算子设置优先级。

is_stop_when_fail

Boolean

补数据作业失败时是否停止,true表示停止,false表示不停止。

reverse_order

int

是否按照日期倒序补数据,取值范围[0,1],0表示正序补数据,1表示倒序补数据。

force

String

是否强制补数据,true表示强制补数据,同一个作业出现在2个补数据实例时,也可以进行补数据;false表示不能强制补数据。

supplement_data_run_time

Object

补数据时间段,当前仅支持每天,如果没有补数据时间,则默认为"00:00-00:00”,参考表4

supplement_data_instance_time

Object

支持补离散时间任务,参考表5

表3 JobDTO参数说明

参数名

是否必选

参数类型

说明

job_name

String

作业名称。

workspace_id

String

工作空间ID。

表4 SupplementDataRunTime参数说明

参数名

是否必选

参数类型

说明

time_of_day

String

每天的可补数据时间段,如:每天的10点15分到23点30分,表示:10:15-23:30

day_of_week

String

每周的星期几可以补数据,如:每周一,周三的每天10点15分到23点30分

day_of_month

String

每个月的哪几天可以补数据,如每月1号,3号,表示:1,3

表5 SupplementDataInstanceTime参数说明

参数名

是否必选

参数类型

说明

days

array[string]

支持离散的天。

time_of_day

String

指定天中的时间段。

响应参数

请求示例

创建一个名称为P_job_6796_20230823_9991的补数据实例,依赖的作业名为job_5799。

POST /v2/62099355b894428e8916573ae635f1f9/factory/supplement-data

{
	"name": "P_job_6796_20230823_9991",
	"job_name": "job_5799",
	"start_date": "2023-08-23T00:00:00 +08",
	"end_date": "2023-08-23T23:59:59 +08",
	"parallel": 1,
	"depend_jobs": [],
	"is_day_granularity": false,
	"priority": 0,
	"is_stop_when_fail": false,
	"reverse_order": 0,
        "supplement_data_run_time": {
		"time_of_day": "01:03-02:00"
	},
	"supplement_data_instance_time": {
		"days": ["2023/09/05-2023/09/05"],
		"time_of_day": "00:00-23:59"
	},
	"force": "true"
}

响应示例

  • 成功响应

    HTTP状态码 200

  • 失败响应

    HTTP状态码 400

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