tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyWorkflowSchedule

Last updated: 2024-06-21 15:10:05

1. API Description

Domain name for API request: wedata.tencentcloudapi.com.

Update Workflow Scheduling

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.

2. Input Parameters

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: ModifyWorkflowSchedule.
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.
ProjectId Yes String Project ID
WorkflowId Yes String Workflow ID
DelayTime Yes Integer Delay time, in minutes
StartupTime Yes Integer Start Time
SelfDepend Yes Integer Self-Dependency Type 1: Sequential serial, one at a time, queued, 2: Unordered serial, one at a time, not queued, 3: Parallel, multiple at once
CycleType Yes Integer "Cycle Type 0:crontab, 1:Minute,2:Hour,3:Day,4:Week,5:Month,6:One-time,7:User driven,10:Flexible cycle Week,11:Flexible cycle Month,12:Year,13:Immediate Trigger Instant type, isolated from normal cycle scheduling task logic
CycleStep Yes Integer Step Length, Interval Time, minimum of 1
StartTime No String Effective Start Time, format yyyy-MM-dd HH:mm:ss
EndTime No String Effective End Time, format yyyy-MM-dd HH:mm:ss
TaskAction No String Scheduling Configuration - Elastic Cycle Configuration, applicable to Hourly/Weekly/Monthly/Yearly schedules. For hourly tasks scheduled at 0, 3, 4 o'clock, it would be '0,3,4'.
CrontabExpression No String Cron Expression is required only for Cron Tab Scheduling
ExecutionStartTime No String Execution Time Left Closed Interval, format: HH:mm. Applicable only to hourly scheduling. For example, for hourly tasks, it specifies the effective interval every day
ExecutionEndTime No String Execution Time Right Closed Interval, format: HH:mm. Applicable only to hourly scheduling. For example, for hourly tasks, it specifies the effective interval every day
DependencyWorkflow No String Workflow Dependency, yes or no

3. Output Parameters

Parameter Name Type Description
Data BatchResult Execution Result
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 Update Workflow Scheduling Example 1

Update Workflow Scheduling

Input Example

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyWorkflowSchedule
<Common request parameters>

{
    "WorkflowId": "34e51bc4-0cd9-11ed-89e105ba60",
    "StartupTime": "47483648",
    "SelfDepend": "1",
    "ProjectId": "1",
    "ExecutionEndTime": "",
    "TaskAction": "",
    "DelayTime": "1",
    "DependencyWorkflow": "no",
    "StartTime": "2022-03-03 11:12:59",
    "ExecutionStartTime": "",
    "EndTime": "2022-09-03 11:12:59",
    "CycleType": "1",
    "CycleStep": "3",
    "CrontabExpression": ""
}

Output Example

{
    "Response": {
        "RequestId": "dc5397bb-74e6f734102c",
        "Data": {
            "Running": 0,
            "Success": 0,
            "Failed": 0,
            "Total": 0
        }
    }
}

Example2 Update Workflow Scheduling Example 2

Update Workflow Scheduling

Input Example

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyWorkflowSchedule
<Common request parameters>

{
    "WorkflowId": "34e51bc4-0cd9-1105ba60",
    "StartupTime": "47483648",
    "SelfDepend": "1",
    "ProjectId": "1",
    "ExecutionEndTime": "",
    "TaskAction": "",
    "DelayTime": "1",
    "DependencyWorkflow": "no",
    "StartTime": "2022-03-03 11:12:59",
    "ExecutionStartTime": "",
    "EndTime": "2022-09-03 11:12:59",
    "CycleType": "1",
    "CycleStep": "3",
    "CrontabExpression": ""
}

Output Example

{
    "Response": {
        "RequestId": "c20f7fea-d73f-44cd-94a5-1d9f884df5cf",
        "Data": {
            "Running": 0,
            "Success": 0,
            "Failed": 0,
            "Total": 0
        }
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy