全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

文档快照

最近更新时间:2026-03-31 14:10:27

文档快照

接口

doc/snapshot

描述

文档快照功能允许您无需下载文档,直接在云端生成文档特定页面的清晰快照图片,适用于网页预览、内容展示、数据备份等多种场景,提升文档处理效率。

说明

该接口操作需要是Bucket Owner或具有ks3:GetObject权限。

请求

请求语法
GET /{ObjectKey}?x-kss-process=doc/snapshot  HTTP/1.1
Host: {BucketName}.{endpoint}
Date: {date}
Authorization: {SignatureValue}

请求参数

参数名称

参数含义

是否必填

取值范围

source

文档源文件格式

pdf

target

目标图片格式

  • png(默认)

  • jpg

  • jpeg

page

页码

默认首页从1开始,最大2000。

请求头部

该请求不需要设置特殊的头部。

响应

响应头部

头部名称

是否必填

说明

Content-Type

MIME类型,成功时为图片固定的MIME类型image/*,失败时为application/json

响应内容
  • 如果请求处理成功,返回图片的二进制图片数据。

  • 如果请求失败,则返回如下JSON格式的内容:

{
    "code": <code String>,
    "message": <ErrorMessage String>,
    "requestId": <requestId String>
}
特殊错误

HTTP状态码

描述

400

  • 请求参数错误

  • 可能是源文档损坏、加密等

403

签名不匹配或无操作对应权限

404

请求的资源不存在

500

服务器端操作失败。如果遇到此种错误,请及时联系我们

示例

1.获取文档首页的png快照
GET /suiyi.pdf?x-kss-process=doc/snapshot  HTTP/1.1
Host: ks3-resources.ks3-cn-beijing.ksyuncs.com
Date: {date}
Authorization: {SignatureValue}
2.获取文档第二页的jpg快照
GET /suiyi.pdf?x-kss-process=doc/snapshot,source_pdf,target_jpg,page_2  HTTP/1.1
Host: ks3-resources.ks3-cn-beijing.ksyuncs.com
Date: {date}
Authorization: {SignatureValue}

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈