通過文檔格式轉換功能，您可以靈活地處理各種文檔類型，將其轉換為適合自身需求的輸出文檔類型，并根據需要將轉換后的文檔保存在指定的OSS路徑中，以便后續的應用和使用。本文介紹文檔轉換處理功能參數及示例。
使用場景
在線預覽優化：您可以將不同格式的文檔（如PDF、Word、Excel、PPT等）上傳至OSS，為了在網頁或移動端應用中直接預覽這些文檔，無需下載到本地，可以調用智能媒體管理服務提供的文檔轉換接口，將文檔轉換為圖片格式，以適合在線展示。
跨平臺兼容性：不同設備和操作系統對各種文件格式支持程度不一，通過OSS文檔轉換服務，可以讓您無論使用何種設備都能順暢地查看文檔。
前提條件
已通過配額中心申請開啟新版本IMM Get和Post數據處理能力。
已綁定IMM Project。您可以通過OSS控制臺或API綁定IMM Project。
通過OSS控制臺綁定的具體操作，請參見步驟一：綁定IMM。
通過API綁定的具體操作，請參見AttachOSSBucket - 綁定對象存儲桶。
注意事項
文檔轉換僅支持異步處理（x-oss-async-process處理方式）。
不支持匿名訪問。
必須擁有IMM處理所需的相關權限。更多信息，請參見權限。
參數說明
操作名稱：doc/convert
具體參數如下表所示。
參數名稱 | 類型 | 是否必須 | 描述 |
target | string | 是 | 目標文件類型。取值：
|
source | string | 否 | 源文件類型，默認取文件擴展名。當OSS文件沒有擴展名時，可以設置此參數，取值：
|
pages | string | 否 | 轉換的頁碼，需經過URL安全的Base64編碼。具體操作，請參見水印編碼。 例如： |
使用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 /exmaple.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: OSS qn6q**************:77Dv****************
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參數。