tencent cloud

简介

本文档提供关于数据万象媒体处理工作流的相关 API 概览以及 SDK 示例代码，此处以动图任务举例。

删除工作流

功能说明

删除一个工作流。

方法原型

public Boolean deleteWorkflow(MediaWorkflowListRequest request);

参数说明

Request中的具体数据描述如下：

返回结果说明

• 成功：成功则返回 true。
• 失败：发生错误（如 Bucket 不存在），抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理。

请求示例

//1.创建工作流请求对象
MediaWorkflowListRequest request = new MediaWorkflowListRequest();
//2.添加请求参数 参数详情请见api接口文档
request.setBucketName("examplebucket-1250000000");
request.setWorkflowId("aaaa");
Boolean response = client.deleteWorkflow(request);

查询工作流

功能说明

用于搜索工作流。

方法原型

public MediaWorkflowListResponse describeWorkflow(MediaWorkflowListRequest request);

参数说明

返回结果说明

• 成功： 返回工作流集合响应对象，其中包含一个工作流对象集合。
• 失败： 发生错误（如身份认证失败），抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理。

请求示例

//1.创建工作流请求对象
MediaWorkflowListRequest request = new MediaWorkflowListRequest();
//2.添加请求参数 参数详情请见api接口文档
request.setBucketName("examplebucket-1250000000");
MediaWorkflowListResponse response = client.describeWorkflow(request);
List<MediaWorkflowObject> mediaWorkflowList = response.getMediaWorkflowList();

查询工作流实例详情

功能说明

查询工作流实例详情。

方法原型

public MediaWorkflowExecutionResponse describeWorkflowExecution(MediaWorkflowListRequest request);

参数说明

返回结果说明

• 成功： 返回工作流实例响应包装类，类中包含一个工作流实例详情对象。
• 失败： 发生错误（如身份认证失败），抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理。

请求示例

//1.创建工作流请求对象
MediaWorkflowListRequest request = new MediaWorkflowListRequest();
//2.添加请求参数 参数详情请见api接口文档
request.setBucketName("examplebucket-1250000000");
request.setRunId("i34bfd8d7eae711ea89fe525400c******");
MediaWorkflowExecutionResponse response = client.describeWorkflowExecution(request);

查询工作流详情列表

功能说明

查询工作流详情列表。

方法原型

public MediaWorkflowExecutionsResponse describeWorkflowExecutions(MediaWorkflowListRequest request);   

参数说明

返回结果说明

• 成功： 返回工作流实例集合响应对象，其中包含一个工作流对象实例集合。
• 失败： 发生错误（如身份认证失败），抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理。

请求示例

//1.创建工作流请求对象
MediaWorkflowListRequest request = new MediaWorkflowListRequest();
//2.添加请求参数 参数详情请见api接口文档
request.setBucketName("examplebucket-1250000000");
request.setWorkflowId("w4e6963a18e2446ed8bc8f09410e******");
MediaWorkflowExecutionsResponse response = client.describeWorkflowExecutions(request);
List<MediaWorkflowExecutionObject> workflowExecutionList = response.getWorkflowExecutionList();

手动触发工作流

功能说明

用于手动触发工作流。

方法原型

public MediaWorkflowListResponse triggerWorkflowList(MediaWorkflowListRequest request);   

请求示例

//1.创建工作流请求对象
MediaWorkflowListRequest request = new MediaWorkflowListRequest();
//2.添加请求参数 参数详情请见api接口文档
request.setBucketName("DemoBucket-123456789");
request.setWorkflowId("we32f75950afe4a4682463d8158d*****");
request.setObject("1.mp4");
MediaWorkflowListResponse response = client.triggerWorkflowList(request);

参数说明

返回结果说明

• 成功： 返回 MediaWorkflowListResponse 实例。
• 失败： 发生错误（如身份认证失败），抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理。