すべてのプロダクト
Search

このプロダクト

    ApsaraVideo Live:SetCasterConfig

    ドキュメントセンター

    ApsaraVideo Live:SetCasterConfig

    最終更新日:May 07, 2026

    この操作を呼び出して、プロダクションスタジオの名前、トランスコード構成、録画構成、およびその他のパラメーターを詳細に設定します。

    操作説明

    この操作を呼び出す前に、CreateCaster 操作を呼び出してプロダクションスタジオを作成しておく必要があります。この操作は、既存のすべての構成を置き換えます。パラメーターを空の値に設定した場合、そのパラメーターの既存の構成はクリアされます。

    QPS 制限

    単一ユーザーの秒間クエリ数 (QPS) 制限は 1 秒あたり 10 回です。この制限を超える 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:SetCasterConfig

    update

    *Caster

    acs:live:*:{#accountId}:caster/{#CasterId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    リージョン ID です。

    cn-shanghai
    CasterId

    string

    必須

    プロダクションスタジオの ID です。

    • CreateCaster 操作を呼び出してプロダクションスタジオを作成した場合は、応答で返された CasterId の値を使用します。

    • ApsaraVideo Live コンソールでプロダクションスタジオを作成した場合は、ApsaraVideo Live コンソール > プロダクションスタジオ > クラウドプロダクションスタジオ ページに移動して ID を確認します。

    説明

    クラウドプロダクションスタジオページのリストに表示されるプロダクションスタジオの名前が、プロダクションスタジオ ID です。

    a2b8e671-2fe5-4642-a2ec-bf93880e****
    CasterName

    string

    任意

    プロダクションスタジオの名前です。

    liveCaster****
    DomainName

    string

    任意

    ストリーマーのストリーミングドメインです。

    プロダクションスタジオを起動する前にドメイン名を設定してください。このパラメーターを空にした場合、プロダクションスタジオのドメイン名構成はクリアされます。

    example.com
    TranscodeConfig

    string

    任意

    トランスコード構成です。

    JSON 文字列です。構造体のフィールドは UpperCamelCase にする必要があります。このパラメーターを空にした場合、トランスコード構成はクリアされます。トランスコーディングテンプレートが指定されていない場合、プロダクションスタジオを起動するとエラーが報告されます。

    {"casterTemplate": "lp_ld"}
    RecordConfig

    string

    任意

    録画構成です。このパラメーターは JSON 文字列です。要素は次のとおりです。

    • endpoint：Alibaba Cloud サービスの API エンドポイントです。

    • ossBucket：OSS バケットの名前です。

    • videoFormat：エクスポート可能な動画のファイル形式です。例：[{\"OssObjectPrefix\":\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"m3u8\",\"CycleDuration\":21600,\"SliceOssObjectPrefix\":\"record/{AppName}/{StreamName}/{UnixTimestamp}\"},{\"OssObjectPrefix\":\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"flv\",\"CycleDuration\":21600}]。

    • interval：時間間隔です。単位はミリ秒 (ms) です。

    説明

    このパラメーターを空にした場合、録画機能は無効化され、既存の録画構成はクリアされます。

    { "endpoint": "http://oss-cn-********.aliyuncs.com/api", "ossBucket****": "liveBucket****", "VideoFormat":[{\"OssObjectPrefix\":\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"m3u8\",\"CycleDuration\":21600,\"SliceOssObjectPrefix\":\"record/{AppName}/{StreamName}/{UnixTimestamp}\"},{\"OssObjectPrefix\":\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"flv\",\"CycleDuration\":21600}] "interval": 5 }
    Delay

    number

    任意

    ストリーム遅延です。単位は秒です。

    • 0 (デフォルト)：ストリーム遅延を無効化します。

    • 0 より大きい値：ストリーム遅延を有効化します。

    • 空：ストリーム遅延構成をクリアします。

    説明

    最大値は 300 です。

    0
    UrgentMaterialId

    string

    任意

    スタンバイビデオの ID です。これはメディアアセットです。このパラメーターを空にした場合、スタンバイビデオ構成はクリアされます。

    a2b8e671
    UrgentLiveStreamUrl

    string

    任意

    スタンバイライブストリームの URL です。

    rtmp://demo.aliyundoc.com
    SideOutputUrl

    string

    任意

    プロダクションスタジオからのバイパス出力用のカスタムアップストリーミング URL です。このパラメーターを空にした場合、システムは自動生成されたアップストリーミング URL を出力に使用します。

    説明

    SideOutputUrl パラメーターは、RTMP 経由のアップストリーミングのみをサポートします。

    rtmp://****/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****
    SideOutputUrlList

    string

    任意

    マルチチャネルアップストリーミング用のアップストリーミング URL リストです。URL は Alibaba Cloud CDN またはサードパーティ CDN のアップストリーミング URL です。プロダクションスタジオには最大 20 個の RTMP アップストリーミング URL を追加できます。

    説明

    複数の URL を配列で指定します。例：["rtmp://domain/app1/stream1","rtmp://domain/app2/stream2"]。

    rtmp://domain/app/stream?***
    CallbackUrl

    string

    任意

    Webhook アドレスです。コールバック通知を受信するには、HTTP リクエストを受け付ける有効なアドレスを入力します。このパラメーターを空にした場合、プロダクションスタジオのコールバック通知はキャンセルされます。

    説明

    プロダクションスタジオのコールバックの詳細については、「プロダクションスタジオのコールバック情報」をご参照ください。

    http://****/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****
    ProgramEffect

    integer

    任意

    カルーセルが有効かどうかを示すフラグです。

    • 0：無効です。

    • 1：有効です。

    1
    ProgramName

    string

    任意

    カルーセルの名前です。カルーセル機能を使用する場合にこのパラメーターを設定できます。

    program_name
    ChannelEnable

    integer

    任意

    チャンネルを有効化するかどうかを指定します。

    • 0 (デフォルト)：チャンネルを無効化します。

    • 1：チャンネルを有効化します。

    説明

    デフォルトでは、この機能は無効になっています。この機能を有効化すると、再度無効化することはできません。チャンネルが無効の場合、レイアウトはリソースを直接参照します。初めてチャンネルを有効化するには、プロダクションスタジオが停止状態である必要があります。既存のレイアウトは破棄されます。まず、チャンネルにリソースを追加する必要があります。新しいレイアウトはチャンネルを直接参照します。チャンネルを使用して、ビデオソースの再生進捗やステータスを調整できます。このモードでは、ビデオソース、プレビュー (PVW) エリア、プログラム (PGM) エリアが同じリソースを参照している場合、画面は同期されたままになります。

    1
    SyncGroupsConfig

    string

    任意

    マルチビュー同期の構成です。複数のビデオソースを同期します。マルチビュー同期には次の 2 つのモードがあります。

    • mode：0 (ストリーマーモード。複数のビデオソースは指定されたモードに基づいて同期されます。)

    • mode：1 (会議モード。すべてのビデオソースが相互に同期されます。ストリーマービデオの概念はありません。)

    ストリーマーモード：hostResourceId パラメーターは、ストリーマーのビデオソースを指定します。

    会議モード：hostResourceId パラメーターは使用しません。resourceIds パラメーターでリソース ID を提供するだけで済みます。

    "[{\"mode\":0,\"resourceIds\":[\"5a6c1c33-8424-46f6-813c-c152220a****\",\"4e6521dc-a40a-4077-b6bf-1fb12a76****\"],\"hostResourceId\":\"3aa2b39a-fd0e-4b8c-be73-b7af31c4****\"}]"
    UrgentImageId

    string

    任意

    スタンバイイメージの ID です。これはメディアアセットです。

    a089175eb5f4427684fc0715159a****
    UrgentImageUrl

    string

    任意

    スタンバイイメージの URL です。

    http://learn.aliyundoc.com/AppName/image.jpg
    AutoSwitchUrgentOn

    boolean

    任意

    スタンバイリソースへの自動切り替えを有効化するかどうかを指定します。

    • true：有効化します。

    • false：無効化します。

    true
    AutoSwitchUrgentConfig

    string

    任意

    スタンバイリソースへの自動切り替えの構成です。eofThres：ストリームが中断された後、スタンバイリソースに自動的に切り替わるまでの時間です。単位は秒です。

    {"eofThres":3}

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    CasterId

    string

    プロダクションスタジオの ID です。この ID を使用して、アップストリーミング URL の照会、スタジオの起動、ビデオリソースの追加、レイアウトの追加、レイアウトの照会、コンポーネントの追加、プレイリストの追加が可能です。

    b4810848-bcf9-4aef-bd4a-e6bba2d9****
    RequestId

    string

    リクエスト ID です。

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

    例

    成功レスポンス

    JSONJSON

    {
  "CasterId": "b4810848-bcf9-4aef-bd4a-e6bba2d9****",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidUserId.Malformed %s, please check userId.
    400 InvalidCasterId.Malformed %s, please check and try again later.
    400 InvalidParameter.Malformed There are invalid parameters: %s.
    400 IncorrectCasterStatus.Inuse %s, please check and try again later.
    400 MissingParameter %s.
    400 InvalidCaster.ChannelDisableUnsupported %s, please check.
    400 IncorrectCasterStatus.EnableChannel %s, please check and try again later.
    403 PermissionDenied %s, please check and try again later.
    404 InvalidCaster.NotFound %s, please check and try again later.
    404 InvalidDomainName.NotFound %s, please check and try again later.

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

    変更履歴

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