全部产品
Search

搜索本产品

    视频直播：AddLiveAppSnapshotConfig - 添加直播截图配置

    文档中心

    视频直播：AddLiveAppSnapshotConfig - 添加直播截图配置

    更新时间：Dec 17, 2025

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

    接口说明

    • 请确保在使用该接口前，已充分了解直播截图的收费方式和价格。计费详情，请参见直播截图费用。

    • 视频直播截图功能需要将截图文件存放在 Bucket 中，因此需要开通 OSS 服务并且拥有至少一个 Bucket 用于存储这些截图文件。具体操作请参见配置 OSS。

    • 直播截图存储在 OSS 中，会产生存储费用，在 OSS 中计费详情请参见存储费用。

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

    QPS 限制

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

    调试

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

    调试

    授权信息

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

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    live:AddLiveAppSnapshotConfig

    create

    *Domain

    acs:cdn:*:{#accountId}:domain/{#DomainName}

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    DomainName

    string

    是

    主播流域名。

    example.com
    AppName

    string

    是

    播流所属应用名称。 AppName 名称与推流地址中的 AppName 名称对应，模板才能生效。不超过 255 字符，支持数字、大小写字母、短横线（-）、下划线（_），短横线、下划线不能位于首位。也支持取值为单个星号（*）字符，即可匹配所有 AppName。

    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

    否

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

    • 小于 256 Byte。

    • 目前仅支持生成 JPG 图片。

    • 支持变量匹配，包含{AppName}、{StreamName}。

    {AppName}/{StreamName}.jpg
    SequenceOssObject

    string

    否

    实时截图存储文件名。

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

    • 小于 256 Byte。

    • 目前仅支持生成 JPG 图片。

    • 支持变量匹配，包含{AppName}、{StreamName}、{UnixTimestamp}、{Sequence}，其中 {UnixTimestamp}、{Sequence} 必填一个。

    snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg
    Callback

    string

    否

    截图回调地址。

    https://learn.aliyundoc.com

    返回参数

    名称

    类型

    描述

    示例值

    object

    RequestId

    string

    请求 ID。

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

    示例

    正常返回示例

    JSON格式

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

    异常返回示例

    JSON格式

    {
    "Code":"InternalError",
    "HostId":"live.aliyuncs.com",
    "Message":"The request processing has failed due to some unknown error.",
    "RequestId":"6EBD1AC4-C34D-4AE1-963E-B688A228BE31"
}

    错误码

    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.
    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.
    400 ConfigAlreadyExists Config has already exist.

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

    变更历史

    更多信息，参考变更详情。