You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

更新截图配置

最近更新时间：2023.10.12 17:39:58

首次发布时间：2022.04.19 20:40:35

我的收藏

查询域名和应用关联的直播截图模版，并更新某截图模版的配置项。

说明

该接口属于历史版本 API，我们计划于 2023 年 12 月 25 日停止对其进行维护，并于 2024 年 3 月 25 日下线文档，建议您使用新版更新截图配置接口。

注意事项

  • 请求频率：单用户请求频率限制为 10 次/秒。
  • 回调地址配置说明：调用 UpdateCallback 和当前接口，都可以更新截图回调地址，当重复调用以上两个接口更新截图回调地址配置时，以最后一次调用的配置为准。

请求说明

  • 请求方式：POST
  • 请求地址：https://live.volcengineapi.com?Action=UpdateSnapshotPreset&Version=2020-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数类型是否必选示例值描述
ActionString是UpdateSnapshotPreset接口名称。当前 API 的名称为 UpdateSnapshotPreset。
VersionString是2020-08-01接口版本。当前 API 的版本为 2020-08-01。

Body

参数类型是否必选示例值描述
VhostString是push.example.com域名空间名称
AppString是live应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成
PresetString是preset-123截图模板名称

Status

Integer

否

1

截图模版状态。

  • 1：开启
  • 0：关闭
IntervalInteger否10截图间隔时间，单位为 s，默认值为 10，取值范围为正整数

Bucket

String

否

live-test-tos-example

ToS 的存储 Bucket。

说明

Bucket 与 ServiceID 传且仅传一个。

StorageDirString否/ToS 的存储目录，不传为空

SnapshotFormat

String

否

jpeg

截图格式。支持如下取值。

  • jpeg
  • png
SnapshotObjectString否{PushDomain}/{App}/{Stream}/{UnixTimestamp}存储规则。存储在 ToS 时传，格式为{PushDomain}/{App}/{Stream}/{UnixTimestamp}
CallbackDetailListArray of CallbackDetailList否-回调详情

ServiceID

String

否

WMK***UXe

veImageX 的服务 ID。

说明

Bucket 与 ServiceID 传且仅传一个。

CallbackDetailList

参数类型是否必选示例值描述
CallbackTypeString否http回调类型。默认值为 http
URLString否https://example.com/api/callback回调地址

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

示例

请求示例

POST https://live.volcengineapi.com?Action=UpdateSnapshotPreset&Version=2020-08-01
{
  "Vhost": "push.example.com",
  "App": "live",
  "Preset": "preset-123",
  "Interval ": 300,
  "ServiceID": "WMK***UXe"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100***",
    "Action": "UpdateSnapshotPreset",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  }
}

错误码

访问公共错误码获取详细信息。