UpdateLiveAppSnapshotConfig_视频直播_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

QPS 限制

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

流控信息

请求速率为30/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
live:UpdateLiveAppSnapshotConfig
Update
Domain
acs:cdn:*:{#accountId}:domain/{#DomainName}

请求参数

字段名称字段详情
DomainNamestring

主播流域名。

示例值:example.com参考取值来源:
    AddLiveDomain
    DescribeDomainUsageData
    ListLiveRealtimeLogDeliveryDomains
AppNamestring

播流所属应用名称。

示例值:liveApp****参考取值来源:
    GetMessageApp
    ListMessageApp
    QueryMessageApp
    CreateMessageApp
TimeIntervalinteger<int32>

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

示例值:5取值 <= 3600
OssEndpointstring

OSS 存储的 Endpoint 名称。

示例值:cn-oss-****.aliyuncs.com
OssBucketstring

OSS 存储 Bucket 名称。

示例值:liveBucket****
OverwriteOssObjectstring

覆盖截图存储文件名。每次截图都覆盖此文件。展开详情

示例值:{liveApp****}/{liveStream****}.jpg
SequenceOssObjectstring

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

示例值:snapshot/{liveApp****}/{liveStream****}/{UnixTimestamp****}.jpg
Callbackstring

截图回调地址。

示例值:https://learn.aliyundoc.com参考取值来源:
    QuerySnapshotCallbackAuth
    ModifyLiveMessageAppCallback

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

返回示例

错误返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidOverwriteOssObjectOrSequenceOssObject.Malformed
Specified paramters OverwriteOssObject or SequenceOssObject should have one.诊断
400
InvalidOssEndpoint.Malformed
Specified parameter OssEndpoint is not valid.诊断
400
InvalidOssBucket.Malformed
Specified parameter OssBucket is not valid.诊断
400
InvalidOssBucket.NotFound
The parameter OssBucket does not exist.诊断
400
InvalidOverwriteOssObject.Malformed
Specified parameter OverwriteOssObject is not valid.诊断
400
InvalidSequenceOssObject.Malformed
Specified parameter SequenceOssObject is not valid.诊断
400
InvalidConfig.NotFound
The speicified config does not exist.诊断

变更历史

暂无变更历史

相关示例