調用ForbidLiveStream禁止直播流。

使用說明

調用本接口禁止某條流的推送,可以預設某個時刻將流恢復。如果沒有預設時間,請通過ResumeLiveStream接口接口恢復直播流。本接口目前僅支持publisher(主播推流)。

說明 禁止直播流的上限為10,000路,超出限制將禁用失敗,請您注意統計當前禁用流的數量。請通過DescribeLiveStreamsBlockList接口查詢禁用流數量。

QPS限制

本接口的單用戶QPS限制為20次/秒。超過限制,API調用會被限流,這可能會影響您的業(yè)務,請合理調用。更多信息,請參見QPS限制

調試

您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。

調試

您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String ForbidLiveStream

系統規(guī)定參數。取值:ForbidLiveStream

DomainName String demo.aliyundoc.com

推流域名。

AppName String liveApp****

推流所屬應用名稱。

StreamName String liveStream****

推流名稱。

LiveStreamType String publisher

用于指定主播推流還是客戶端播流。目前僅支持:publisher(主播推流)。

Oneshot String yes

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

  • yes:只斷流不加黑名單(支持上行推送或上行播流)。
  • no:斷流加入黑名單。
說明 不填默認為no。
ResumeTime String 2015-12-01T10:37:00Z

恢復流的時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC時間)。

說明
  • Oneshot參數為no時,ResumeTime不傳值時默認禁止直播流指定時間為6個月。
  • 如果傳值則可在ResumeTime指定的時間點解除限制,恢復直播流。

返回數據

名稱 類型 示例值 描述
RequestId String 16BFE188-B193-4C3C-ADC5-79A7E31486EA

請求ID。

示例

請求示例

http(s)://live.aliyuncs.com/?Action=ForbidLiveStream
&DomainName=demo.aliyundoc.com
&AppName=liveApp****
&StreamName=liveStream****
&LiveStreamType=publisher
&公共請求參數 HTTP/1.1

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ForbidLiveStreamResponse>
    <RequestId>16BFE188-B193-4C3C-ADC5-79A7E31486EA</RequestId>
</ForbidLiveStreamResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

錯誤碼

HttpCode 錯誤碼 錯誤信息 描述
400 InvalidResumeTime.Malformed Specified parameter ResumeTime is not valid. ResumeTime參數錯誤,請您確認該ResumeTime參數是否正確。
400 QuotaExceeded.Blacklist Exceed max blacklist count limit 超過黑名單最大數量
400 ConfigAlreadyExists Config has already exist. 配置已添加。

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