ライブストリームの取り込みを無効にします。

使用上の注意

この操作を呼び出して、ライブストリームの取り込みを無効にし、取り込みを有効にできる時間を指定できます。 時間が指定されていない場合は、ResumeLiveStream操作を呼び出して、ライブストリームの取り込みを有効にします。 この操作は、ストリーマーによって取り込まれたライブストリームのみをサポートします。

注 最大10,000のライブストリームの取り込みを無効にできます。 制限に達した場合、過剰なライブストリームの取り込みを無効にすることはできません。 取り込みを無効にするライブストリームの数に注意してください。 DescribeLiveStreamsBlockList操作を呼び出して、取り込みを無効にしたライブストリームの数を照会できます。

Limits on QPS

この操作は、アカウントごとに1秒あたり最大200回呼び出すことができます。 1秒あたりの呼び出し数が制限を超えると、スロットリングがトリガーされます。 This may affect your business. この操作を呼び出すときは、制限に注意することをお勧めします。 詳細については、「ApsaraVideo LiveのAPI操作のQPS制限」をご参照ください。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 ForbidLiveStream

実行する操作です。 値をForbidLiveStreamに設定します。

AppName String 必須 liveApp ****

The application to which the live stream belongs.

DomainName String 必須 demo.aliyundoc.com

取り込みドメイン。

LiveStreamType String 必須 出版社

ライブストリームをストリーマーで取り込むか、クライアントで再生するかを指定します。 値をpublisherに設定します。

StreamName String 必須 liveStream ****

取り込みを無効にするライブストリームの名前。

RegionId String 任意 cn-beijing

取り込みドメインが存在するリージョンのID。

オネショット String 任意 はい

Specifies whether to disable the ingest without adding the ingest URL of the live stream to the blacklist. 設定可能な値は以下のとおりです。

  • yes: 取り込みを無効にしますが、ライブストリームの取り込みURLをブラックリストに追加しないでください。 この値は、ライブストリームが上流で取り込まれたり再生されたりする場合にのみ使用できます。
  • no: 取り込みを無効にし、ライブストリームの取り込みURLをブラックリストに追加します。
注 デフォルト値: no。
ResumeTime String 任意 2015-12-01T10:37:00Z

ライブストリームに対して取り込みを有効にできる時刻。 yyyy-MM-dd T HH:mm:ss Z形式のISO 8601標準で時刻を指定します。 時間は UTC にする必要があります。

重要

Oneshotパラメーターがnoに設定されている場合、ResumeTimeパラメーターを空のままにすることで、ライブストリームの取り込みを永久に無効にできます。

ResumeTimeパラメーターに値を指定すると、指定した時間に取り込みURLがブラックリストから削除され、ライブストリームの取り込みが有効になります。

レスポンスパラメーター

パラメーター データ型 例 説明
RequestId String 16BFE188-B193-4C3C-ADC5-79A7E31486EA

リクエストの ID です。

例

リクエストの例

http(s):// live.aliyuncs.com/?Action=ForbidLiveStream
&AppName=liveApp ****
&DomainNam e=demo.aliyundoc.com
&LiveStreamType=publisher
&StreamName=liveStream ****
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式 

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

JSON 形式 

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

エラーコード

HttpCode エラーコード エラーメッセージ 説明
400 InvalidResumeTime。奇形 指定されたパラメーターResumeTimeは無効です。 ResumeTimeパラメーターの値が無効な場合に返されるエラーメッセージ。 有効な値を指定します。
400 QuotaExceeded.Blacklist 最大ブラックリスト数制限を超える ブラックリスト内のアイテム数が上限を超えた場合に返されるエラーメッセージ。
400 ConfigAlreadyExists Configはすでに存在しています。 既存の構成が見つかった場合に返されるエラーメッセージ。

エラーコードリストについては、「API エラーセンター」をご参照ください。