全部產品
Search

搜尋本產品

    ApsaraVideo Live：ForbidLiveStream

    文件中心

    ApsaraVideo Live：ForbidLiveStream

    更新時間：Jun 22, 2026

    禁止某條流的推送，可以預設某個時刻將流恢復。

    介面說明

    呼叫本介面禁止某條流的推送，可以預設某個時刻將流恢復。如果沒有預設時間，請透過 ResumeLiveStream 介面恢復直播流。本介面目前僅支援 publisher（主播推流）。

    說明

    • 本介面透過添加黑名單的方式禁止直播流，上限為 10,000 路，超出限制將禁用失敗，請您注意統計當前禁用流的數量。請透過 DescribeLiveStreamsBlockList 介面查詢禁用流數量。

    • 若只中斷直播流，而不加入黑名單，則不會佔用黑名單中的 10000 個名額。

    QPS 限制

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

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:ForbidLiveStream

    update

    *All Resource

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    地域 ID。

    cn-shanghai
    DomainName

    string

    是

    推流域名。

    demo.aliyundoc.com
    AppName

    string

    是

    推流所屬應用名稱。您可在流管理頁面查看 AppName。

    liveApp****
    StreamName

    string

    是

    推流名稱。您可在流管理頁面查看 StreamName。

    liveStream****
    LiveStreamType

    string

    是

    用於指定禁止推流或者播流。目前僅支援禁止推流：publisher。

    枚舉值：

    • publisher :

      推流。

    publisher
    Oneshot

    string

    否

    是否只斷流不加入黑名單。取值：

    • yes：只斷流不加黑名單（支援上行推送或上行播流）。

    • no：斷流加入黑名單。

    說明

    不填預設為 no。

    枚舉值：

    • no :

      斷流加入黑名單。

    • yes :

      只斷流不加黑名單。

    yes
    ResumeTime

    string

    否

    恢復流的時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    說明

    • 當 Oneshot 參數為 no 時，ResumeTime 不傳值時預設禁止直播流指定時間為 6 個月。

    • 如果傳值則可在 ResumeTime 指定的時間點解除限制，恢復直播流。

    2015-12-01T10:37:00Z

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    16BFE188-B193-4C3C-ADC5-79A7E31486EA

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "16BFE188-B193-4C3C-ADC5-79A7E31486EA"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidResumeTime.Malformed Specified parameter ResumeTime is not valid.
    400 QuotaExceeded.Blacklist Exceed max blacklist count limit
    400 ConfigAlreadyExists Config has already exist.
    500 InternalError The request processing has failed due to backend service exception.

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

    變更歷史

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