任务操作

简介

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

基本操作

创建任务

功能说明

创建一个媒体处理任务。

方法原型

public MediaJobResponse createMediaJobs(MediaJobsRequest req);

参数说明

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

Container 类型 Input 的具体数据描述如下：

Container 类型 Operation 的具体数据描述如下：

注意：

优先使用 TemplateId，无 TemplateId 时使用对应任务类型的参数。

Container 类型 Animation 的具体数据描述如下：

Container 类型 Output 的具体数据描述如下：

返回结果说明

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

请求示例

//1.创建任务请求对象
MediaJobsRequest request = new MediaJobsRequest();
//2.添加请求参数 参数详情请见api接口文档
request.setBucketName("examplebucket-1250000000");
request.setTag("Transcode");
request.getInput().setObject("1.mp4");
request.getOperation().setTemplateId("t0e09a9456d4124542b1f0e44d501*****");
request.getOperation().getOutput().setBucket("examplebucket-1250000000");
request.getOperation().getOutput().setRegion("ap-chongqing");
request.getOperation().getOutput().setObject("2.mp4");
request.setQueueId("p9900025e4ec44b5e8225e70a52170834");
//3.调用接口,获取任务响应对象
MediaJobResponse response = client.createMediaJobs(request);

取消任务

功能说明

取消一个未在处理中的任务。

方法原型

public Boolean cancelMediaJob(MediaJobsRequest req);

参数说明

返回结果说明

• 成功： 返回一个布尔类型，成功则返回 true。
• 失败： 发生错误（如身份认证失败），抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理。

请求示例

MediaJobsRequest request = new MediaJobsRequest();
request.setBucketName("examplebucket-1250000000");
request.setJobId("jae776cb4ec3011eab2cdd3817d4*****");
Boolean response = client.cancelMediaJob(request);

查询任务

功能说明

根据任务 id 查询任务详情。

方法原型

public MediaJobResponse describeMediaJob(MediaJobsRequest req);

参数说明

返回结果说明

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

请求示例

//1.创建任务请求对象
MediaJobsRequest request = new MediaJobsRequest();
//2.添加请求参数 参数详情请见api接口文档
request.setBucketName("examplebucket-1250000000");
request.setJobId("j29a82fea08ba11ebb54bc9d1c05*****");
//3.调用接口,获取任务响应对象
MediaJobResponse response = client.describeMediaJob(request);

查询任务列表

功能说明

查询队列中的任务列表。

方法原型

public MediaListJobResponse describeMediaJobs(MediaJobsRequest cIMediaJobsRequest);   

参数说明

返回结果说明

• 成功： 返回一个任务集合响应实体。
• 失败： 发生错误（如身份认证失败），抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理。

请求示例

MediaJobsRequest request = new MediaJobsRequest();
request.setBucketName("examplebucket-1250000000");
request.setQueueId("p9900025e4ec44b5e8225e70a521*****");
request.setTag("Transcode");
MediaListJobResponse response = client.describeMediaJobs(request);
List<MediaJobObject> jobsDetail = response.getJobsDetail();