CreateOfficeConversionTask - 建立文檔轉換任務 -

建立文檔轉換任務，支援文檔格式轉換，將儲存在Object Storage Service中的文檔（Word、PPT、Excel、PDF）轉成圖片，文本，或者PDF。

介面說明

請確保在使用該介面前，已充分瞭解Intelligent Media Management產品的收費方式和價格
重要非同步任務不保證時效。
支援的輸入檔案格式：
- 文字文檔（Word）：doc、docx、wps、wpss、docm、dotm、dot、dotx。
- 示範文檔（PPT）：pptx、ppt、pot、potx、pps、ppsx、dps、dpt、pptm、potm、ppsm、dpss。
- 表格文檔（Excel）：xls、xlt、et、ett、xlsx、xltx、csv、xlsb、xlsm、xltm、ets。
- PDF 文檔：pdf。
支援的輸出檔案格式：
- 圖片：png、jpg。
- 文本：txt。
- PDF：pdf。
單檔案大小限制 200MB 以內，上限無法調整。
如果檔案比較大或者檔案內容本身比較複雜，可能會導致轉換逾時。
單使用者每秒請求數限制為 50。
任務開始執行後，任務資訊只儲存 7 天，超過 7 天則無法再擷取。您可以通過以下幾種方式及時擷取任務資訊：
- 調用 GetTask 或 ListTasks 介面擷取返回的TaskId，查看任務資訊。
- 在與Intelligent Media Management相同的地區下開通 MNS 服務，並配置訂閱關係，及時擷取任務資訊通知，非同步通知訊息格式請參見非同步通知訊息格式。關於 MNS SDK 的更多資訊，請參見接收和刪除訊息。
- 在與Intelligent Media Management相同的地區下開通 RocketMQ 服務，並建立 RocketMQ 4.0 執行個體、Topic、Group，及時擷取任務資訊通知，非同步通知訊息格式請參見非同步通知訊息格式。關於 RocketMQ 使用的更多資訊，請參見快速使用 HTTP 協議的 SDK 收發普通訊息。
- 在與Intelligent Media Management相同的地區下開通並接入事件匯流排 EventBridge服務，及時擷取任務資訊通知。更多資訊，請參見Intelligent Media Management IMM 事件。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

imm:CreateOfficeConversionTask

create

*Project

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}

無

請求參數

名稱	類型	必填	描述	樣本值
ProjectName	string	是	專案名稱，擷取方式請參見建立專案。	test-project
SourceURI	string	否	來源資料的儲存地址。 OSS 地址規則為 oss://${Bucket}/${Object}，其中`${Bucket}`為和當前專案處於同一地區(Region)的 OSS Bucket 名稱，`${Object}`為包含副檔名的檔案完整路徑。	oss://test-bucket/test-object
Sources	array<object>	否	輸入圖片列表，轉換順序為輸入列表 URI 的順序。(該參數尚未正式上線，不推薦使用)	oss://imm-test/test.pptx
	object	否	輸入圖片資訊。
URI	string	否	源圖片的 OSS 地址。 OSS 地址規則為 oss://${Bucket}/${Object}，其中${Bucket}為和當前專案處於同一地區(Region)的 OSS Bucket 名稱，${Object}為包含副檔名的檔案完整路徑。支援的圖片格式：jpg、jp2、png、tiff、webp、bmp、svg。	oss://examplebucket/sampleobject.jpg
Rotate	integer	否	圖片旋轉角度。可取值如下： 0（預設） 90 180 270	90
TargetURI	string	否	文檔轉換輸出地址模板。地址規則為`oss://{bucket}/{tags.custom}/{dirname}/{barename}.{autoext}`。更多資訊，請參見 TargetURI 模板。說明和 TargetURIPrefix 二者至少需要填一個。	oss://examplebucket/outputDocument.pdf
TargetURIPrefix	string	否	文檔轉換後輸出檔案的儲存地址首碼。規則為 `oss://${Bucket}/${Prefix}/`，其中`${Bucket}`為和當前專案處於同一地區(Region)的 OSS Bucket 名稱，`${Prefix}`為輸出檔案的儲存地址首碼。說明和 TargetURI 二者至少需要填一個。	oss://examplebucket/outputprefix/
SourceType	string	否	來源資料的尾碼類型。預設根據 OSS 對象的尾碼名確定來源資料的類型。當 OSS 對象沒有尾碼名時，可以設定此參數，可選值如下。文字文檔（Word）：doc、docx、wps、wpss、docm、dotm、dot、dotx 示範文檔（PPT）：pptx、ppt、pot、potx、pps、ppsx、dps、dpt、pptm、potm、ppsm、dpss 表格文檔（Excel）：xls、xlt、et、ett、xlsx、xltx、csv、xlsb、xlsm、xltm、ets PDF 文檔：pdf	doc
TargetType	string	是	轉換輸出的目標檔案類型。包括如下選項： png：轉換為 PNG 格式的圖片檔案。 jpg：轉換為 JPG 格式的圖片檔案。 pdf：轉換為 PDF 檔案。 txt：轉換為只包含常值內容的檔案，主要用於提取檔案的常值內容。來源資料類型只支援示範文檔、文字文檔和表格文檔。表格文檔轉換結果產生一個 txt 檔案，sheet 相關的變數設定不生效。	png
UserData	string	否	使用者自訂資訊，在非同步訊息通知中會為您返回，用於方便您系統內對訊息通知進行關聯處理。最大長度為 2048 位元組。	{ "id": "test-id", "name": "test-name" }
Tags	object	否	自訂標籤資訊，字典格式。用於搜尋任務。	{ "key": "value" }
StartPage	integer	否	文檔轉換的起始頁，預設值為 1。說明如果源檔案為表格文檔需要指定工作表頁碼。只有轉換圖片時生效，轉換 pdf 和 txt 時不生效。	1
EndPage	integer	否	文檔轉換的結束頁，預設值為-1，表示從起始頁開始轉換到最後一頁。說明如果源檔案為表格文檔需要指定工作表頁碼（SheetIndex）。如果頁碼太多，建議分批轉換，否則可能會導致轉換逾時。只有轉換圖片時生效，轉換 pdf 和 txt 時不生效。	-1
Password	string	否	文檔的開啟密碼。如果需要轉換有密碼的文檔，請設定此參數。	123456
ScalePercentage	integer	否	文檔縮放比例，取值範圍為 20~199，預設值為 100，表示不縮放。說明小於 100 表示縮小，大於 100 表示放大。	100
Quality	integer	否	轉換檔的品質，取值範圍為 0（品質最差，效能最好）~100（品質最好，效能最差）。預設情況下，系統會根據文檔內容，在品質和效能中權衡，設定合適的值。	60
Pages	string	否	指定轉換頁碼。優先順序高於參數 StartPage 和參數 EndPage。格式如下：多個頁碼用半形逗號（,）隔開，例如 1,2。連續頁碼用短劃線（-）串連，例如 1,2-4,7。	1,2-4,7
MaxSheetRow	integer	否	表格文檔轉換為圖片的最大行數，預設轉換所有行。說明當參數 LongPicture 取值為`true`時，此參數生效。	10
MaxSheetColumn	integer	否	表格文檔轉換為圖片的最大列數，預設轉換所有列。說明當參數 LongPicture 取值為`true`時，此參數生效。	10
SheetCount	integer	否	表格文檔中轉換為圖片的工作表（sheet）的數量，預設轉換所有工作表。	1
SheetIndex	integer	否	表格文檔中轉換為圖片的工作表（sheet）的頁碼，取值範圍為 1~最後一個 sheet 頁。預設轉換起始頁為 1。	1
FitToWidth	boolean	否	表格文檔轉換為圖片或者 PDF 檔案時，是否將所有列輸出到一張圖片或者 PDF 頁面。取值範圍如下： false（預設）：否。輸出成多張圖片，多張 PDF 頁面。 true：是。輸出成一張圖片，一張 PDF 頁面。	false
FitToHeight	boolean	否	表格文檔轉換為圖片或者 PDF 檔案時，是否將所有行輸出到一張圖片或者 PDF 頁面。取值範圍如下： false（預設）：否。輸出成多張圖片，多張 PDF 頁面。 true：是。輸出成一張圖片，一張 PDF 頁面。	false
FirstPage	boolean	否	表格文檔轉換為圖片時，是否只返迴轉換結果的第一張圖片（圖片包含的行數和列數為自動切割的結果）。取值範圍如下： false（預設）：否。返回所有圖片。 true：是。只返回第一張圖片（提取縮圖）。說明僅當參數 LongPicture 取值為`true`時，此參數生效。	false
PaperSize	string	否	表格文檔轉換為圖片時的紙張大小（輸出圖片可以類比為在紙張上面列印）。取值範圍如下： A0 A2 A4（預設）說明需配合參數 FitToHeight 和參數 FitToWidth 一起使用，此參數才會生效。	A4
PaperHorizontal	boolean	否	表格文檔轉換為圖片時紙張是否水平放置（輸出圖片可以類比為在紙張上面列印）。取值範圍如下： false（預設）：否。垂直放置。 true：是。水平放置。	false
TrimPolicy	TrimPolicy	否	表格文檔轉換的瘦身策略。比如表格中有很多沒有內容的行列，在沒有瘦身策略的情況下，可能會輸出很多空白。
ShowComments	boolean	否	文字文檔轉換為圖片時，是否顯示批註。取值範圍如下： false（預設）：否。不顯示批註。 true：是。顯示批註。	false
LongPicture	boolean	否	文檔轉換為圖片時是否轉換為一張長圖。取值範圍如下： false（預設）：否。轉換成多張圖。 true：是。轉換成一張長圖。說明最多支援將 20 頁文檔合成一張長圖，超過該頁數的轉換任務可能會報錯。	false
ImageDPI	integer	否	輸出圖片 DPI，取值範圍為 96~600，預設值為 96。	96
LongText	boolean	否	文檔轉換為文本時是否轉換為長文字檔。取值範圍如下： false（預設）：否。每頁文檔轉換為獨立的文字檔。 true：是。所有內容都放到一個文字檔中。	false
HoldLineFeed	boolean	否	文檔轉換為文本時是否保留文檔中的分行符號。取值範圍如下： false（預設）：否。不保留分行符號。 true：是。保留分行符號。	false
CredentialConfig	CredentialConfig	否	如無特殊需求，請保持留空即可。鏈式授權配置，非必填。更多資訊，請參見使用鏈式授權訪問其他實體資源。
Notification	Notification	否	訊息通知配置，詳細內容請單擊 Notification 查看，非同步通知訊息格式請參見非同步通知訊息格式。

返回參數

名稱	類型	描述	樣本值
	object	非同步任務響應。
RequestId	string	請求 ID。	FF3B7D81-66AE-47E0-BF69-157DCF18*****
TaskId	string	任務 ID。	formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd*****
EventId	string	事件 ID。	2C2-1I0EG57VR37J4rQ8oKG6C9*****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "FF3B7D81-66AE-47E0-BF69-157DCF18*****",
  "TaskId": "formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd*****",
  "EventId": "2C2-1I0EG57VR37J4rQ8oKG6C9*****"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。