CreateImageSplicingTask - 建立圖片拼接任務
將多張圖片按設定的規則拼接成一張圖片,並儲存到指定的OSS檔案對象地址
介面說明
請確保在使用該介面前,已充分瞭解Intelligent Media Management產品的收費方式和價格。
調用該介面前,請確保當前 Region 已經存在可用的專案(Project),詳見專案管理。
該介面最大支援拼接 10 張圖片,每張圖片的單邊長不能超過 32876 像素,總像素不能超過 10 億像素。
該介面為非同步介面,擷取任務開始執行後,任務資訊只儲存 7 天,超過 7 天則無法再擷取。調用 GetTask 或 ListTasks 介面擷取返回的
TaskId,查看任務資訊。也可以通過設定 Notification 訊息通知參數,通過訊息通知擷取任務資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
imm:CreateImageSplicingTask |
create |
*Project
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ProjectName |
string |
是 |
專案名稱,擷取方式請參見建立專案。 |
test-project |
| Sources |
array<object> |
是 |
輸入圖片列表,拼接順序為輸入列表 URI 順序。 |
|
|
object |
否 |
輸入圖片資訊。 |
||
| URI |
string |
是 |
源圖片的 OSS 地址。 OSS 地址規則為 oss://${Bucket}/${Object},其中 支援的圖片格式:jpg、png。 |
oss://examplebucket/sampleobject.jpg |
| Rotate |
integer |
否 |
圖片旋轉角度。可取值如下:
|
90 |
| TargetURI |
string |
是 |
輸出圖片儲存的 OSS 地址。 OSS 地址規則為 oss://${bucketname}/${objectname},其中${bucketname}為和當前專案處於同一地區的 OSS Bucket 名稱,${objectname}為包含檔案名稱的檔案路徑。 |
oss://examplebucket/outputImage.jpg |
| ImageFormat |
string |
否 |
輸出圖片的壓縮格式。可取值如下:
枚舉值:
|
jpg |
| Quality |
integer |
否 |
輸出圖片壓縮品質,僅對 jpg 和 webp 圖片格式生效。取值範圍為 0~100,預設值為 80。 |
80 |
| Direction |
string |
否 |
圖片拼接方法。可取值如下:
|
vertical |
| ScaleType |
string |
否 |
被拼接圖片在對齊寬度或高度時的縮放方式。可取值如下:
|
stretch |
| Align |
integer |
否 |
被拼接圖片寬或高需要對齊的像素值。取值範圍為 1~4096。
說明
若不填寫此參數(預設),則預設與拼接的第一張圖片的寬或高一致。 |
192 |
| Padding |
integer |
否 |
拼接後圖片中子圖的間隔,預設值為 0,單位為 px。 |
2 |
| Margin |
integer |
否 |
拼接後圖片的空白邊緣,預設值為 0,單位為 px。 |
2 |
| BackgroundColor |
string |
否 |
參數 |
red |
| UserData |
string |
否 |
使用者自訂資訊,在非同步訊息通知中會為您返回,用於方便您系統內對訊息通知進行關聯處理。最大長度為 2048 位元組。 |
test-data |
| CredentialConfig | CredentialConfig |
否 |
鏈式授權配置。更多資訊,請參見使用鏈式授權訪問其他實體資源。 |
|
| Tags |
object |
否 |
自訂標籤,用於對非同步任務進行搜尋、過濾。 |
{ "User": "Jane" } |
| Notification | Notification |
否 |
訊息通知配置,詳細內容請單擊 Notification 查看,非同步通知訊息格式請參見非同步通知訊息格式。 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
圖片拼接結果。 |
||
| RequestId |
string |
請求 ID。 |
94D6F994-E298-037E-8E8B-0090F27***** |
| EventId |
string |
事件 ID。 |
10C-1R6p7Km0H5Ieg38LKXTIvw***** |
| TaskId |
string |
任務 ID。 |
ImageSplicing-537cc157-7645-444a-a631-c8db4d02***** |
樣本
正常返回樣本
JSON格式
{
"RequestId": "94D6F994-E298-037E-8E8B-0090F27*****",
"EventId": "10C-1R6p7Km0H5Ieg38LKXTIvw*****",
"TaskId": "ImageSplicing-537cc157-7645-444a-a631-c8db4d02*****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。