配置截图信息。输出内容保存到OSS中，重新推流即生效。
接口说明
使用说明
OSS Bucket 必须与播流域名的直播中心同地域，不支持跨地域截图。
QPS 限制
本接口的单用户 QPS 限制为 30 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| live:AddLiveAppSnapshotConfig | create |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DomainName | string | 是 | 主播流域名。 | example.com |
| AppName | string | 是 | 播流所属应用名称。 | liveApp**** |
| TimeInterval | integer | 是 | 截图周期。单位：秒。取值范围：5~3600。 | 5 |
| OssEndpoint | string | 是 | OSS 存储的 Endpoint 名称。 配置完成后，您可以根据配置回调信息，在 OSS 控制台查找指定的配置内容。OSS Endpoint 需要提前创建，创建方法请参考配置 OSS 。 | cn-oss-****.aliyuncs.com |
| OssBucket | string | 是 | OSS 存储的 Bucket 名称。 配置完成后，您可以根据配置回调信息，在 OSS 控制台查找指定的配置内容。OSS Bucket 需要提前创建，创建方法请参考配置 OSS 。 | liveBucket**** |
| OverwriteOssObject | string | 否 | 覆盖截图存储文件名。每次截图都覆盖此文件。
| {AppName}/{StreamName}.jpg |
| SequenceOssObject | string | 否 | 实时截图存储文件名。 每次截图都递增存储，调用 DescribeLiveStreamSnapshotInfo 接口可以查询某一段时间的截图文件。
| snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg |
| Callback | string | 否 | 截图回调地址。 | https://learn.aliyundoc.com |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}JSON格式
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 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. | 配置已添加。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史