添加APP录制配置_直播录制_API 参考

描述

配置 APP 录制，输出内容保存到 OSS 中。

请求参数

参数	类型	是否必须	描述
Action	String	是	操作接口名，系统规定参数，取值：AddLiveAppRecordConfig
DomainName	String	是	您的加速域名
AppName	String	是	直播流所属应用名称，支持通配符*，代表该域名下所有的 AppName
OssEndpoint	String	是	OSS endpoint，如：OSS-cn-hangzhou.aliyuncs.com。详细请参照 OSS 相关文档
OssBucket	String	是	OSS 存储 bucket 名称
RecordFormat.n.Format	String	是	格式，目前支持 m3u8、flv、mp4 周期录制
RecordFormat.n.OssObjectPrefix	String	是	OSS 存储的录制文件名，小于256byte，支持变量匹配，包含{AppName}、{StreamName}、{Sequence}、{StartTime}、{EndTime}，如：record/{AppName}/{StreamName}/{Sequence}_{StartTime}_{EndTime}; 参数值必须要有{StartTime}和{EndTime}变量。默认支持 1 小时周期录制, 最小周期时间 15 分钟，最多 6 小时。
RecordFormat.n.SliceOssObjectPrefix	String	否	当 format 格式是 m3u8 录制，则需要配置，表示 ts 切片名称，默认 30 秒一片，小于 256byte，支持变量匹配，包含{AppName}、{StreamName}、{UnixTimestamp}、{Sequence}，如：record/{AppName}/{StreamName}/{UnixTimestamp}_{Sequence}; 参数值必须包含{UnixTimestamp}和{Sequence}变量。
RecordFormat.n.CycleDuration	Integer	否	周期录制时长，单位秒, 不填则默认为 1 小时

返回参数

名称	类型	描述
RequestId	String	该条任务请求 ID

特殊错误码

错误代码	描述	Http 状态码	语义
InvalidDomain.NotFound	The domain provided does not exist in our records.	404	当前账户下未查到域名
MissingDomainName	DomainName is mandatory for this action.	400	缺少 DomainName 值
MissingAppName	AppName is mandatory for this action.	400	缺少 AppName 值
MissingOssEndpoint	OSSEndpoint is mandatory for this action.	400	缺少 OSSEndpoint值
InvalidOssEndpoint.Malformed	Specified parameter OssEndpoint is invalid.	400	OSSEndpoint 参数不合法
MissingOssBucket	OSSBucket is mandatory for this action.	400	缺少OssBucket值
InvalidOssBucket.Malformed	Specified parameter OssBucket is not valid.	400	OSSBucket 参数不合法
InvalidOssBucket.NotFound	The parameter OssBucket does not exist.	400	该 OSSBucket 不存在
MissingRecordFormat	RecordFormat is mandatory for this action.	400	缺少 RecordFormat 值
InvalidFormat.Malformed	Specified parameter Format is not valid.	400	Format 参数不合法
MissingOssObjectPrefix	OssObjectPrefix is mandatory for this action.	400	缺少 OSSObjectPrefix 值
InvalidOssObjectPrefix.Malformed	Specified parameter OssObjectPrefix is not valid.	400	OSSObjectPrefix 参数不合法
InvalidSliceOssObjectPrefix.Malformed	Specified parameter SliceOssObjectPrefix is invalid.	400	SliceOSSObjectPrefix 参数不合法
InvalidCycleDuration.Malformed	Specified parameter CycleDuration is invalid.	400	CycleDuration 参数不合法
ConfigAlreadyExists	Config has already exist.	400	配置已存在
InternalError	The request processing has failed due to some unknown error, exception or failure.	500	内部错误

示例

请求示例：

https://live.aliyuncs.com?Action=AddLiveAppRecordConfig&DomainName=live.aliyunlive.com&AppName=xxx&OssEndpoint=oss-cn-hangzhou.aliyuncs.com&OssBucket=bucket&RecordFormat.1.Name=flv&RecordFormat.1.OssObjectPrefix=record/{AppName}/{StreamName}/{Sequence}&RecordFormat.2.Name=mp4&RecordFormat.2.OssObjectPrefix=record/{AppName}/{StreamName}/{UnixTimestamp}_{Sequence}<公共请求参数>

关于公共请求参数详细内容，请参考公共请求参数。

返回示例

JSON格式：

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