全部產品
Search

搜尋本產品

    Intelligent Media Services：SubmitSnapshotJob - 提交截圖任務

    文件中心

    Intelligent Media Services：SubmitSnapshotJob - 提交截圖任務

    更新時間：Mar 21, 2026

    本介面用於提交截圖任務。通過該介面，使用者可以指定媒體檔案的ID或URL，以及截圖的時間點和格式，系統將根據這些參數產生截圖並儲存到指定的位置。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    ice:SubmitSnapshotJob

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Name

    string

    否

    任務名稱。

    SampleJob
    Input

    object

    是

    截圖輸入。

    Type

    string

    是

    輸入類型，取值：

    • OSS：OSS 檔案地址。

    • Media：媒資 ID。

    Media
    Media

    string

    是

    輸入媒體。

    • 當 Type 為 OSS 時填入 OSS 地址。

    • Type 為 Media 時填入媒資 ID。

    OSS 地址規則為：

    1. oss://bucket/object

    2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object 其中 bucket 為和當前專案處於同一地區的 oss bucket 名稱，object 為檔案路徑。

    說明

    URL 中的 OSS bucket 需要先添加到 IMS儲存管理後再使用。

    oss://bucket/object.mp4
    Output

    object

    是

    截圖輸出。

    Type

    string

    是

    輸入類型，取值：

    • OSS：OSS 檔案地址。

    • Media：媒資 ID。

    OSS
    Media

    string

    是

    輸出媒體。

    • 當 Type 為 OSS 時填入 OSS 地址。

    • Type 為 Media 時填入媒資 ID。

    OSS 地址規則為：

    1. oss://bucket/object

    2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object

    其中 bucket 為和當前專案處於同一地區的 oss bucket 名稱，object 為檔案路徑。

    • 截取多張靜態截圖時，object 必須要帶有”{Count}“預留位置；

    • 截取雪碧圖時，object 必須要帶有“{TileCount}”預留位置。

    • WebVTT 截圖 object 的尾碼必須是“.vtt”。

    說明

    URL 中的 OSS bucket 需要先添加到 IMS儲存管理後再使用。

    oss://test-bucket/output-{Count}.jpg
    TemplateConfig

    object

    是

    截圖模板配置。

    TemplateId

    string

    是

    模板 ID。

    ****96e8864746a0b6f3****

    OverwriteParams

    object

    否

    覆蓋參數。

    Type

    string

    否

    截圖類型。

    Sprite
    FrameType

    string

    否

    框架類型。

    intra
    Count

    integer

    否

    截圖數量。

    5
    Interval

    integer

    否

    截圖間隔時間。

    10
    Time

    integer

    否

    截圖開始時間。

    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

    否

    圖片拼合列數。

    20
    Lines

    integer

    否

    圖片拼合行數。

    20
    Color

    string

    否

    背景顏色。

    #000000
    IsSptFrag

    boolean

    否

    Webvtt 截圖配置：是否拼合輸出

    true
    ScheduleConfig

    object

    否

    調度配置

    PipelineId

    string

    否

    管道 ID。

    ****96e8864746a0b6f3****

    UserData

    string

    否

    使用者自訂資料。

    {"test parameter": "test value"}

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    PlainResponse

    RequestId

    string

    請求 ID

    ******11-DB8D-4A9A-875B-275798******
    JobId

    string

    任務 ID

    ****20b48fb04483915d4f2cd8ac****

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "JobId": "****20b48fb04483915d4f2cd8ac****"
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。