UpdateLiveAppSnapshotConfig - 更新直播截图配置

更新直播流下的截图配置。输出内容保存到OSS中,重新推流后生效。

接口说明

使用说明

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

QPS 限制

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:UpdateLiveAppSnapshotConfigupdate
  • Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}

请求参数

名称类型必填描述示例值
DomainNamestring

主播流域名。

example.com
AppNamestring

播流所属应用名称。

liveApp****
TimeIntervalinteger

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

5
OssEndpointstring

OSS 存储的 Endpoint 名称。

cn-oss-****.aliyuncs.com
OssBucketstring

OSS 存储 Bucket 名称。

liveBucket****
OverwriteOssObjectstring

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

  • 小于 256 Byte。
  • 目前仅支持生成 JPG 图片。
  • 支持变量匹配,包含 {AppName}、{StreamName}。
  • 传入短划线(-),表示删除此字段。
{liveApp****}/{liveStream****}.jpg
SequenceOssObjectstring

实时截图存储文件名。每次截图都递增存储,调用 DescribeLiveStreamSnapshotInfo 接口,可以查询某一段时间的文件。

  • 小于 256 Byte。
  • 目前仅支持生成 JPG 图片。
  • 支持变量匹配,包含 {AppName}、{StreamName}、{UnixTimestamp}、{Sequence},其中 {UnixTimestamp}、{Sequence} 必填一个。
  • 传入短划线(-),表示删除此字段。
snapshot/{liveApp****}/{liveStream****}/{UnixTimestamp****}.jpg
Callbackstring

截图回调地址。

https://learn.aliyundoc.com

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

示例

正常返回示例

JSON格式

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

JSON格式

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

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史