CreateImageToPDFTask - 建立圖片轉PDF任務

更新時間:
Copy as MD

將多張圖片轉換為單個PDF檔案,並儲存到指定的OSS檔案對象地址

介面說明

  • 請確保在使用該介面前,已充分瞭解Intelligent Media Management產品的收費方式和價格

  • 調用該介面前,請確保當前 Region 已經存在可用的專案(Project),詳見專案管理

  • 該介面最大支援輸入 100 張圖片。

  • 該介面為非同步介面,擷取任務開始執行後,任務資訊只儲存 7 天,超過 7 天則無法再擷取。調用 GetTaskListTasks 介面擷取返回的TaskId,查看任務資訊。也可以通過設定 Notification 訊息通知參數,通過訊息通知擷取任務資訊。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

imm:CreateImageToPDFTask

create

*Project

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

請求參數

名稱

類型

必填

描述

樣本值

ProjectName

string

專案名稱,擷取方式請參見建立專案

test-project

Sources

array<object>

輸入圖片列表,轉換順序為輸入列表 URI 的順序。

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

輸出 PDF 儲存的 OSS 地址。

OSS 地址規則為 oss://${bucketname}/${objectname},其中${bucketname}為和當前專案處於同一地區的 OSS Bucket 名稱,${objectname}為包含檔案名稱的檔案路徑。

oss://examplebucket/outputDocument.pdf

UserData

string

使用者自訂資訊,在非同步訊息通知中會為您返回,用於方便您系統內對訊息通知進行關聯處理。最大長度為 2048 位元組。

test-data

CredentialConfig CredentialConfig

如無特殊需求,請保持留空即可。

鏈式授權配置。更多資訊,請參見使用鏈式授權訪問其他實體資源

Tags

object

自訂標籤,用於對非同步任務進行搜尋、過濾。

{ "User": "Jane" }

Notification Notification

訊息通知配置,詳細內容請單擊 Notification 查看,非同步通知訊息格式請參見非同步通知訊息格式

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

請求 ID。

EC564A9A-BA5C-4499-A087-D9B9E76E*****

EventId

string

事件 ID。

0ED-1Bz8z71k5TtsUejT4UJ16Es*****

TaskId

string

任務 ID。

ImageToPDF-cbe6ae3e-f8dc-4566-9da7-535d5d*****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "EC564A9A-BA5C-4499-A087-D9B9E76E*****",
  "EventId": "0ED-1Bz8z71k5TtsUejT4UJ16Es*****",
  "TaskId": "ImageToPDF-cbe6ae3e-f8dc-4566-9da7-535d5d*****"
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情