调用AddLiveAppSnapshotConfig配置截图信息。输出内容保存到OSS中,重新推流即生效。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String AddLiveAppSnapshotConfig

系统规定参数。取值:AddLiveAppSnapshotConfig

AppName String testApp

直播流所属应用名称。

支持通配符*号,代表该域名下所有的AppName。

DomainName String www.yourdomain.com

您的加速域名。

OssBucket String test123

OSSBucket名称。

OssEndpoint String oss-cn-shanghai.aliyuncs.com

OSSEndpoint域名。

TimeInterval Integer 5

截图周期,单位:秒。取值范围:5~3600

OverwriteOssObject String {AppName}/{StreamName}.jpg

OSS存储文件名,每次截图都覆盖此文件。

  • 小于256bytes。
  • 目前仅支持生成jpg图片。
  • 支持变量匹配,包含{AppName}、{StreamName},例如:{AppName}/{StreamName}.jpg
SequenceOssObject String snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg

OSS存储文件名。每次截图都递增存储,DescribeLiveStreamSnapshotInfo接口查询一段时间的文件。

  • 小于256bytes。
  • 目前仅支持生成jpg图片。
  • 支持变量匹配,包含{AppName}、{StreamName}、{UnixTimestamp}、{Sequence},其中 {UnixTimestamp}、{Sequence} 必填一个,如:snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg

返回数据

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

请求ID。

示例

请求示例


http(s)://live.aliyuncs.com/?Action=AddLiveAppSnapshotConfig
&AppName=testApp
&DomainName=www.yourdomain.com
&OssBucket=test123
&OssEndpoint=oss-cn-shanghai.aliyuncs.com
&TimeInterval=5
&<公共请求参数>

正常返回示例

XML 格式

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

JSON 格式

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidOverwriteOssObjectOrSequenceOssObject.Malformed Specified paramters OverwriteOssObject or SequenceOssObject should have one. OverwriteOssObject与SequenceOssObject参数任选其一。
400 InvalidOssBucket.Malformed Specified parameter OssBucket is not valid. OSSBucket参数错误,请您确认该OSS BUCKET参数是否正确。
400 InvalidOssEndpoint.Malformed Specified parameter OssEndpoint is not valid. OSSEndpoint参数错误,请您确认该OSSEndpoint参数是否正确。
400 InvalidOverwriteOssObject.Malformed Specified parameter OverwriteOssObject is not valid. OverwriteOSSObject参数错误,请您确认该OverwriteOSSObject参数是否正确。
400 InvalidSequenceOssObject.Malformed Specified parameter SequenceOssObject is not valid. SequenceOssObject参数错误,请您确认该SequenceOssObject参数是否正确。
400 InvalidOssBucket.NotFound The parameter OssBucket does not exist. OSSBucket参数错误,请您确认该OSS BUCKET参数是否正确。
400 ConfigAlreadyExists Config has already exist. 配置已添加。

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