文档

文档快照

更新时间:

您可以通过文档快照功能,获取文档(Word/Excel/PPT/PDF)特定页的快照。比如获取文档首页的缩略图。

使用场景

  • 数据备份与恢复:在业务系统日常运行过程中,定期创建OSS Bucket中的文档快照,备份数据。

  • 关键信息提取:文档快照可以获取特定页的快照,快速提取关键信息。

注意事项

  • 文档快照仅支持同步处理(x-oss-process处理方式)。

  • 使用文档快照前,需要先绑定IMM Project。关于控制台和API如何绑定,请参见快速入门AttachOSSBucket

  • 不支持匿名访问。

  • 必须拥有IMM处理所需的相关权限。更多信息,请参见权限

参数说明

操作名称:doc/snapshot

具体参数如下表所示:

参数

类型

是否必须

描述

target

string

图片目标格式。取值:

  • png(默认)

  • jpg

source

string

文档源文件格式,默认使用对象名后缀。取值:

  • pdf

  • xlsx

  • xls

  • docx

  • doc

  • pptx

  • ppt

说明

如果该字段未填写,并且对象无后缀,会返回错误。

page

int

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

返回图片的二进制流,可以直接在浏览器中预览。

使用REST API

获取example.docx的首页快照

处理方式

默认处理

处理示例

// 获取example.docx的首页快照。
GET /exmaple.docx?x-oss-process=doc/snapshot HTTP/1.1
Host: doc-demo.oss-cn-hangzhou.aliyuncs.com
Date: Fri, 28 Oct 2022 06:40:10 GMT
Authorization: OSS qn6q**************:77Dv****************

获取word文档example第2页的jpg快照

处理方式

  • target: jpg

  • source: docx

  • page: 2

处理示例

// 获取word文档example第2页的jpg快照。
GET /exmaple?x-oss-process=doc/snapshot,target_jpg,source_docx,page_2 HTTP/1.1
Host: doc-demo.oss-cn-hangzhou.aliyuncs.com
Date: Fri, 28 Oct 2022 06:40:10 GMT
Authorization: OSS qn6q**************:77Dv****************

使用SDK

文档快照仅支持同步处理,SDK使用方法请参见使用SDK

常见问题

  • 文档快照对源文档大小限制是多少?

    文档快照对源文档大小限制是20M。

  • 本页导读 (1)