tencent cloud

Overview

This document provides an overview of APIs and SDK code samples for media processing workflows in CI, with the animated image job as an example.

Deleting Workflow

Feature description

This API is used to delete a workflow.

Method prototype

public Boolean deleteWorkflow(MediaWorkflowListRequest request);

Parameter description

Request has the following sub-nodes:

Response description

• Success: true is returned upon success.
• Failure: An error (such as the bucket does not exist) occurs, throwing the CosClientException or CosServiceException exception. For more information, see Troubleshooting.

Sample request

//1. Create a workflow request object
MediaWorkflowListRequest request = new MediaWorkflowListRequest();
//2. Add request parameters as detailed in the API documentation
request.setBucketName("examplebucket-1250000000");
request.setWorkflowId("aaaa");
Boolean response = client.deleteWorkflow(request);

Querying Workflow

Feature description

This API is used to search for a workflow.

Method prototype

public MediaWorkflowListResponse describeWorkflow(MediaWorkflowListRequest request);

Parameter description

Response description

• Success: A workflow set response object is returned, which contains the workflow object set.
• Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, see Troubleshooting.

Sample request

//1. Create a workflow request object
MediaWorkflowListRequest request = new MediaWorkflowListRequest();
//2. Add request parameters as detailed in the API documentation
request.setBucketName("examplebucket-1250000000");
MediaWorkflowListResponse response = client.describeWorkflow(request);
List<MediaWorkflowObject> mediaWorkflowList = response.getMediaWorkflowList();

Querying Workflow Instance Details

Feature description

This API is used to query the details of a workflow instance.

Method prototype

public MediaWorkflowExecutionResponse describeWorkflowExecution(MediaWorkflowListRequest request);

Parameter description

Response description

• Success: A workflow instance response wrapper class is returned, which contains the workflow instance details object.
• Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, see Troubleshooting.

Sample request

//1. Create a workflow request object
MediaWorkflowListRequest request = new MediaWorkflowListRequest();
//2. Add request parameters as detailed in the API documentation
request.setBucketName("examplebucket-1250000000");
request.setRunId("i34bfd8d7eae711ea89fe525400c******");
MediaWorkflowExecutionResponse response = client.describeWorkflowExecution(request);

Querying Workflow Details List

Feature description

This API is used to query the list of workflow details.

Method prototype

public MediaWorkflowExecutionsResponse describeWorkflowExecutions(MediaWorkflowListRequest request);   

Parameter description

Response description

• Success: A workflow instance set response object is returned, which contains the workflow object instance set.
• Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, see Troubleshooting.

Sample request

//1. Create a workflow request object
MediaWorkflowListRequest request = new MediaWorkflowListRequest();
//2. Add request parameters as detailed in the API documentation
request.setBucketName("examplebucket-1250000000");
request.setWorkflowId("w4e6963a18e2446ed8bc8f09410e******");
MediaWorkflowExecutionsResponse response = client.describeWorkflowExecutions(request);
List<MediaWorkflowExecutionObject> workflowExecutionList = response.getWorkflowExecutionList();

Manually Triggering Workflow

Feature description

This API is used to manually trigger a workflow.

Method prototype

public MediaWorkflowListResponse triggerWorkflowList(MediaWorkflowListRequest request);   

Sample request

//1. Create a workflow request object
MediaWorkflowListRequest request = new MediaWorkflowListRequest();
//2. Add request parameters as detailed in the API documentation
request.setBucketName("DemoBucket-123456789");
request.setWorkflowId("we32f75950afe4a4682463d8158d*****");
request.setObject("1.mp4");
MediaWorkflowListResponse response = client.triggerWorkflowList(request);

Parameter description

Response description

• Success: The MediaWorkflowListResponse instance is returned.
• Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, see Troubleshooting.