全部產品
Search

搜尋本產品

    ApsaraVideo Live：UpdateLiveAppSnapshotConfig - 更新直播截圖配置

    文件中心

    ApsaraVideo Live：UpdateLiveAppSnapshotConfig - 更新直播截圖配置

    更新時間：Dec 13, 2025

    更新直播流下的截圖配置。輸出內容儲存到OSS中，重新推流後生效。

    介面說明

    調用本介面更新播流下的截圖配置。輸出內容儲存到 OSS 中，重新推流後生效。

    QPS 限制

    本介面的單使用者 QPS 限制為 30 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:UpdateLiveAppSnapshotConfig

    update

    *Domain

    acs:cdn:*:{#accountId}:domain/{#DomainName}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DomainName

    string

    是

    主播流網域名稱。

    example.com
    AppName

    string

    是

    播流所屬應用程式名稱。

    liveApp****
    TimeInterval

    integer

    否

    截圖周期。取值範圍：5~3600。單位：秒。

    5
    OssEndpoint

    string

    否

    OSS 儲存的 Endpoint 名稱。

    cn-oss-****.aliyuncs.com
    OssBucket

    string

    否

    OSS 儲存 Bucket 名稱。

    liveBucket****
    OverwriteOssObject

    string

    否

    覆蓋截圖隱藏檔名。每次截圖都覆蓋此檔案。

    • 小於 256 Byte。

    • 目前僅支援產生 JPG 圖片。

    • 支援變數匹配，包含 {AppName}、{StreamName}。

    • 傳入短劃線（-），表示刪除此欄位。

    {liveApp****}/{liveStream****}.jpg
    SequenceOssObject

    string

    否

    即時截圖隱藏檔名。每次截圖都遞增儲存，調用 DescribeLiveStreamSnapshotInfo 介面，可以查詢某一段時間的檔案。

    • 小於 256 Byte。

    • 目前僅支援產生 JPG 圖片。

    • 支援變數匹配，包含 {AppName}、{StreamName}、{UnixTimestamp}、{Sequence}，其中 {UnixTimestamp}、{Sequence} 必填一個。

    • 傳入短劃線（-），表示刪除此欄位。

    snapshot/{liveApp****}/{liveStream****}/{UnixTimestamp****}.jpg
    Callback

    string

    否

    截圖回調地址。

    https://learn.aliyundoc.com

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

    異常返回樣本

    JSON格式

    {
    "Code":"InternalError",
    "HostId":"live.aliyuncs.com",
    "Message":"The request processing has failed due to some unknown error.",
    "RequestId":"6EBD1AC4-C34D-4AE1-963E-B688A228BE31"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidOverwriteOssObjectOrSequenceOssObject.Malformed Specified paramters OverwriteOssObject or SequenceOssObject should have one. OverwriteOssObject與SequenceOssObject參數任選其一。
    400 InvalidOssEndpoint.Malformed Specified parameter OssEndpoint is not valid.
    400 InvalidOssBucket.Malformed Specified parameter OssBucket is not valid. OSSBucket參數錯誤，請您確認該OSS BUCKET參數是否正確。
    400 InvalidOssBucket.NotFound The parameter OssBucket does not exist.
    400 InvalidOverwriteOssObject.Malformed Specified parameter OverwriteOssObject is not valid. OverwriteOSSObject參數錯誤，請您確認該OverwriteOSSObject參數是否正確。
    400 InvalidSequenceOssObject.Malformed Specified parameter SequenceOssObject is not valid. SequenceOssObject參數錯誤，請您確認該SequenceOssObject參數是否正確。
    400 InvalidConfig.NotFound The speicified config does not exist.

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

    變更歷史

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