
# 创建补数据实例 - CreateFactorySupplementDataInstance
#### 功能介绍
创建一个补数据实例。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DataArtsStudio/doc?api=CreateFactorySupplementDataInstance)中调试该接口，支持自动认证鉴权。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dataartsstudio/abcd.html)。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
 
#### URI
- URI格式 POST /v2/{project_id}/factory/supplement-data
  

- 参数说明
  表1URI参数说明 
  | 参数名        | 是否必选 | 参数类型   | 说明                                                                                                    |
  |:---|:---|:---|:---|
  | project_id | 是    | String | 项目编号，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 |
     
  
 
#### 请求参数
表2请求Header参数 
| 参数名          | 是否必选 | 参数类型   | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| workspace    | 否    | String | 工作空间id。获取方法请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 - 如果不设置该参数，默认查询default工作空间下的数据。  - 如果需要查询其他工作空间的数据，需要带上该消息头。 说明： - 多个DataArts Studio实例需要指定工作空间。  - 当工作空间里面没有default工作空间时，工作空间为必填参数，否则会报错。      |
| X-Auth-Token | 是    | String | IAM Token 最小长度：**0** 最大长度：**4096**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| Content-Type | 是    | String | 发送的实体的MIME类型。 有Body体的情况下必选，无Body体的情况下则无需填写和校验。 示例：Content-Type: application/json;charset=UTF-8                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
   
表3Body参数说明 
| 参数名                           | 是否必选 | 参数类型           | 说明                                                                                               |
|:---|:---|:---|:---|
| 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\> | 参考[表4]。                                              |
| 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"，参考[表5]。 |
| supplement_data_instance_time | 否    | Object         | 支持补离散时间任务，参考[表6]。                                 |
   
 表4JobDTO参数说明 
| 参数名          | 是否必选 | 参数类型   | 说明                                                                                                           |
|:---|:---|:---|:---|
| job_name     | 否    | String | 作业名称。                                                                                                        |
| workspace_id | 否    | String | 工作空间ID。获取方法请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 |
   
 表5SupplementDataRunTime参数说明 
| 参数名          | 是否必选 | 参数类型   | 说明                                           |
|:---|:---|:---|:---|
| 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                 |
   
 表6SupplementDataInstanceTime参数说明 
| 参数名         | 是否必选 | 参数类型            | 说明        |
|:---|:---|:---|:---|
| 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."
  }
  ```
  
 
