すべてのプロダクト
Search

このプロダクト

    :AddLiveAppRecordConfig

    ドキュメントセンター

    :AddLiveAppRecordConfig

    最終更新日:Jan 08, 2026

    ライブ録画設定を構成し、出力を Object Storage Service (OSS) に保存します。

    操作説明

    • この API を使用する前に、ライブ録画の課金方法と料金を理解していることを確認してください。 詳細については、「ライブ録画の課金」をご参照ください。

    • 録画を OSS に保存するには、まず OSS サービスを有効化し、バケットを作成する必要があります。 手順については、「OSS への録画と保存」をご参照ください。

    • 録画ファイルを OSS に保存すると、別途請求されるストレージ料金が発生します。 詳細については、「ストレージ料金」をご参照ください。

    • ライブ録画機能を使用すると、ライブストリームを録画し、後で再生するために指定した場所に保存できます。 OSS に保存する場合、複数のフォーマット (TS、MP4、FLV、CMAF) と録画戦略 (自動、オンデマンド、手動) がサポートされています。 この API を使用して、録画テンプレートを設定します。 詳細については、「ライブ録画」をご参照ください。

    • 録画設定は、(DomainName、AppName、StreamName) の3つ組で一意に識別されます。 すでに設定が存在する 3つ組に対してこの API を呼び出すと、設定がすでに存在することを示すエラーが発生します。

    • この API を使用して設定した内容は、ストリームが再プッシュされた後にのみ有効になります。 一度有効になると、設定は無期限に有効です。

    QPS 制限

    この操作は、アカウントごとに毎秒 30 回まで呼び出すことができます。 この制限を超えるリクエストは破棄され、サービス中断が発生する可能性があります。

    今すぐお試しください

    この 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:AddLiveAppRecordConfig

    create

    *Domain

    acs:cdn:*:{#accountId}:domain/{#DomainName}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DomainName

    string

    必須

    ストリーミングドメイン。

    example.com
    AppName

    string

    必須

    ライブストリームの AppName。 この名前がアップストリーミング URL の AppName と一致する場合にのみ、テンプレートが適用されます。 アスタリスク (*) を使用して、すべての AppName に一致させます。

    liveApp****
    OssEndpoint

    string

    必須

    OSS ストレージのエンドポイント。 この機能を使用する前に、OSS バケットを作成する必要があります。 「OSS の設定」をご参照ください。

    oss-cn-beijing.aliyuncs.com
    OssBucket

    string

    必須

    ストレージ用の OSS バケットの名前。

    liveBucket****
    StreamName

    string

    任意

    ストリーム名。 この名前がアップストリーミング URL の StreamName と一致する場合にのみ、テンプレートが適用されます。 アスタリスク (*) を使用して、AppName 配下のすべてのストリームに一致させます。

    teststream
    StartTime

    string

    任意

    録画開始時刻。 フォーマット：yyyy-MM-ddTHH:mm:ssZ (UTC 時間)。

    説明

    このパラメーターは、ストリームレベルの録画 (つまり、StreamName が指定されている場合) にのみ有効です。 時刻は、実際のストリーム開始時刻から 7 日以内でなければなりません。

    2018-04-10T09:57:21Z
    EndTime

    string

    任意

    録画終了時刻。 フォーマット：yyyy-MM-ddTHH:mm:ssZ (UTC 時間)。

    説明

    このパラメーターは、ストリームレベルの録画にのみ有効です。 EndTime と StartTime の間隔は 7 日を超えることはできません。

    2018-04-16T09:57:21Z
    OnDemand

    integer

    任意

    録画モードを指定します。 有効な値：

    • 0 (デフォルト)：自動録画。

    • 1：HTTP コールバックによるオンデマンド録画。 事前に AddLiveRecordNotifyConfig 操作で OnDemandUrl を設定する必要があります。設定しない場合、録画はデフォルトで無効になります。

    • 2：アップストリーミング URL のパラメーターを解析することによるオンデマンド録画。

    • 7：手動録画、デフォルトでは無効です。 RealTimeRecordCommand API を介して手動で録画を開始または停止できます。

    1
    DelayTime

    integer

    任意

    中断後に録画をマージするためのウィンドウ (秒単位)。 ストリームがこのウィンドウ内で切断され再接続された場合、録画は同じファイルで継続されます。 有効な値：15～21600。

    180
    RecordFormat

    array<object>

    任意

    録画の詳細。

    object

    任意

    SliceDuration

    integer

    任意

    単一セグメントの期間。 単位：秒。

    重要

    このパラメーターは、RecordFormat.N.Format が m3u8 または cmaf に設定されている場合にのみ有効です。

    指定しない場合、デフォルト値は 30 秒です。 有効な値：5s～30s。

    30
    SliceOssObjectPrefix

    string

    任意

    セグメントの命名規則。

    重要

    このパラメーターは、RecordFormat.N.Format が m3u8 または cmaf に設定されている場合にのみ有効です。

    • デフォルトでは、各セグメントは 30 秒の長さで、256 バイト未満です。 サポートされる変数：{AppName}、{StreamName}、{UnixTimestamp}、{Sequence}。

    • 値には、{UnixTimestamp} と {Sequence} の変数を含める必要があります。

    record/{AppName}/{StreamName}/{UnixTimestamp}_{Sequence}
    CycleDuration

    integer

    任意

    単一の録画サイクルの期間 (秒単位)。

    説明

    • 指定しない場合、デフォルト値が使用されます。 録画フォーマットによってデフォルト値は異なります。m3u8 と cmaf フォーマットのデフォルトは 6 時間、flv と mp4 フォーマットのデフォルトは 1 時間です。

    • 録画サイクル中にライブストリームが中断されても、マージウィンドウ内に通常のストリーミングが再開された場合、録画は同じファイルで継続されます。

    • 録画ファイルは、ライブストリームがマージウィンドウより長く中断された場合にのみ生成されます。

    1
    OssObjectPrefix

    string

    任意

    OSS に保存される録画ファイルの命名規則。

    • ファイル名は 256 バイト未満である必要があります。 サポートされる変数：{AppName}、{StreamName}、{Sequence}、{StartTime}、{EndTime}、{EscapedStartTime}、{EscapedEndTime}。

    • 値には、{StartTime} または {EscapedStartTime} のいずれかと、{EndTime} または {EscapedEndTime} のいずれかを含める必要があります。

    record/{AppName}/{StreamName}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}
    Format

    string

    任意

    録画フォーマット。 有効な値：

    重要

    m3u8 または cmaf を選択した場合は、SliceOssObjectPrefix と SliceDuration も設定する必要があります。

    • m3u8

    • flv

    • mp4

    • cmaf

    m3u8
    TranscodeRecordFormat

    array<object>

    任意

    トランスコード録画の詳細。

    object

    任意

    SliceDuration

    integer

    任意

    トランスコードされたストリーム録画の単一セグメントの期間。 単位：秒。

    重要

    このパラメーターは、TranscodeRecordFormat.N.Format が m3u8 または cmaf に設定されている場合にのみ有効です。

    指定しない場合、デフォルト値は 30 秒です。 有効な値：5s～30s。

    30
    SliceOssObjectPrefix

    string

    任意

    トランスコードされたストリームのセグメントの命名規則。

    重要

    このパラメーターは、TranscodeRecordFormat.N.Format が m3u8 または cmaf に設定されている場合にのみ必須です。

    • デフォルトでは、各セグメントは 30 秒の長さです。 ファイル名は 256 バイト未満である必要があります。 サポートされる変数：{AppName}、{StreamName}、{UnixTimestamp}、{Sequence}。

    • 値には、{UnixTimestamp} と {Sequence} の変数を含める必要があります。

    record/{AppName}/{StreamName}/{UnixTimestamp}_{Sequence}
    CycleDuration

    integer

    任意

    単一の録画サイクルの期間 (秒単位)。

    説明

    指定しない場合、デフォルト値が使用されます。 録画フォーマットによってデフォルト値は異なります。m3u8 と cmaf フォーマットのデフォルトは 6 時間、flv と mp4 フォーマットのデフォルトは 1 時間です。

    21600
    OssObjectPrefix

    string

    任意

    トランスコードされたストリームの OSS に保存される録画ファイルの命名規則。

    • ファイル名は 256 バイト未満である必要があります。 サポートされる変数：{AppName}、{StreamName}、{Sequence}、{StartTime}、{EndTime}、{EscapedStartTime}、{EscapedEndTime}。

    • 値には、{StartTime} または {EscapedStartTime} のいずれかと、{EndTime} または {EscapedEndTime} のいずれかを含める必要があります。

    record/{AppName}/{StreamName}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}
    Format

    string

    任意

    トランスコードされたストリーム録画のフォーマット。 有効な値：

    重要

    m3u8 または cmaf フォーマットを選択した場合は、TranscodeRecordFormat.N.SliceOssObjectPrefix および TranscodeRecordFormat.N.SliceDuration リクエストパラメーターも設定する必要があります。

    • m3u8

    • flv

    • mp4

    • cmaf

    m3u8
    TranscodeTemplates

    array

    任意

    トランスコーディングテンプレートグループ。

    sd

    string

    任意

    • トランスコーディングテンプレート。 最大 10 個のテンプレートを設定できます。

    • TranscodeRecordFormat.N.xxx 設定を行う場合、少なくとも 1 つの TranscodeTemplates を設定する必要があります。

    • 複数の、またはすべてのトランスコードされたストリームを録画するには、TranscodeTemplates.1 を ***** (5つのアスタリスク) に設定します。

    説明

    TranscodeTemplates には、予約済みの識別子である raw を渡すことはできません。
    TranscodeTemplates.N の .N は、複数のテンプレートを指定するための増分インデックスを表します。 例：TranscodeTemplates.1=sd、TranscodeTemplates.2=hd。

    sd

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    16A96B9A-F203-4EC5-8E43-CB92E68F****

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidOssEndpoint.Malformed %s
    400 InvalidOssBucket.Malformed Specified parameter OssBucket is not valid.
    400 InvalidOssBucket.NotFound The parameter OssBucket does not exist.
    400 InvalidFormat.Malformed Specified parameter Format is not valid.
    400 InvalidCycleDuration.Malformed Specified CycleDuration Format is not valid.
    400 InvalidSliceDuration.Malformed Specified SliceDuration Format is not valid.
    400 InvalidTemplateLength.Malformed Specified record template length is not valid.
    400 InvalidTemplate.ForbidRaw Template named raw is Forbidden.
    400 MissingTemplate Template is mandatory for this action.
    400 MissingOssObjectPrefix OssObjectPrefix is mandatory for this action.
    400 MissingSliceOssObjectPrefix SliceOssObjectPrefix is mandatory for this action.
    400 InvalidOssObjectPrefix.Malformed Specified parameter OssObjectPrefix is not valid.
    400 InvalidSliceOssObjectPrefix.Malformed Specified parameter SliceOssObjectPrefix is not valid.
    400 ConfigAlreadyExists Config has already exist.
    400 InvalidFormat.IllegalOperation Specified parameter Format can not be multiple.
    400 InvalidDelayTime Specified Delaytime is invalid.
    400 Live2Vod.ConfigAlreadyExists Had live2vod record config already.
    400 InvalidStartTime.Malformed Specified StartTime is malformed.
    400 InvalidEndTime.Malformed Specified EndTime is malformed.
    400 InvalidEndTime.Mismatch Specified EndTime does not math the specified StartTime or current time.
    400 InvalidStartTime.Mismatch Specified StartTime does not math the current time.

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

    変更履歴

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