ResetWorkflow

Last updated: 2026-08-12 19:13:30Download PDF

1. API Description

Domain name for API request: mps.intl.tencentcloudapi.com.

This API is used to reset a workflow that already exists and is in disable status.

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: ResetWorkflow.
Version	Yes	String	Common Params. The value used for this API: 2019-06-12.
Region	No	String	Common Params. This parameter is not required for this API.
WorkflowId	Yes	Integer	Workflow ID.
WorkflowName	Yes	String	Workflow name, up to 128 characters. The name is unique for the same user.
Trigger	Yes	WorkflowTrigger	The trigger rule bound to the workflow triggers the workflow when an uploaded video hits the rule for the object.
OutputStorage	No	TaskOutputStorage	Video processing output configuration. If left blank, it inherits the storage location from Trigger.
OutputDir	No	String	The target directory for the output files generated by video processing. It must start and end with a slash (/), such as `/movie/201907/`. If left empty, it is the same as the directory of the trigger file, that is, `{inputDir}`.
MediaProcessTask	No	MediaProcessTaskInput	Parameters for the video processing task.
AiContentReviewTask	No	AiContentReviewTaskInput	Parameters for the video content review task.
AiAnalysisTask	No	AiAnalysisTaskInput	Parameters for the video content analysis task.
AiRecognitionTask	No	AiRecognitionTaskInput	Parameters for the video content recognition task.
TaskPriority	No	Integer	Priority of the workflow. The higher the value, the higher the priority. The value range is from -10 to 10. If left blank, the default value is 0.
TaskNotifyConfig	No	TaskNotifyConfig	Event notification information of the task. If it is left unspecified, it indicates that no event notification is obtained.

3. Output Parameters

Parameter Name	Type	Description
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 Resetting a transcoding rule

Reset the transcoding rule for workflow ID 2573 and add a watermark to the transcoding output.

Input Example

https://mps.intl.tencentcloudapi.com/?Action=ResetWorkflow
&WorkflowId=2573
&WorkflowName=trans-100020-100030-100040
&Trigger.Type=CosFileUpload
&Trigger.CosFileUploadTrigger.Bucket=TopRankVideo-125xxx88
&Trigger.CosFileUploadTrigger.Region=ap-chongqing
&Trigger.CosFileUploadTrigger.Dir=/movie/201907/
&MediaProcessTask.TranscodeTaskSet.0.Definition=100020
&MediaProcessTask.TranscodeTaskSet.0.WatermarkSet.0.Definition=12580
&MediaProcessTask.TranscodeTaskSet.1.Definition=100030
&MediaProcessTask.TranscodeTaskSet.1.WatermarkSet.0.Definition=12580
&MediaProcessTask.TranscodeTaskSet.2.Definition=100040
&MediaProcessTask.TranscodeTaskSet.2.WatermarkSet.0.Definition=12580
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3"
    }
}

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

Tencent Cloud CLI 3.0

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.InvalidMpsUser	Operation failed: unauthorized MPS user.
InternalError	Internal error.
InvalidParameterValue	Incorrect parameter value.
ResourceNotFound.TemplateNotExist	The resource does not exist: the template does not exist.