简介
本文档提供关于文档预览任务接口的 API 概览以及 SDK 示例代码。
API | 说明 |
用于提交一个文档预览任务 | |
用于查询指定的文档预览任务 | |
用于拉取符合条件的文档预览任务 |
提交文档预览任务
功能说明
用于提交一个文档预览任务。
示例代码
function createDocProcessJobs() {var config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */};var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com/doc_jobs';var url = 'https://' + host;var body = COS.util.json2xml({Request: {Tag: 'DocProcess',Input: {Object: 'test.docx', // 存在cos里的路径},Operation: {DocProcess: {TgtType: 'jpg',},Output: {Bucket: config.Bucket,Region: config.Region,Object: '1/文档转码_${Number}.jpg', // 转码后存到cos的路径},},}});cos.request({Method: 'POST',Key: 'doc_jobs',Url: url,Body: body,ContentType: 'application/xml',},function(err, data){console.log(err || data);});}createDocProcessJobs();
参数说明
Request 中的具体数据描述如下:
Input 中的具体数据描述如下:
参数名称 | 类型 | 描述 | 是否必填 |
Object | String | 文件在 COS 上的文件路径,Bucket 由 Host 指定 | 是 |
Operation 中的具体数据描述如下:
参数名称 | 类型 | 描述 | 是否必填 |
DocProcess | Array | 当 Tag 为 DocProcess 时有效,指定该任务的参数 | 是 |
Output | Array | 结果输出地址 | 是 |
DocProcess 中的具体数据描述如下:
参数名称 | 类型 | 描述 | 是否必填 |
srcType | String | 源数据的后缀类型,当前文档转换根据 cos 对象的后缀名来确定源数据类型,当 cos 对象没有后缀名时,可以设置该值 | 否 |
tgtType | String | 转换输出目标文件类型: jpg,转成 jpg 格式的图片文件;如果传入的格式未能识别,默认使用 jpg 格式 png,转成 png 格式的图片文件 pdf,转成 pdf 格式文件(暂不支持指定页数) | 否 |
sheetId | Integer | 表格文件参数,转换第 X 个表,默认为1;设置 SheetId 为0,即转换文档中全部表 | 否 |
startPage | Integer | 从第 X 页开始转换;在表格文件中,一张表可能分割为多页转换,生成多张图片。StartPage 表示从指定 SheetId 的第 X 页开始转换。默认为1 | 否 |
endPage | Integer | 转换至第 X 页;在表格文件中,一张表可能分割为多页转换,生成多张图片。EndPage 表示转换至指定 SheetId 的第 X 页。默认为-1,即转换全部页 | 否 |
imageParams | String | 否 | |
docPassword | String | Office 文档的打开密码,如果需要转换有密码的文档,请设置该字段 | 否 |
comments | Integer | 是否隐藏批注和应用修订,默认为 0;0:隐藏批注,应用修订;1:显示批注和修订 | 否 |
paperDirection | Integer | 表格文件转换纸张方向,0代表垂直方向,非0代表水平方向,默认为0 | 否 |
quality | Integer | 生成预览图的图片质量,取值范围 [1-100],默认值100。 例:值为100,代表生成图片质量为100% | 否 |
zoom | Integer | 预览图片的缩放参数,取值范围[10-200], 默认值100。 例:值为200,代表图片缩放比例为200% 即放大两倍 | 否 |
Output 中的具体数据描述如下:
参数名称 | 类型 | 描述 | 是否必填 |
Region | String | 存储桶的地域 | 是 |
Bucket | String | 存储结果的存储桶 | 是 |
Object | String | 输出文件路径 | 是 |
返回结果说明
查询指定文档预览任务
功能说明
用于查询指定的文档预览任务。
示例代码
function describeDocProcessJob() {var config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */};var jobId = 'd622ab912ebdb11ed9baf0316d5139xxx'; // 替换成自己的jogIdvar host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com/doc_jobs/' + jobId;var url = 'https://' + host;cos.request({Method: 'GET',Key: 'doc_jobs/' + jobId,Url: url,},function(err, data){console.log(err || data);});}describeDocProcessJob();
参数说明
参数名称 | 描述 | 类型 |
jobId | 文档预览任务 ID | String |
返回结果说明
拉取符合条件的文档预览任务
功能说明
用于拉取符合条件的文档预览任务。
示例代码
function describeDocProcessJobs() {var config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */};var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com/doc_jobs';var url = 'https://' + host;cos.request({Method: 'GET',Key: 'doc_jobs',Url: url,Query: {tag: 'DocProcess',},},function(err, data){console.log(err || data);});}describeDocProcessJobs();
参数说明
参数名称 | 描述 | 类型 |
queueId | String | |
tag | 任务的 Tag:DocProcess | String |
orderByTime | Desc 或者 Asc。默认为 Desc | String |
nextToken | 请求的上下文,用于翻页。上次返回的值 | String |
size | 拉取的最大任务数。默认为10,最大值为100 | Int |
states | 拉取该状态的任务,以 , 分割,支持多状态:All、Submitted、Running、Success、Failed、Pause、Cancel。默认为 All | String |
startCreationTime | 拉取创建时间大于该时间的任务。格式为: %Y-%m-%dT%H:%m:%S%z | String |
endCreationTime | 拉取创建时间小于该时间的任务。格式为: %Y-%m-%dT%H:%m:%S%z | String |