AddLiveAppRecordConfig_视频直播_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 服务以及创建 Bucket,具体操作请参见配置 OSS

  • 录制文件存储在 OSS 中,会产生存储费用,在 OSS 中计费详情请参见存储费用

  • 直播录制功能,可以将直播内容进行录制,保存至您指定的位置,在您需要回看直播内容时可以进行回看。存储至 OSS 的录制内容,支持多种保存格式(TS、MP4、FLV、CMAF),支持自定义录制策略(自动录制、按需录制、手动录制),调用此接口可进行录制模版设置。更多直播录制功能使用可参见直播录制说明文档。

  • (DomainName, AppName, StreamName)三元组只能对应一个配置,如果该三元组已经存在一个配置了,再调用本接口添加配置会返回配置已存在错误。

  • 通过该接口设置的各项配置,需要在直播重新推流之后才能生效,并且长期有效。

QPS 限制

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

流控信息

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

授权信息

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

具体说明如下:展开详情

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

请求参数

字段名称字段详情
DomainNamestring

主播流域名。

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

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

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

OSS 存储的 Endpoint 名称。展开详情

示例值:learn.developer.aliyundoc.com
OssBucketstring

OSS 存储的 Bucket 名称。展开详情

示例值:liveBucket****
StreamNamestring

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

示例值:teststream参考取值来源:
    AddLiveStreamMerge
    DescribeMixStreamList
    QueryLiveDomainMultiStreamList
StartTimestring

录制开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。展开详情

示例值:2018-04-10T09:57:21Z
EndTimestring

录制结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。展开详情

示例值:2018-04-16T09:57:21Z
OnDemandinteger<int32>

按需/手动录制。取值:展开详情

示例值:1
DelayTimeinteger<int32>

断流拼接时长。展开详情

示例值:180
RecordFormatarray<object>

记录详情。

子级条数 <= 3
TranscodeRecordFormatarray<object>

转码记录详情。

子级条数 <= 3
TranscodeTemplatesarray<string>

转码流录制的转码模板组。

示例值:sd子级条数 <= 10

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值: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.诊断

变更历史

暂无变更历史

相关示例

添加录制配置
2022-03-14