Creating a PatchData Instance
Function
This API is used to create a PatchData instance.
URI
- Parameter description
Parameter
Mandatory
Type
Description
project_id
Yes
String
Project ID. For details about how to obtain a project ID, see Project ID and Account ID.
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
workspace |
No |
String |
Workspace ID
|
|
X-Auth-Token |
Yes |
String |
IAM Token Minimum length: 0 Maximum length: 4096 |
|
Content-Type |
Yes |
String |
MIME type of the request body |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
Yes |
String |
Name of the PatchData job |
|
job_name |
Yes |
String |
Name of the job to which data is to be patched |
|
start_date |
Yes |
String |
Start time for the PatchData job, for example, 2023-08-21T00:00:00 +08 |
|
end_date |
Yes |
String |
End time for the PatchData job, for example, 2023-08-21T23:59:59 +08 |
|
parallel |
Yes |
int |
Number of parallel periods of the PatchData instance. The value ranges from 1 to 5. This parameter specifies the maximum number of PatchData instances that can be executed concurrently. The maximum number is 5. |
|
depend_jobs |
No |
List<JobDTO> |
See Table 3. |
|
is_day_granularity |
No |
Boolean |
Whether to patch data by day. The value can be true (yes) or false (no). |
|
priority |
No |
int |
Priority of the PatchData job. If system resources are insufficient, computing resources are preferentially allocated to jobs with higher priorities. A larger value indicates a higher priority. Priorities can be set only for DLI SQL operators. |
|
is_stop_when_fail |
No |
Boolean |
Whether to stop a PatchData job if it fails. The value can be true (yes) or false (no). |
|
reverse_order |
No |
int |
Whether to patch data in descending order of date. The value can be 0 (ascending order) or 1 (descending order). |
|
force |
No |
String |
Whether to forcibly patch data. The value true indicates that data can be forcibly patched, that is, if a job has two PatchData instances, data can still be patched. The value false indicates that data cannot be forcibly patched. |
|
supplement_data_run_time |
No |
Object |
PatchData time period. Currently, data can only be patched only every day. If this parameter is not specified, the default value 00:00-00:00 is used. For details, see Table 4. |
|
supplement_data_instance_time |
No |
Object |
Discrete time for the PatchData job. For details, see Table 5. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
job_name |
No |
String |
Job name |
|
workspace_id |
No |
String |
Workspace ID |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
time_of_day |
No |
String |
Time period for patching data every day, for example, 10:15-23:30. |
|
day_of_week |
No |
String |
Days of each week for patching data, for example, 10:15 to 23:30 on Monday and Wednesday |
|
day_of_month |
No |
String |
Days in each month for patching data, for example, 1,3 which indicates the first and third day in each month |
Response Parameters
None.
Example Request
Create a PatchData instance named P_job_6796_20230823_9991 which depends on 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"
}
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
