调用UpdateLiveAppSnapshotConfig更新播流下的截图配置

使用说明

调用本接口更新播流下的截图配置。输出内容保存到OSS中，重新推流后生效。

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


名称	类型	是否必选	示例值	描述
Action	String	是	UpdateLiveAppSnapshotConfig	系统规定参数。取值：UpdateLiveAppSnapshotConfig
AppName	String	是	liveApp****	播流所属应用名称。
DomainName	String	是	example.com	主播流域名。
TimeInterval	Integer	否	5	截图周期。取值范围：5~3600。单位：秒。
OssEndpoint	String	否	cn-oss-****.aliyuncs.com	OSS存储的Endpoint名称。
OssBucket	String	否	liveBucket****	OSS存储Bucket名称。
OverwriteOssObject	String	否	{liveApp**}/{liveStream**}.jpg	覆盖截图存储文件名。每次截图都覆盖此文件。小于256 Byte。目前仅支持生成JPG图片。支持变量匹配，包含 {AppName}、{StreamName}。传入短划线（-），表示删除此字段。
SequenceOssObject	String	否	snapshot/{liveApp**}/{liveStream}/{UnixTimestamp**}.jpg	实时截图存储文件名。每次截图都递增存储，调用DescribeLiveStreamSnapshotInfo接口，可以查询某一段时间的文件。小于256 Byte。目前仅支持生成JPG图片。支持变量匹配，包含 {AppName}、{StreamName}、{UnixTimestamp}、{Sequence}，其中 {UnixTimestamp}、{Sequence} 必填一个。传入短划线（-），表示删除此字段。
Callback	String	否	https://learn.aliyundoc.com	截图回调地址。


名称	类型	示例值	描述
RequestId	String	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8	请求ID。

请求示例

http(s)://live.aliyuncs.com/?Action=UpdateLiveAppSnapshotConfig
&AppName=liveApp****
&DomainName=example.com
&<公共请求参数>

正常返回示例

XML格式

<UpdateLiveAppSnapshotConfigResponse>
	  <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
</UpdateLiveAppSnapshotConfigResponse>

JSON格式

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


HttpCode	错误码	错误信息	描述
400	InvalidOverwriteOssObjectOrSequenceOssObject.Malformed	Specified paramters OverwriteOssObject or SequenceOssObject should have one.	OverwriteOssObject与SequenceOssObject参数任选其一。
400	InvalidOssEndpoint.Malformed	Specified parameter OssEndpoint is not valid.	OSSEndpoint参数错误，请您确认该OSSEndpoint参数是否正确。
400	InvalidOssBucket.Malformed	Specified parameter OssBucket is not valid.	OSSBucket参数错误，请您确认该OSS BUCKET参数是否正确。
400	InvalidOssBucket.NotFound	The parameter OssBucket does not exist.	OSSBucket参数错误，请您确认该OSS BUCKET参数是否正确。
400	InvalidOverwriteOssObject.Malformed	Specified parameter OverwriteOssObject is not valid.	OverwriteOSSObject参数错误，请您确认该OverwriteOSSObject参数是否正确。
400	InvalidSequenceOssObject.Malformed	Specified parameter SequenceOssObject is not valid.	SequenceOssObject参数错误，请您确认该SequenceOssObject参数是否正确。
400	InvalidConfig.NotFound	The speicified config does not exist.	OssBucket错误，请您确认该OssBucket是否正确。

访问错误中心查看更多错误码。