调用AddLiveAppSnapshotConfig配置截图信息。

使用说明

OSS Bucket必须与播流域名的直播中心同地域，不支持跨地域截图。

QPS限制

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

调试

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

请求参数

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

系统规定参数。取值：AddLiveAppSnapshotConfig。
DomainName String 是 example.com

主播流域名。
AppName String 是 liveApp****

播流所属应用名称。
TimeInterval Integer 是 5

截图周期，每个间隔周期截一次图片。单位：秒。取值范围：5~3600。
OssEndpoint String 是 cn-oss-****.aliyuncs.com

OSS存储的Endpoint名称。

配置完成后，您可以根据配置回调信息，在OSS控制台查找指定的配置内容。OSS Endpoint需要提前创建，创建方法请参考配置OSS 。
OssBucket String 是 liveBucket****

OSS存储的Bucket名称。

配置完成后，您可以根据配置回调信息，在OSS控制台查找指定的配置内容。OSS Bucket需要提前创建，创建方法请参考配置OSS 。
OverwriteOssObject String 否 {AppName}/{StreamName}.jpg

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

  • 小于256 Byte。
  • 目前仅支持生成JPG图片。
  • 支持变量匹配，包含{AppName}、{StreamName}。
SequenceOssObject String 否 snapshot/{AppName}/{StreamName}/{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=AddLiveAppSnapshotConfig
&AppName=liveApp****
&DomainName=example.com
&OssBucket=liveBucket****
&OssEndpoint=cn-oss-****.aliyuncs.com
&TimeInterval=5
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<AddLiveAppSnapshotConfigResponse>
	<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
</AddLiveAppSnapshotConfigResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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. 配置已添加。

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