調用本接口提交視頻截圖作業，開始異步截圖處理。
接口說明
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vod:SubmitSnapshotJob | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| VideoId | string | 是 | 視頻 ID。可通過以下方式獲取：
| d3e680e618708efbf2cae7cc9312**** |
| SpecifiedOffsetTime | long | 否 | 截圖指定時間的起始點。
| 0 |
| Width | string | 否 | 截圖寬，取值范圍： | 1280 |
| Height | string | 否 | 截圖高，取值范圍： | 720 |
| Count | long | 否 | 截圖的最大數量。默認值：1。 | 1 |
| Interval | long | 否 | 截圖的間隔時間，必須大于或等于 0。
| 1 |
| SpriteSnapshotConfig | string | 否 | 生成雪碧圖的配置信息。如果不為空則生成雪碧圖。參數結構詳情，請參見SpriteSnapshotConfig 。 | {'CellWidth': 120, 'CellHeight': 68, 'Columns': 3,'Lines': 10, 'Padding': 20, 'Margin': 50} |
| SnapshotTemplateId | string | 否 | 截圖模板 ID。
| f5b228fe693bf55bd87b789**** |
| UserData | string | 否 | 自定義設置。僅支持 JSON 字符串，支持用戶自定義數據透傳及指定回調地址設置等。參數結構詳情，請參見 UserData 。 說明
此參數中消息回調的使用前提是需要在控制臺配置 HTTP 回調地址和勾選對應的回調事件類型才能使用，否則回調設置不生效。
| {"MessageCallback":{"CallbackURL":"http://.example.aliyundoc.com"},"Extend":{"localId":"xxx","example":"www"}} |
| SpecifiedOffsetTimes | array | 否 | 指定視頻時間點進行截圖，單位：毫秒。一次可指定最多 30 個時間點。 | |
| long | 否 | 自定義時間點，毫秒 | 1000 |
說明
Count 和 Interval 至少指定一個，若同時指定，截圖數目以少者為準。
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "25818875-5F78-5EB0-4AF6-D7393642****",
"SnapshotJob": {
"JobId": "ad90a501b1b94b72374ad0050464****"
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-12-15 | OpenAPI 入參發生變更 | 查看變更詳情 |