すべてのプロダクト
Search

このプロダクト

    ApsaraVideo Live:ForbidLiveStream

    ドキュメントセンター

    ApsaraVideo Live:ForbidLiveStream

    最終更新日:Jun 22, 2026

    指定されたストリームのアップストリーミングを無効にします。ストリームを再開する時間を事前に設定できます。

    操作説明

    この操作を呼び出して、指定されたストリームのアップストリーミングを無効にします。ストリームを再開する時間を事前に設定できます。事前設定された時間が指定されていない場合は、 ResumeLiveStream 操作を呼び出してライブストリームを再開します。この操作は現在、パブリッシャー（ストリーマーのアップストリーミング）のみをサポートしています。

    説明

    • この操作は、ライブストリームをブラックリストに追加することで無効にします。上限は 10,000 ストリームです。この制限を超えると、無効化操作は失敗します。現在無効になっているストリームの数をモニターしてください。 DescribeLiveStreamsBlockList 操作を呼び出して、無効なストリームの数をクエリします。

    • ライブストリームをブラックリストに追加せずに中断するだけの場合、そのストリームは 10,000 ストリームのブラックリストクォータにカウントされません。

    QPS 制限

    この操作のユーザーあたりの最大値クエリ毎秒 (QPS) は 20 です。この制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。この操作を適切に呼び出してください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    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

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    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.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。