文档转码

简介

本文档提供关于文档预览的相关的 API 概览以及 SDK 示例代码。

提交文档预览任务

CreateDocProcessJobs 接口用于提交一个文档预览任务。

示例代码

   //1.创建任务请求对象
   DocJobRequest request = new DocJobRequest();
   //2.添加请求参数 参数详情请见api接口文档
   request.setBucketName("examplebucket-1250000000");
   DocJobObject docJobObject = request.getDocJobObject();
   docJobObject.setTag("DocProcess");
   docJobObject.getInput().setObject("demo.docx");
   docJobObject.setQueueId("pc02270c617ae4b6d9b0a52cb1c*****");
   DocProcessObject docProcessObject = docJobObject.getOperation().getDocProcessObject();
   docProcessObject.setQuality("100");
   docProcessObject.setZoom("100");
   docProcessObject.setStartPage("1");
   docProcessObject.setEndPage("3");
   docProcessObject.setTgtType("png");
   docProcessObject.setDocPassword("123");
   MediaOutputObject output = docJobObject.getOperation().getOutput();
   output.setRegion("ap-chongqing");
   output.setBucket("examplebucket-1250000000");
   output.setObject("mark/pic-${Page}.jpg");
   //3.调用接口,获取任务响应对象
   DocJobResponse docProcessJobs = client.createDocProcessJobs(request);
   System.out.println(docProcessJobs);

参数说明

DocJobRequest 类用于记录文档预览任务信息，其主要成员说明如下：

DocJobObject 类用于描述文档预览任务对象，其主要成员说明如下：

MediaInputObject 类用于待操作的文件对象 ，其主要成员说明如下：

DocOperationObject 类用于记录 操作规则 ，其主要成员说明如下：

DocProcessObject 类用于记录图片处理结果，其主要成员说明如下：

MediaOutputObject 类用于记录一个结果输出地址，其主要成员说明如下：

返回参数说明

DocJobResponse 类用于记录响应信息，其主要成员如下：

DocJobDetail 类用于记录任务的详细信息 ，其主要成员如下：

查询文档预览任务

DescribeDocProcessJob 用于查询指定的文档预览任务。

示例文档

//1.创建任务请求对象
DocJobRequest request = new DocJobRequest();
//2.添加请求参数 参数详情请见api接口文档
request.setBucketName("examplebucket-1250000000");
request.setJobId("d75b6ea083df711eb8d09476dfb8*****");
//3.调用接口,获取任务响应对象
DocJobResponse docJobResponse = client.describeDocProcessJob(request);
System.out.println(docJobResponse);

参数说明

DocJobRequest 类用于记录文档预览任务信息，其主要成员说明如下：

返回参数说明

DocJobResponse 类用于记录响应信息，其主要成员如下：

查询所有文档预览任务

DescribeDocProcessJobs 用于拉取符合条件的文档预览任务。

//1.创建任务请求对象
DocJobListRequest request = new DocJobListRequest();
//2.添加请求参数 参数详情请见api接口文档
request.setBucketName("examplebucket-1250000000");
request.setQueueId("pc02270c617ae4b6d9b0a52cb1c*****");
request.setTag("DocProcess");
request.setStartCreationTime("2020-12-10T16:20:07+0800");
//3.调用接口,获取任务响应对象
DocJobListResponse docJobResponse = client.describeDocProcessJobs(request);
for (DocJobDetail jobDetail : docJobResponse.getDocJobDetailList()) {
    System.out.println(jobDetail);
}

参数说明

DocJobListRequest 类用于记录文档预览任务信息，其主要成员说明如下：

返回参数说明

DocJobListResponse 类用于记录响应信息，其主要成员如下：