ResetWorkflow

1. API Description

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

This API is used to reset an existing workflow that is disabled.

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 of up to 128 characters, which must be unique for the same user.
Trigger	Yes	WorkflowTrigger	Triggering rule bound to a workflow. If an uploaded video hits the rule for the object, the workflow will be triggered.
OutputStorage	No	TaskOutputStorage	Output configuration of a video processing output file. If this parameter is left empty, the storage location in `Trigger` will be inherited.
OutputDir	No	String	Target directory of a video processing output file, such as `/movie/201907/`. If this parameter is left empty, the file will be outputted to the same directory where the source file is located, i.e.; `{inputDir}`.
MediaProcessTask	No	MediaProcessTaskInput	Parameter of a video processing task.
AiContentReviewTask	No	AiContentReviewTaskInput	Type parameter of a video content audit task.
AiAnalysisTask	No	AiAnalysisTaskInput	Video content analysis task parameter.
AiRecognitionTask	No	AiRecognitionTaskInput	Type parameter of a video content recognition task.
TaskPriority	No	Integer	Workflow priority. The higher the value, the higher the priority. Value range: [-10, 10]. If this parameter is left empty, 0 will be used.
TaskNotifyConfig	No	TaskNotifyConfig	Event notification information of a task. If this parameter is left empty, no event notifications will be obtained.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Resetting a transcoding rule

This example shows you how to reset the transcoding rule of the workflow whose ID is 2573 to add a watermark to the transcoding output.

Input Example

https://mps.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.