tencent cloud

数据万象

动态与公告
产品动态
产品公告
产品简介
产品概述
产品优势
应用场景
功能概览
地域与域名
使用限制
产品计费
计费概述
计费方式
计费项
免费额度
欠费说明
查看消费明细
常见问题
快速入门
注册与登录
绑定存储桶
上传和处理文件
下载和删除文件
解绑存储桶
通过 COS 使用数据万象
能力地图
图片处理
媒体处理
内容审核
AI 内容识别
文档处理
智能语音
文件处理
用户指南
概览
存储桶管理
智能工具箱
任务与工作流
数据监控
用量统计
实践教程
版权保护解决方案
图片处理实践
API 授权策略使用指引
工作流实践
API 文档
API 概览
结构体
公共请求头部
公共响应头部
开通万象服务
图片处理
AI 内容识别
智能语音
媒体处理
内容审核
文档处理
文件处理
任务与工作流
云查毒
错误码
请求签名
SDK 文档
SDK 概览
图片处理 Android SDK
图片处理 iOS SDK
COS Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Go SDK
COS iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
小程序 SDK
SDK 产品个人信息保护规则
安全与合规
权限管理
常见问题
基础设置
文档处理
媒体处理
内容识别
智能语音
服务协议
Service Level Agreement
联系我们
词汇表

工作流操作

PDF
聚焦模式
字号
最后更新时间: 2024-03-13 10:07:11

简介

本文档提供关于数据万象媒体处理工作流的相关 API 概览以及 SDK 示例代码,此处以动图任务举例。
API
操作名
操作描述
删除工作流
删除一个工作流
查询工作流
查询一个工作流
查询工作流实例详情
查询一个工作流实例详情
查询工作流详情列表
获取工作流实例列表
触发工作流
工作流执行

删除工作流

功能说明

删除一个工作流。

方法原型

public Boolean deleteWorkflow(MediaWorkflowListRequest request);

参数说明

Request中的具体数据描述如下:
节点名称(关键字)
描述
类型
必选
bucketName
Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述
String
workflowId
工作流 ID
String

返回结果说明

成功:成功则返回 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);

参数说明

参数名称
描述
类型
必选
bucketName
Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述
String
ids
工作流 ID,以,符号分割字符串
String
name
工作流名称
String
pageNumber
第几页
String
pageSize
每页个数
String

返回结果说明

成功: 返回工作流集合响应对象,其中包含一个工作流对象集合。
失败: 发生错误(如身份认证失败),抛出异常 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);

参数说明

参数名称
描述
类型
必选
bucketName
Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述
String
runId
工作流实例 ID
String

返回结果说明

成功: 返回工作流实例响应包装类,类中包含一个工作流实例详情对象。
失败: 发生错误(如身份认证失败),抛出异常 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);

参数说明

节点名称
描述
类型
必选
bucketName
Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述
String
workflowId
工作流 ID
String
name
文件名称
String
orderByTime
Desc 或者 Asc。默认为 Desc
String
size
拉取的最大任务数。默认为10。最大为100
String
states
工作流实例状态,以,分割支持多状态 All,Success,Failed,Running,Cancel。默认为 All
String
startCreationTime
拉取创建时间大于该时间。格式为:%Y-%m-%dT%H:%m:%S%z
String
endCreationTime
拉取创建时间小于该时间。格式为:%Y-%m-%dT%H:%m:%S%z
String
nextToken
请求的上下文,用于翻页。下一页输入 token
String

返回结果说明

成功: 返回工作流实例集合响应对象,其中包含一个工作流对象实例集合。
失败: 发生错误(如身份认证失败),抛出异常 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);

参数说明

节点名称
描述
类型
必选
bucketName
Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述
String
object
需要进行工作流处理的对象名称
String
workflowId
需要触发的工作流 ID
String
name
存量触发任务名称,支持中文、英文、数字、—和_,长度限制128字符,默认为空
String

返回结果说明

成功: 返回 MediaWorkflowListResponse 实例。
失败: 发生错误(如身份认证失败),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈