1. API Description
Domain name for API request: wedata.intl.tencentcloudapi.com.
This API is used to update task scheduling information under a workflow.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name |
Required |
Type |
Description |
| Action |
Yes |
String |
Common Params. The value used for this API: RenewWorkflowSchedulerInfoDs. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2021-08-20. |
| Region |
Yes |
String |
Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-singapore, eu-frankfurt, na-ashburn, na-siliconvalley. |
| ProjectId |
Yes |
String |
Project ID |
| WorkflowId |
Yes |
String |
Workflow ID |
| DelayTime |
No |
Integer |
Delay Time |
| StartupTime |
No |
Integer |
Start Time |
| SelfDepend |
No |
String |
Task Dependency |
| StartTime |
No |
String |
Start Time |
| EndTime |
No |
String |
End Time |
| TaskAction |
No |
String |
Specified Running Time |
| CycleType |
No |
String |
Scheduling Cycle Time Unit |
| CycleStep |
No |
Integer |
Scheduling Cycle |
| ExecutionStartTime |
No |
String |
Execution Time Left Closed Interval |
| ExecutionEndTime |
No |
String |
Execution Time Right Closed Interval |
| InstanceInitStrategy |
No |
String |
Task initialization strategy. valid values: T_PLUS_1, T_PLUS_0, T_MINUS_1 |
| DependencyWorkflow |
No |
String |
Workflow dependency. valid values: yes or no |
| CrontabExpression |
No |
String |
CrontabExpression |
| ModifyCycleValue |
No |
String |
0: Do not modify 1: Change the upstream dependency configuration of the task to the default value |
| CalendarOpen |
No |
String |
Whether calendar scheduling is enabled. 1 means enabled, and 0 means disabled. |
| CalendarName |
No |
String |
Calendar name. |
| CalendarId |
No |
String |
Calendar id. |
| ScheduleTimeZone |
No |
String |
Specifies the time zone. |
| ClearLink |
No |
Boolean |
Whether to automatically clean up links to unsupported tasks. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| Data |
BatchResultDs |
Data
Note: This field may return null, indicating that no valid values can be obtained. |
| RequestId |
String |
The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Example 1
demo
POST / HTTP/1.1
Host: wedata.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RenewWorkflowSchedulerInfoDs
<Common request parameters>
{
"ProjectId": "1460947878944567296",
"WorkflowId": "e5b0945c-ed6d-11ed-8909-bc97e105ba60",
"DelayTime": 0,
"SelfDepend": "serial",
"StartTime": "2023-05-13 12:44:29",
"EndTime": "2023-05-12 23:59:59",
"TaskAction": "",
"CycleType": "DAY_CYCLE",
"CycleStep": 1
}
Output Example
{
"Response": {
"Data": {
"Failed": 0,
"Success": 0,
"Total": 0
},
"RequestId": "59a4462b-66f3-4cc2-80a2-46c416726c46"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code |
Description |
| FailedOperation |
Operation Failure. |