History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
GET /<ObjectKey>?ci-process=doc-preview&page=<page>&srcType=<srcType>&ImageParams=<ImageParams> HTTP/1.1Host: <BucketName-APPID>.cos.<Region>.myqcloud.comDate: GMT DateAuthorization: Auth String
名称 | 描述 | 类型 | 是否必选 |
ObjectKey | 对象文件名，例如 folder/document.pdf | String | 是 |
ci-process | 数据万象处理能力，文档预览固定为 doc-preview | String | 是 |
srcType | 源数据的后缀类型，当前文档转换根据 COS 对象的后缀名来确定源数据类型。当 COS 对象没有后缀名时，可以设置该值 | String | 否 |
page | 需转换的文档页码，默认从1开始计数；表格文件中 page 表示转换的第 X 个 sheet 的第 X 张图 | Int | 否 |
dstType | 转换输出目标文件类型： png，转成 png 格式的图片文件 jpg，转成 jpg 格式的图片文件 pdf，转成 pdf 格式文件。 无法选择页码，page 参数不生效 如果传入的格式未能识别，默认使用 jpg 格式 | String | 否 |
password | Office 文档的打开密码，如果需要转换有密码的文档，请设置该字段 | String | 否 |
comment | 是否隐藏批注和应用修订，默认为0 0：隐藏批注，应用修订 1：显示批注和修订 | Int | 否 |
名称 | 描述 | 类型 | 是否必选 |
sheet | 表格文件参数，转换第 X 个表，默认为1 | Int | 否 |
excelPaperDirection | 表格文件转换纸张方向，0代表垂直方向，非0代表水平方向，默认为0 | Int | 否 |
excelPaperSize | 设置纸张（画布）大小，对应信息为： 0 → A4 、 1 → A2 、 2 → A0 ，默认 A4 纸张 （需配合 excelRow 或 excelCol 一起使用） | Int | 否 |
名称 | 描述 | 类型 | 是否必选 |
ImageParams | String | 否 | |
quality | 生成预览图的图片质量，取值范围为 [1, 100]，默认值100。 例如取值为100，代表生成图片质量为100% | Int | 否 |
scale | 预览图片的缩放参数，取值范围为 [10, 200]， 默认值100。 例如取值为200，代表图片缩放比例为200% 即放大两倍 | Int | 否 |
imageDpi | 按指定 dpi 渲染图片，该参数与 scale 共同作用，取值范围 96-600 ，默认值为 96 。转码后的图片单边宽度需小于65500像素 | Int | 否 |
参数名称 | 描述 | 类型 |
X-Total-Page | 在 http header 中返回文档总页数（表格文件表示当前 sheet 转换后的总图片数），异常时为空 | Int |
Content-Type | 根据图片实际的格式，返回不同的值，例如 image/jpeg、image/webp，异常时保持现有值即可 | String |
X-ErrNo | 当异常时返回错误码，可在 http header 中查看 | String |
X-Total-Sheet | 表格文件返回参数，在 http header 中返回文档中总表数 | Int |
X-Sheet-Name | 表格文件返回参数，在 http header 中返回当前 sheet 名 | String |
GET /sample.pdf?ci-process=doc-preview&page=1 HTTP/1.1Host: examplebucket-1250000000.cos.ap-shanghai.myqcloud.com
HTTP/1.1 200 OKContent-Type: image/jpegContent-Length: 645Date: Tue, 03 Apr 2018 09:06:16 GMTX-Total-Page: 100[转码后图片 data]
HTTP/1.1 404 OKConnection: closeContent-Length: 455Content-Type: application/xmlDate: Thu, 09 Apr 2020 13:44:52 GMTX-ErrNo: -3004
HTTP/1.1 404 OKConnection: closeContent-Length: 455Content-Type: application/xmlDate: Thu, 09 Apr 2020 13:44:52 GMTX-ErrNo: -3013
GET /sample.pdf?ci-process=doc-preview&page=1&ImageParams=imageMogr2/thumbnail/!50p|watermark/2/text/5pWw5o2u5LiH6LGh/fill/I0ZGRkZGRg==/fontsize/30/dx/20/dy/20 HTTP/1.1Host: examplebucket-1250000000.cos.ap-shanghai.myqcloud.com
HTTP/1.1 200 OKContent-Type: image/jpegContent-Length: 645Date: Tue, 03 Apr 2018 09:06:16 GMTX-Total-Page: 100[转码后图片 data]
HTTP/1.1 404 OKConnection: closeContent-Length: 455Content-Type: application/xmlDate: Thu, 09 Apr 2020 13:44:52 GMTX-ErrNo: -3004
HTTP/1.1 404 OKConnection: closeContent-Length: 455Content-Type: application/xmlDate: Thu, 09 Apr 2020 13:44:52 GMTX-ErrNo: -3013
文档反馈