通过文档格式转换功能，您可以灵活处理并转换各种文档类型，并将转换后的文档保存在指定的OSS路径中，便于后续使用。
使用场景
在线预览优化：您上传PDF、Word、Excel、PPT等文档至OSS后，可以调用智能媒体管理服务的文档转换接口，将文档转换成图片，方便在网页端或移动端直接预览，无需下载。
跨平台兼容性：通过OSS文档转换服务，不同设备和操作系统的用户都能顺畅查看文档。
前提条件
已通过配额中心申请开启新版本IMM Get和Post数据处理能力。
已绑定IMM Project。您可以通过OSS控制台或API绑定IMM Project。
通过OSS控制台绑定的具体操作，请参见步骤一：绑定IMM。
通过API绑定的具体操作，请参见AttachOSSBucket - 绑定对象存储桶。
已授予角色写入bucket的权限，具体操作请参见示例一：授予RAM用户对某个Bucket的完全控制权限。
注意事项
文档转换仅支持异步处理（x-oss-async-process处理方式）。
不支持匿名访问。
必须拥有IMM处理所需的相关权限。更多信息，请参见权限。
参数说明
操作名称：doc/convert
具体参数如下表所示。
参数名称 | 类型 | 是否必须 | 描述 |
target | string | 是 | 目标文件类型。取值：
说明 仅Word文档和PPT文档支持转换为TXT格式。 |
source | string | 否 | 源文件类型，默认取文件扩展名。当OSS文件没有扩展名时，可以设置此参数，取值：
|
pages | string | 否 | 转换的页码。 例如： |
文档转换时会用到sys/saveas和notify参数。更多信息，请参见另存为和消息通知。
使用REST API
转换信息
转换前
文档格式：DOCX
文档名称：example.docx
转换后
文件格式：PNG
文件存储路径：oss://test-bucket/doc_images/{index}.png
b_dGVzdC1idWNrZXQ=：转码完成后保存到名为test-bucket的Bucket中（dGVzdC1idWNrZXQ=是test-bucket进行Base64编码后的值）。
o_ZG9jX2ltYWdlcy97aW5kZXh9LnBuZw==：object使用{index}变量以example.docx页码作为图片文件名保存到doc_images目录下（ZG9jX2ltYWdlcy97aW5kZXh9LnBuZw==是doc_images/{index}.png进行Base64编码之后的值）。
转换完成消息通知：发送到主题为doc_images的MNS
处理示例
// 将文件example.docx转换为PNG格式的图片文件。
POST /example.docx? x-oss-async-process HTTP/1.1
Host: doc-demo.oss-cn-hangzhou.aliyuncs.com
Date: Fri, 28 Oct 2022 06:40:10 GMT
Authorization: SignatureValue
x-oss-async-process=doc/convert,target_png,source_docx|sys/saveas,b_dGVzdC1idWNrZXQ=,o_ZG9jX2ltYWdlcy97aW5kZXh9LnBuZw==/notify,topic_ZG9jX2ltYWdlcw使用SDK
仅支持使用Java、Python、Go SDK通过异步处理的方式完成文档转换。
Java
要求使用3.17.4及以上版本的Java SDK。
import com.aliyun.oss.ClientBuilderConfiguration;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.common.auth.CredentialsProviderFactory;
import com.aliyun.oss.common.auth.EnvironmentVariableCredentialsProvider;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.AsyncProcessObjectRequest;
import com.aliyun.oss.model.AsyncProcessObjectResult;
import com.aliyuncs.exceptions.ClientException;
import java.util.Base64;
public class Demo1 {
public static void main(String[] args) throws ClientException {
// yourEndpoint填写Bucket所在地域对应的Endpoint。
String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填写Endpoint对应的Region信息，例如cn-hangzhou。
String region = "cn-hangzhou";
// 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
// 指定Bucket名称。
String bucketName = "examplebucket";
// 指定转换后的文件名称。
String targetKey = "dest.png";
// 指定转换前的文档名称。
String sourceKey = "src.docx";
// 创建OSSClient实例。
ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);
OSS ossClient = OSSClientBuilder.create()
.endpoint(endpoint)
.credentialsProvider(credentialsProvider)
.clientConfiguration(clientBuilderConfiguration)
.region(region)
.build();
try {
// 构建文档处理样式字符串以及文档转换处理参数。
String style = String.format("doc/convert,target_png,source_docx");
// 构建异步处理指令。
String bucketEncoded = Base64.getUrlEncoder().withoutPadding().encodeToString(bucketName.getBytes());
String targetEncoded = Base64.getUrlEncoder().withoutPadding().encodeToString(targetKey.getBytes());
String process = String.format("%s|sys/saveas,b_%s,o_%s/notify,topic_QXVkaW9Db252ZXJ0", style, bucketEncoded, targetEncoded);
// 创建AsyncProcessObjectRequest对象。
AsyncProcessObjectRequest request = new AsyncProcessObjectRequest(bucketName, sourceKey, process);
// 执行异步处理任务。
AsyncProcessObjectResult response = ossClient.asyncProcessObject(request);
System.out.println("EventId: " + response.getEventId());
System.out.println("RequestId: " + response.getRequestId());
System.out.println("TaskId: " + response.getTaskId());
} finally {
// 关闭OSSClient。
ossClient.shutdown();
}
}
}Python
要求使用Python SDK 2.18.4及以上版本。
# -*- coding: utf-8 -*-
import base64
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
def main():
# 从环境变量中获取临时访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())
# 填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
endpoint = 'https://oss-cn-hangzhou.aliyuncs.com'
# 指定阿里云通用Region ID，例如cn-hangzhou。
region = 'cn-hangzhou'
# 指定Bucket名称，例如examplebucket。
bucket = oss2.Bucket(auth, endpoint, 'examplebucket', region=region)
# 指定转换前的文档名称。
source_key = 'src.docx'
# 指定转换后的文件名称。
target_key = 'dest.png'
# 构建文档处理样式字符串以及文档转换处理参数。
animation_style = 'doc/convert,target_png,source_docx'
# 构建处理指令，包括保存路径和Base64编码的Bucket名称和目标文件名称。
bucket_name_encoded = base64.urlsafe_b64encode('examplebucket'.encode()).decode().rstrip('=')
target_key_encoded = base64.urlsafe_b64encode(target_key.encode()).decode().rstrip('=')
process = f"{animation_style}|sys/saveas,b_{bucket_name_encoded},o_{target_key_encoded}/notify,topic_QXVkaW9Db252ZXJ0"
try:
# 执行异步处理任务。
result = bucket.async_process_object(source_key, process)
print(f"EventId: {result.event_id}")
print(f"RequestId: {result.request_id}")
print(f"TaskId: {result.task_id}")
except Exception as e:
print(f"Error: {e}")
if __name__ == "__main__":
main()Go
要求使用Go SDK 3.0.2及以上版本。
package main
import (
"encoding/base64"
"fmt"
"os"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
"log"
)
func main() {
// 从环境变量中获取临时访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
// 创建OSSClient实例。
// yourEndpoint填写Bucket对应的Endpoint，以华东1（杭州）为例，填写为https://oss-cn-hangzhou.aliyuncs.com。其他Region请按实际情况填写。
// yourRegion指定阿里云通用Region ID，例如cn-hangzhou。
client, err := oss.New("https://oss-cn-hangzhou.aliyuncs.com", "", "", oss.SetCredentialsProvider(&provider), oss.AuthVersion(oss.AuthV4), oss.Region("cn-hangzhou"))
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
// 指定Bucket名称，例如examplebucket。
bucketName := "examplebucket"
bucket, err := client.Bucket(bucketName)
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
// 指定转换前的文档名称。
sourceKey := "src.docx"
// 指定转换后的文件名称。
targetKey := "dest.png"
// 构建文档处理样式字符串以及文档转换处理参数
animationStyle := "doc/convert,target_png,source_docx"
// 构建处理指令，包括保存路径和Base64编码的Bucket名称和目标文件名称。
bucketNameEncoded := base64.URLEncoding.EncodeToString([]byte(bucketName))
targetKeyEncoded := base64.URLEncoding.EncodeToString([]byte(targetKey))
process := fmt.Sprintf("%s|sys/saveas,b_%v,o_%v/notify,topic_QXVkaW9Db252ZXJ0", animationStyle, bucketNameEncoded, targetKeyEncoded)
// 执行异步处理任务。
result, err := bucket.AsyncProcessObject(sourceKey, process)
if err != nil {
log.Fatalf("Failed to async process object: %s", err)
}
fmt.Printf("EventId: %s\n", result.EventId)
fmt.Printf("RequestId: %s\n", result.RequestId)
fmt.Printf("TaskId: %s\n", result.TaskId)
}常见问题
OSS文档转换支持指定Excel表sheet页的内容吗？
不支持。OSS文档转换仅支持转换Excel表所有sheet页。如果您需要转换特定sheet页，建议调用IMM的CreateOfficeConversionTask - 创建文档转换任务接口，设置SheetIndex参数。
相关文档
关于文档格式转换的更多内容，请参见文档格式转换