すべてのプロダクト
Search

このプロダクト

    ApsaraVideo Live:AddLiveAppRecordConfig

    ドキュメントセンター

    ApsaraVideo Live:AddLiveAppRecordConfig

    最終更新日:Jul 14, 2026

    アプリケーションサービスの録画を設定し、出力を Object Storage Service (OSS) に保存します。

    操作説明

    • この操作を使用する前に、ライブストリーム録画の課金メソッドと料金を完全に理解していることを確認してください。請求明細については、「ライブストリーム録画料金」をご参照ください。

    • ライブストリーム録画の設定に OSS への録画保存方式を使用する場合は、OSS を有効化してバケットを作成する必要があります。詳細については、「OSS の設定」をご参照ください。

    • OSS に保存された録画にはストレージ料金が発生します。OSS の請求明細については、「ストレージ料金」をご参照ください。

    • OSS バケットは、ストリーミングドメインのライブセンターと同じリージョンにある必要があります。クロスリージョン録画はサポートされていません。

    • ライブストリーム録画機能は、ライブコンテンツを録画し、オンデマンド再生のために指定された場所に保存します。OSS に保存される録画は、複数のコンテナフォーマット (TS、MP4、FLV、CMAF) とカスタム録画ポリシー (自動録画、オンデマンド録画、手動録画) をサポートしています。この操作を呼び出して録画テンプレートを設定します。ライブストリーム録画の詳細については、「ライブストリーム録画」をご参照ください。

    • 三要素 (DomainName、AppName、StreamName) に対応できる設定は 1 つだけです。三要素に対する設定が既に存在する場合、この操作を呼び出して別の設定を追加すると、設定既存エラーが返されます。

    • この操作で設定された構成は、ライブストリームが再アップストリーミングされた後にのみ効果があり、永続的に有効なままです。

    QPS 制限

    この操作の単一ユーザー QPS 制限は、1 秒あたり 30 回の呼び出しです。この制限を超えると、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:AddLiveAppRecordConfig

    create

    *Domain

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DomainName

    string

    必須

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

    example.com
    AppName

    string

    必須

    ストリームが属するアプリケーションの名前。このテンプレートは、AppName の値がアップストリーミング URL 内の AppName と一致する場合にのみ効果があります。すべてのアプリケーション名に一致させるには、このパラメーターをアスタリスク (*) にセットします。

    liveApp****
    OssEndpoint

    string

    必須

    OSS バケットのエンドポイント。

    ライブ録画を OSS に保存するには、事前に OSS バケットを作成してください。詳細については、「OSS の設定」をご参照ください。

    oss-cn-beijing.aliyuncs.com
    OssBucket

    string

    必須

    OSS バケットの名前。

    ライブ録画を OSS に保存するには、事前に OSS バケットを作成してください。詳細については、「OSS の設定」をご参照ください。

    liveBucket****
    StreamName

    string

    任意

    ストリーム名。このテンプレートは、StreamName の値がアップストリーミング URL 内の StreamName と一致する場合にのみ効果があります。指定された AppName 配下のすべてのストリーム名に一致させるには、このパラメーターをアスタリスク (*) にセットします。

    teststream
    StartTime

    string

    任意

    録画の開始時刻。フォーマット: yyyy-MM-ddTHH:mm:ssZ (協定世界時 (UTC))。

    説明

    指定された時間は、実際のストリームアップストリーミング開始時間から 7 日以内である必要があります。このパラメーターは、ストリームレベルの録画 (StreamName が空でない場合) にのみ有効です。

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

    string

    任意

    録画の終了時刻。フォーマット: yyyy-MM-ddTHH:mm:ssZ (協定世界時 (UTC))。

    説明

    EndTime と StartTime の差は 7 日を超えることはできません。7 日を超える場合、値は 7 日として計算されます。このパラメーターは、ストリームレベルの録画 (StreamName が空でない場合) にのみ有効です。

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

    integer

    任意

    オンデマンドまたは手動録画モード。有効な値:

    • 0 (デフォルト): 無効。自動録画が使用されます。

    • 1: HTTP コールバックによるオンデマンド録画。まず AddLiveRecordNotifyConfig 操作を呼び出して OnDemandUrl を設定する必要があります。そうしないと、デフォルトでは録画は実行されません。

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

    • 7: 手動録画。デフォルトでは録画は実行されません。 RealTimeRecordCommand 操作を呼び出して、手動で録画を開始または停止できます。

    1
    DelayTime

    integer

    任意

    ストリーム中断のマージ持続時間。ライブストリームの切断時間が指定されたマージ持続時間を超えた場合、新しいファイルが生成されます。有効な値: 15 ～ 21600。単位: 秒。

    180
    RecordFormat

    array<object>

    任意

    録画の詳細。

    object

    任意

    SliceDuration

    integer

    任意

    単一セグメントのセグメントの長さ。単位: 秒。

    重要 このパラメーターは、RecordFormat.N.Format が m3u8 または cmaf にセットされている場合にのみ効果があります。

    このパラメーターが指定されていない場合、デフォルト値は 30 秒です。有効な値: 5 ～ 30。

    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、FLV、MP4、CMAF がサポートされています。有効な値:

    重要 RecordFormat と TranscodeRecordFormat の少なくとも一方をセットする必要があります。m3u8 または cmaf を選択した場合、リクエストパラメーター RecordFormat.N.SliceOssObjectPrefix および RecordFormat.N.SliceDuration もセットする必要があります。

    • m3u8。

    • flv。

    • mp4。

    • cmaf。

    説明

    RecordFormat および TranscodeRecordFormat の設定項目: 少なくとも一方を指定する必要があります。

    m3u8
    TranscodeRecordFormat

    array<object>

    任意

    トランスコード済みストリームの録画詳細。

    object

    任意

    SliceDuration

    integer

    任意

    トランスコード済みストリーム録画における単一セグメントのセグメントの長さ。単位: 秒。

    重要 このパラメーターは、TranscodeRecordFormat.N.Format (トランスコード済みストリーム録画フォーマット) が m3u8 または cmaf にセットされている場合にのみ効果があります。

    このパラメーターが指定されていない場合、デフォルト値は 30 秒です。有効な値: 5 ～ 30。

    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、FLV、MP4、CMAF がサポートされています。有効な値:

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

    • m3u8。

    • flv。

    • mp4。

    • cmaf。

    説明

    設定項目: m3u8 または cmaf フォーマットを選択した場合、対応するスライスパラメーターも設定する必要があります。

    m3u8
    TranscodeTemplates

    array

    任意

    トランスコード済みストリーム録画用のトランスコーディングテンプレートグループ。

    sd

    string

    任意

    • トランスコード済みストリーム録画用のトランスコーディングテンプレート。最大 10 個のテンプレートを指定できます。

    • TranscodeRecordFormat.N.xxx が設定されている場合、少なくとも 1 つの TranscodeTemplates 値を指定する必要があります。

    • 複数またはすべてのトランスコード済みストリームを録画するには、TranscodeTemplates.1 を ***** にセットします。

    説明

    TranscodeTemplates では値 raw は許可されていません。これは予約済みの識別子です。
    RepeatList は 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. OSSBucket パラメーターが無効です。OSS BUCKET パラメーターが正しいことを確認してください。
    400 InvalidOssBucket.NotFound The parameter OssBucket does not exist.
    400 InvalidFormat.Malformed Specified parameter Format is not valid. Format パラメーターが無効です。Format パラメーターが正しいことを確認してください。
    400 InvalidCycleDuration.Malformed Specified CycleDuration Format is not valid. CycleDuration パラメーターのフォーマットが無効です。CycleDuration パラメーターのフォーマットが正しいことを確認してください。
    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. SliceOssObjectPrefix パラメーターが無効です。SliceOssObjectPrefix パラメーターが正しいことを確認してください。
    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.

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

    変更履歴

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