Domain name for API request: mps.tencentcloudapi.com.
This API is used to set a processing rule for media files uploaded to the specified directory of a COS bucket, including:
Note: Once successfully created, a workflow is disabled by default and needs to be enabled manually.
A maximum of 200 requests can be initiated per second for this API.
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: CreateWorkflow. |
| 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. |
| 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 | Storage location 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. |
| 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. |
| TaskNotifyConfig | No | TaskNotifyConfig | Event notification configuration for a task. If this parameter is left empty, no event notifications will be obtained. |
| 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. |
| Parameter Name | Type | Description |
|---|---|---|
| WorkflowId | Integer | Workflow ID. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to set a transcoding rule named "trans-20-30-40" for the TopRankVideo-125xxx88 bucket to output in three formats of 20, 30, and 40.
https://mps.tencentcloudapi.com/?Action=CreateWorkflow
&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.TranscodeTaskSet.1.Definition=30
&MediaProcessTask.TranscodeTaskSet.2.Definition=40
&<Public request parameter>{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"WorkflowId": 157482
}
}This example shows you how to set a transcoding rule named "snapshot" for the TopRankVideo-125xxx88 bucket to output in the specification of 10.
https://mps.tencentcloudapi.com/?Action=CreateWorkflow
&WorkflowName=snapshot
&Trigger.Type=CosFileUpload
&Trigger.CosFileUploadTrigger.Bucket=TopRankVideo-125xxx88
&Trigger.CosFileUploadTrigger.Region=ap-chongqing
&Trigger.CosFileUploadTrigger.Dir=/movie/201907/
&MediaProcessTask.SampleSnapshotTaskSet.0.Definition=10
&<Public request parameter>{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"WorkflowId": 3457482
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.CosStatusInavlid | Operation failed: COS service is suspended. |
| FailedOperation.InvalidMpsUser | Operation failed: unauthorized MPS user. |
| InternalError | Internal error. |
| InvalidParameterValue | Incorrect parameter value. |
| LimitExceeded.TooMuchTemplate | Limit reached: the number of templates exceeds the limit. |
| ResourceNotFound.CosBucketNameInvalid | The resource does not exist: invalid COS bucket name. |
| ResourceNotFound.CosBucketNotExist | The resource does not exist: the COS bucket does not exist. |
Was this page helpful?