本接口用于提交截圖任務。通過該接口，用戶可以指定媒體文件的ID或URL，以及截圖的時間點和格式，系統(tǒng)將根據(jù)這些參數(shù)生成截圖并保存到指定的位置。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產(chǎn)品自身定義的條件關鍵字。
- 關聯(lián)操作：是指成功執(zhí)行操作所需要的其他權限。操作者必須同時具備關聯(lián)操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
|---|---|---|---|---|
| ice:SubmitSnapshotJob | *全部資源 * |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Name | string | 否 | 任務名稱。 | SampleJob |
| Input | object | 是 | 截圖輸入。 | |
| Type | string | 是 | 輸入類型，取值：
| Media |
| Media | string | 是 | 輸入媒體。
OSS 地址規(guī)則為：
說明
URL 中的 OSS bucket 需要先添加到 IMS存儲管理后再使用。
| oss://bucket/object.mp4 |
| Output | object | 是 | 截圖輸出。 | |
| Type | string | 是 | 輸入類型，取值：
| OSS |
| Media | string | 是 | 輸出媒體。
OSS 地址規(guī)則為：
其中 bucket 為和當前項目處于同一區(qū)域的 oss bucket 名稱，object 為文件路徑。
說明
URL 中的 OSS bucket 需要先添加到 IMS存儲管理后再使用。
| oss://test-bucket/output-{Count}.jpg |
| TemplateConfig | object | 是 | 截圖模板配置。 | |
| TemplateId | string | 是 | 模板 ID。 | ****96e8864746a0b6f3**** |
| OverwriteParams | object | 否 | 覆蓋參數(shù)。 | |
| Type | string | 否 | 截圖類型。 | Sprite |
| FrameType | string | 否 | 幀類型。 | intra |
| Count | long | 否 | 截圖數(shù)量。 | 5 |
| Interval | long | 否 | 截圖間隔時間。 | 10 |
| Time | long | 否 | 截圖開始時間。 | 1000 |
| Width | integer | 否 | 輸出圖片寬度。 | 720 |
| Height | integer | 否 | 輸出圖片高度。 | 480 |
| BlackLevel | integer | 否 | 多幀截圖針對首幀過濾黑屏圖片判定閾值。 | 30 |
| PixelBlackThreshold | integer | 否 | 判斷像素點是否為黑色點的閾值。 | 70 |
| SpriteSnapshotConfig | object | 否 | 雪碧圖配置。 | |
| CellWidth | integer | 否 | 單圖片寬度。默認截圖輸出分辨率寬度。 | 720 |
| CellHeight | integer | 否 | 單圖片高度。默認截圖輸出分辨率高度。 | 480 |
| Padding | integer | 否 | 圖片間距，默認 0，單位 px | 20 |
| Margin | integer | 否 | 外框寬度，默認 0，單位 px | 20 |
| Columns | integer | 否 | 圖片拼合列數(shù)。 | 20 |
| Lines | integer | 否 | 圖片拼合行數(shù)。 | 20 |
| Color | string | 否 | 背景顏色。 | #000000 |
| IsSptFrag | boolean | 否 | Webvtt 截圖配置：是否拼合輸出 | true |
| ScheduleConfig | object | 否 | 調度配置 | |
| PipelineId | string | 否 | 管道 ID。 | ****96e8864746a0b6f3**** |
| UserData | string | 否 | 用戶自定義數(shù)據(jù)。 | {"test parameter": "test value"} |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"JobId": "****20b48fb04483915d4f2cd8ac****"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2022-08-10 | API 內部配置變更，不影響調用 | 查看變更詳情 |
| 2022-07-11 | 新增 OpenAPI | 查看變更詳情 |