ResetWorkflow

Last updated: 2020-01-13 11:39:08

    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.

    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 parameter. The value used for this API: ResetWorkflow
    Version Yes String Common parameter. The value used for this API: 2019-06-12
    Region No String Common parameter. 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
    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

    Input Example

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

    Output Example

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

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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.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.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help