全部文档
当前文档

暂无内容

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

文档中心

文档处理持久化

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

文档处理持久化

接口

saveas

描述

配置转存参数,将处理后的文档(图片文件)作为对象(Object)保存至KS3指定的存储空间(Bucket)内,支持单文件和多文件批量上传。

说明

  1. 权限要求

    • ACL:具有源文档Object的读权限,对转存目标Bucket具有写权限

    • Policy:具有源Bucketks3:PostProcessTask权限以及目标Object的ks3:PutObject权限

  2. 转存的Bucket和Region要求

    • 源文档所在源Bucket和处理后转存的目标Bucket必须是同region的桶

    • 源桶和目标桶可以不是同一个Bucket

  3. 转存图片读写权限ACL

    • 转存后图片的读写权限ACL默认继承Bucket,不支持自定义

  4. 转存图片存储类型

    • 转存后图片默认存储类型继承桶存储类型,也可以根据x-kss-storage-class自定义存储类型

  5. 转存图片存储时长

    • 转存图片作为KS3的常规object保存

  6. 删除转存后图片方式

    • 支持手动删除操作调用DeleteObject删除

    • 支持设置生命周期规则设置过期策略

  7. 转存相关信息

    • 源文档的tagging、usermeta、加密,不转存到目标图

  8. 目标对象已经存在,是否覆盖

    • 直接覆盖,并且更新Last Modified时间

请求

请求语法
POST /{ObjectKey}?x-kss-process  HTTP/1.1
Host: {BucketName}.{endpoint}
Content-Length: {Content-Length}
Date: {date}
x-kss-storage-class: {StorageClass}
Authorization: {SignatureValue}

x-kss-process=(文档处理操作)|sys/saveas,o_,b_(转存操作)

请求参数

文档处理持久化功能接口是Post动作,以请求Body的方式传递x-kss-process,增加saveas 参数将处理后的结果文件保存至指定Bucket

参数名称

是否必填

解释说明

saveas

操作参数名称,转存操作

b

目标Bucket名称,名称需经过URL Safe的Base64编码,请参见编码步骤

  • 若不指定目标Bucket,则默认保存至源文档所在Bucket

o

目标Object名称,名称需经过URL Safe的Base64编码

  • 支持模板变量,包括:

{bucket}源存储桶、{key}源Object名称、{index}文件

索引和{autoext}目标格式

  • 若为空则使用默认模板"{key}-{index}.{autoext}"

请求头部

该接口可以使用所有常用请求头部。获取更多信息,请点击常用请求头部

用户可以通过以下的header为转存后的图片设置存储类型

名称

描述

必须

x-kss-storage-class

设置存储方式。如果不指定x-kss-storage-class,Object存储类型默认跟Bucket存储类型一致;如果指定x-kss-storage-class,则Object为指定存储类型。

  • 类型:String

  • 默认值:None

  • 有效值:STANDARD/STANDARD_IA/ARCHIVE

  • 约束条件:无

响应

响应内容
  • 如果文档快照结合持久化请求处理成功,则返回如下JSON格式的转存成功的内容:

HTTP/1.1 200 OK
Server: KS3
Date: {date}
Connection: keep-alive
Content-Length:{Content-Length}
Content-Type:{content-type}
x-kss-request-id:f0uv****2gj4

{
    "bucket": "bucket_name",
    "fileSize": "file_size",
    "object": "object_key",
    "status": "OK"
}

  • 如果文档格式转换结合持久化请求处理成功,则返回如下JSON格式的转存成功的内容:

HTTP/1.1 200 OK
Server: KS3
Date: {date}
Connection: keep-alive
Content-Length:{Content-Length}
Content-Type:{content-type}
x-kss-request-id:f0uv****2gj4

{
    "bucket": "bucket_name",
    "succeededItems": ["object_key_1","object_key_2","object_key_3"],
    "errors": [],
    "totalCount": "count_number"
}

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

{
    "requestId": <requestId String>,
    "errorCode": <ErrorCode Integer>,
    "code":  <code String>,
    "message": <ErrorMessage String>
}

特殊错误

HTTP状态码

描述

400

  • 请求参数错误

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

403

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

404

请求的资源不存在

500

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

示例

使用文档快照并转存至指定Bucket
POST /suiyi.pdf?x-kss-process  HTTP/1.1
Host: ks3-resources.ks3-cn-beijing.ksyuncs.com
Content-Length: {Content-Length}
Date: {date}
Authorization: {SignatureValue}

x-kss-process=doc/snapshot,source_pdf,target_png,page_1|sys/saveas,o_ZG9jX2ltYWdlcy97a2V5fS17aW5kZXh9LnthdXRvZXh0fQ,b_e2J1Y2tldH0

使用文档转换并转存至指定Bucket
POST /suiyi.pdf?x-kss-process  HTTP/1.1
Host: ks3-resources.ks3-cn-beijing.ksyuncs.com
Content-Length: {Content-Length}
Date: {date}
Authorization: {SignatureValue}

x-kss-process=doc/convert,source_pdf,target_png,pages_MS0xMA|sys/saveas,o_ZG9jX2ltYWdlcy97a2V5fS17aW5kZXh9LnthdXRvZXh0fQ,b_e2J1Y2tldH0

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

纯净模式

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