本接口用于提交生成動(dòng)態(tài)圖像的任務(wù)。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別:是指每個(gè)操作的訪問級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
ice:SubmitDynamicImageJob | *全部資源 * |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Name | string | 否 | 任務(wù)名稱 | SampleJob |
Input | object | 是 | 任務(wù)輸入 | |
Type | string | 是 | 輸入類型,取值:
枚舉值:
| OSS |
Media | string | 是 | 輸入媒體。
OSS 地址規(guī)則為:
其中 bucket 為和當(dāng)前項(xiàng)目處于同一區(qū)域的 OSS bucket 名稱,object 為文件路徑。 說明
URL 中的 OSS bucket 需要先添加到 IMS存儲(chǔ)管理后再使用。
| oss://bucket/object.mp4 |
Output | object | 是 | 任務(wù)輸出 | |
Type | string | 是 | 輸出類型,取值:
枚舉值:
| Media |
Media | string | 是 | 輸出媒體,支持 OSS 地址和媒資 ID 兩種。 OSS 地址規(guī)則為
其中 bucket 為和當(dāng)前項(xiàng)目處于同一區(qū)域的 OSS bucket 名稱,object 為文件路徑。 說明
URL 中的 OSS bucket 需要先添加到 IMS存儲(chǔ)管理后再使用。
| ****96e8864746a0b6f3**** |
TemplateConfig | object | 是 | 截圖模板配置 | |
TemplateId | string | 是 | 模板 ID | ****96e8864746a0b6f3**** |
OverwriteParams | object | 否 | 覆蓋參數(shù) | |
Format | string | 否 | 動(dòng)圖格式,取值:
| gif |
Width | integer | 否 | 輸出動(dòng)圖寬度。取值范圍:[128, 4096]。 | 1024 |
Height | integer | 否 | 輸出動(dòng)圖高度。取值范圍:[128, 4096]。 | 720 |
Fps | integer | 否 | 幀率。取值范圍:[1, 60]。 | 15 |
ScanMode | string | 否 | 掃描模式。可取值:
| progressive |
LongShortMode | boolean | 否 | 是否開啟橫豎屏自適應(yīng)(長短邊模式)。取值:
默認(rèn)值:true。 說明
轉(zhuǎn)碼輸出的寬對(duì)應(yīng)輸入片源的長邊(豎屏為片源的高),高對(duì)應(yīng)輸入視頻的短邊(豎屏為片源的寬)。
| false |
TimeSpan | object | 否 | 時(shí)間線參數(shù) | |
Seek | string | 否 | 開始時(shí)間點(diǎn)。
| 01:59:59.999 或 32000.23 |
Duration | string | 否 | 持續(xù)時(shí)長。
| 01:59:59.999 或 32000.23 |
End | string | 否 | 截尾時(shí)長,表示切掉尾部的若干時(shí)長。設(shè)置此值時(shí),參數(shù) Duration 失效。
| 01:59:59.999 或 32000.23 |
ScheduleConfig | object | 否 | 調(diào)度配置 | |
PipelineId | string | 否 | 管道 ID | ****96e8864746a0b6f3**** |
Priority | integer | 否 | 優(yōu)先級(jí),1-10,默認(rèn) 6。數(shù)值越大,優(yōu)先級(jí)越高。 | 6 |
UserData | string | 否 | 用戶自定義信息 | {"SampleKey": "SampleValue"} |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"JobId": "****20b48fb04483915d4f2cd8ac****"
}
錯(cuò)誤碼
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2022-08-10 | API 內(nèi)部配置變更,不影響調(diào)用 | 查看變更詳情 |
2022-07-11 | 新增 OpenAPI | 查看變更詳情 |