开发者指南

API 文档

SDK 文档

文档预览

最近更新时间:2020-07-02 10:16:10

功能描述

文档预览功能支持对多种文件类型生成图片格式预览,可以解决文档内容的页面展示问题,详细介绍请参见 文档预览概述

请求

请求示例

GET /<ObjectKey>?ci-process=doc-preview&page=<page>&srcType=<srcType> HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: GMT Date
Authorization: Auth String
说明:

Authorization: Auth String(详情请参见 请求签名 文档。)

请求参数

参数名称 描述 类型 是否必选
ObjectKey 对象文件名,例如 folder/document.pdf Sting
ci-process 数据万象处理能力,文档预览固定为 doc-preview String
srcType 源数据的后缀类型,当前文档转换根据 COS 对象的后缀名来确定源数据类型。当 COS 对象没有后缀名时,可以设置该值 String
page 需转换的文档页码,从1开始计数 Int

响应

响应头

此接口除返回公共响应头部外,还返回以下响应头部,了解公共响应头部详情请参见 公共响应头部 文档。

名称 描述 类型
X-Total-Page 在 http header 中返回文档总页数,异常时为空 Int
X-ErrNo 当异常时返回错误码,可在 http header 中查看 Sting
响应体

此接口请求的响应体为转码后图片 data。

错误码

此接口遵循统一的错误响应和错误码,详情请参见 错误码 文档。

实际案例

请求

GET /document.pdf?ci-process=doc-preview&page=1 HTTP/1.1
Host: examplebucket-1250000000.cos.ap-shanghai.myqcloud.com
Date: Tue, 03 Apr 2019 09:06:15 GMT
Authorization:XXXXXXXXXXXX

响应1(成功预览)

HTTP/1.1 200 OK
Content-Type: image/jpeg
Content-Length: 645
Date: Tue, 03 Apr 2018 09:06:16 GMT
X-Total-Page: 100

[转码后图片data]

响应2(文件不存在)

HTTP/1.1 404 OK
Connection: close
Content-Length: 455
Content-Type: application/xml
Date: Thu, 09 Apr 2020 13:44:52 GMT
X-ErrNo: -3004

响应3(指定页码不存在)

HTTP/1.1 404 OK
Connection: close
Content-Length: 455
Content-Type: application/xml
Date: Thu, 09 Apr 2020 13:44:52 GMT
X-ErrNo: -3013
目录