CreateLiveStreamRecordIndexFiles_视频直播_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

您已配置 OSS,具体操作,请参见配置 OSS。 直播录制索引是将视频直播流以 M3U8 的格式进行录制,存储在 OSS 中后,对已存储的 TS 分片索引文件进行实时的剪辑处理。

说明
  • 创建录制索引必保证直播流发生过推流行为,如果设置的时间内未发生过直播或直播流名称错误等会导致创建录制索引失败。
  • StartTime 和 EndTime 的差值至少是一片 TS 的时长(默认为 30s)。
  • TS 分片信息在视频直播系统中仅保存 3 个月,创建 M3U8 文件只能选择最近 3 个月的录制内容。
  • TS 分片文件存储在 OSS 中,保存时间由 OSS 的存储配置决定。详细信息,请参见设置生命周期规则
  • 创建好的 M3U8 索引文件的信息在视频直播系统中仅保存 6 个月,若要查询仅能查询 6 个月内创建的索引文件的信息。
  • M3U8 索引文件存储在 OSS 中,保存时间由 OSS 的存储配置决定。
  • QPS 限制

    本接口的单用户 QPS 限制为 45 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

    流控信息

    请求速率为100/1(s)。

    授权信息

    如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

    具体说明如下:展开详情

    操作访问级别资源类型条件关键字关联操作
    live:CreateLiveStreamRecordIndexFiles
    Create
    Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}

    请求参数

    字段名称字段详情
    DomainNamestring

    主播流域名。

    示例值:example.com参考取值来源:
      AddLiveDomain
      DescribeDomainUsageData
      ListLiveRealtimeLogDeliveryDomains
    AppNamestring

    播流所属应用名称。AppName 名称与推流地址中的 AppName 名称对应,模板才能生效。若不限制 AppName 可填*,即可匹配所有 AppName。

    示例值:liveApp****参考取值来源:
      GetMessageApp
      ListMessageApp
      QueryMessageApp
      CreateMessageApp
    StreamNamestring

    播流名称。StreamName 名称与推流地址中的 StreamName 名称对应,模板才能生效。若不限制 StreamName 可填*,即可匹配所有 StreamName。

    示例值:liveStream****参考取值来源:
      AddLiveStreamMerge
      DescribeMixStreamList
      QueryLiveDomainMultiStreamList
    OssEndpointstring

    OSS 存储 Endpoint 名称。

    示例值:cn-oss-****.aliyuncs.com
    OssBucketstring

    OSS 存储 Bucket 名称。

    示例值:liveBucket****
    OssObjectstring

    OSS 存储的录制文件名。

    示例值:{AppName}/{StreamName}/{Date}/{Hour}/{Minute}_{Second}.m3u8
    StartTimestring

    索引文件的开始时间。ts 文件的上传时间在此之后则会被包含进索引文件。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

    示例值:2017-12-21T08:00:00Z
    EndTimestring

    索引文件的结束时间。ts 文件的上传时间在此之前则会被包含进索引文件。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

    示例值:2017-12-22T08:00:00Z
    EndTimeIncludedboolean

    是否包含结束时间。传 true 会尝试多包含一个 ts 文件,创建的索引文件会完整覆盖 StartTime 和 EndTime。

    示例值:false

    返回参数

    字段名称字段详情
    RequestIdstring

    请求 ID。

    示例值:550439A3-F8EC-4CA2-BB62-B9DB43EEEF30
    RecordInfoobject

    录制配置信息。

    返回示例

    错误码

    全局错误码
    HTTP 状态码错误码错误信息操作
    400
    InvalidStartTime.Mismatch
    Specified StartTime does not math the current time.诊断
    400
    InvalidStartTime.Malformed
    Specified StartTime is malformed.诊断
    400
    InvalidParams
    invalid params诊断
    400
    InvalidEndTime.Malformed
    Specified EndTime is malformed.诊断
    400
    InvalidEndTime.Mismatch
    Specified end time does not math the specified start time.诊断
    400
    InvalidOssEndpoint.Malformed
    Specified OssEndpoint is malformed.诊断
    400
    InvalidOssBucket.Malformed
    Specified OssBucket is malformed.诊断
    400
    InvalidOssObject.Malformed
    Specified OssObject is malformed.诊断
    400
    InvalidStream.NotFound
    Speicified stream does not exist.诊断
    400
    InvalidConfig.Changed
    The oss bucket info between StartTime and EndTime has changed.诊断
    400
    NoRecordContent
    The record content between StartTime and EndTime is empty.诊断
    400
    RecordContentExceed
    The record content between StartTime and EndTime is exceeded, please narrow down the range.诊断
    400
    OperationNotSupport
    The Operation is not support for flv/mp4 format or live to vod record.诊断
    404
    InvalidBucket.NotFound
    The bucket does not belong to you.诊断
    500
    InternalError
    The request processing has failed due to some unknown error, exception or failure.诊断

    变更历史

    变更时间变更内容概要操作
    2023-01-10
    新增请求参数EndTimeIncluded
    新增返回参数

    相关示例

    创建直播录制索引文件
    2022-03-16