同步请求接口

最近更新时间:2023-05-16 16:32:05

我的收藏

简介

本文档提供关于文档预览同步请求的 API 概览以及 SDK 示例代码。
API
说明
用于同步请求文档预览功能

同步请求接口

功能说明

文档转码同步请求,获取文档转码的请求 URL。

示例代码

function getDocPreview() {
var config = {
// 需要替换成您自己的存储桶信息
Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */
Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */
};
cos.getObject({
Bucket: config.Bucket, // Bucket 格式:test-1250000000
Region: config.Region,
Key: '文档.docx',
Query: {
'ci-process': 'doc-preview', /* 必须,数据万象处理能力,文档预览固定为 doc-preview */
// srcType: '', /* 非必须,源数据的后缀类型,当前文档转换根据 COS 对象的后缀名来确定源数据类型。当 COS 对象没有后缀名时,可以设置该值 */
// page: '', /* 非必须,需转换的文档页码,默认从1开始计数;表格文件中 page 表示转换的第 X 个 sheet 的第 X 张图t*/
// dstType: '', /* 非必须,转换输出目标文件类型 */
},
DataType: 'blob',
}, function(err, data) {
if (err) {
console.log(err);
} else {
// Body为转码后的内容 可展示在img里 比如
var body = data.Body;
const url = URL.createObjectURL(body);
const img = document.getElementById('image');
img.src = url;
// 获取总页数(需要在跨域配置的Expose-Headers配置需要暴露出的头部 比如下方的X-Total-Page)
// 跨域配置可参考文档 https://cloud.tencent.com/document/product/436/13318
var totalPage = data.headers['X-Total-Page'];
}
});
}
getDocPreview();

参数说明

参数名称
描述
类型
Key
对象文件名,例如 folder/document.pdf
String
srcType
源数据的后缀类型,当前文档转换根据 COS 对象的后缀名来确定源数据类型
当 COS 对象没有后缀名时,可以设置该值
String
page
需转换的文档页码,默认从1开始计数
表格文件中 page 表示转换的第 x 个 sheet 的第 x 张图
int
ImageParams
转换后的图片处理参数,支持 基础图片处理 所有处理参数,多个处理参数可通过 管道操作符 分隔,从而实现在一次访问中按顺序对图片进行不同处理
String
sheet
表格文件参数,转换第 x 个表,默认为1
int
dstType
转换输出目标文件类型
png 表示转换成 png 格式的图片文件
jpg 表示转换成 jpg 格式的图片文件
pdf 表示转换成 pdf 格式的图片文件
如果传入的格式未能识别,默认使用 jpg 格式
String
password
Office 文档的打开密码,如果需要转换有密码的文档,请设置该字段
String
comment
是否隐藏批注和应用修订,默认为 0
0:隐藏批注,应用修订
1:显示批注和修订
int
excelPaperDirection
表格文件转换纸张方向,0代表垂直方向,非0代表水平方向,默认为0
int
quality
生成预览图的图片质量,取值范围:[1-100],默认值100
例如:值为100,代表生成图片质量为100%
int
zoom
预览图片的缩放参数,取值范围:[10-200], 默认值100
例如:值为200,代表图片缩放比例为200%,即放大两倍
int

返回结果说明

function(err, data) { ... }
参数名
参数描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误。如果请求成功则为空,详情请参见 错误码 文档
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
- RequestId
请求的唯一 ID
String
- Url
文档预览的 Url
String