將多張圖片按設定的規則拼接成一張圖片，并保存到指定的OSS文件對象地址。
接口說明
- 請確保在使用該接口前，已充分了解智能媒體管理產品的收費方式和價格。
- 調用該接口前，請確保當前 Region 已經存在可用的項目（Project），詳見項目管理。
- 該接口最大支持拼接 10 張圖片，每張圖片的單邊長不能超過 32876 像素，總像素不能超過 10 億像素。
- 該接口為異步接口，獲取任務開始執行后，任務信息只保存 7 天，超過 7 天則無法再獲取。調用 GetTask 或 ListTasks 接口獲取返回的
TaskId，查看任務信息。也可以通過設置 Notification 消息通知參數，通過消息通知獲取任務信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| imm:CreateImageSplicingTask | create |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProjectName | string | 是 | 項目名稱，獲取方式請參見創建項目。 | test-project |
| Sources | array<object> | 是 | 輸入圖片列表，拼接順序為輸入列表 URI 順序。 | |
| object | 是 | 輸入圖片信息。 | ||
| URI | string | 是 | 源圖片的 OSS 地址。 OSS 地址規則為 oss://${Bucket}/${Object}，其中 支持的圖片格式：jpg、png。 | oss://examplebucket/sampleobject.jpg |
| Rotate | long | 否 | 圖片旋轉角度。可取值如下：
| 90 |
| TargetURI | string | 是 | 輸出圖片存儲的 OSS 地址。 OSS 地址規則為 oss://${bucketname}/${objectname}，其中${bucketname}為和當前項目處于同一地域的 OSS Bucket 名稱，${objectname}為包含文件名稱的文件路徑。 | oss://examplebucket/outputImage.jpg |
| ImageFormat | string | 否 | 輸出圖片的壓縮格式。可取值如下：
| jpg |
| Quality | long | 否 | 輸出圖片壓縮質量，僅對 jpg 和 webp 圖片格式生效。取值范圍為 0~100，默認值為 80。 | 80 |
| Direction | string | 否 | 圖片拼接方法。可取值如下：
| vertical |
| ScaleType | string | 否 | 被拼接圖片在對齊寬度或高度時的縮放方式。可取值如下：
| stretch |
| Align | long | 否 | 被拼接圖片寬或高需要對齊的像素值。取值范圍為 1~4096。
說明
若不填寫此參數（默認），則默認與拼接的第一張圖片的寬或高一致。
| 192 |
| Padding | long | 否 | 拼接后圖片中子圖的間隔，默認值為 0，單位為 px。 | 2 |
| Margin | long | 否 | 拼接后圖片的空白邊緣，默認值為 0，單位為 px。 | 2 |
| BackgroundColor | string | 否 | 參數 | red |
| UserData | string | 否 | 用戶自定義信息，在異步消息通知中會為您返回，用于方便您系統內對消息通知進行關聯處理。最大長度為 2048 字節。 | test-data |
| CredentialConfig | CredentialConfig | 否 | 鏈式授權配置。更多信息，請參見使用鏈式授權訪問其他實體資源。 | |
| Tags | object | 否 | 自定義標簽，用于對異步任務進行搜索、過濾。 | { "User": "Jane" } |
| Notification | Notification | 否 | 消息通知配置，詳細內容請單擊 Notification 查看，異步通知消息格式請參見異步通知消息格式。 |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "94D6F994-E298-037E-8E8B-0090F27*****",
"EventId": "10C-1R6p7Km0H5Ieg38LKXTIvw*****",
"TaskId": "ImageSplicing-537cc157-7645-444a-a631-c8db4d02*****"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-04-03 | OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-03-09 | OpenAPI 入參發生變更 | 查看變更詳情 |
| 2022-08-16 | OpenAPI 入參發生變更 | 查看變更詳情 |
| 2022-08-16 | OpenAPI 入參發生變更 | 查看變更詳情 |