最近更新时间:2023.09.25 21:09:59
首次发布时间:2022.04.19 20:40:35
查询域名和应用关联的直播截图模版,并更新某截图模版的配置项。
说明
该接口数据历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版更新截图配置接口。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateSnapshotPreset | 接口名称。当前 API 的名称为 UpdateSnapshotPreset 。 |
Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Vhost | String | 是 | push.example.com | 域名空间名称 |
App | String | 是 | live | 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成 |
Preset | String | 是 | preset-123 | 截图模板名称 |
Status | Integer | 否 |
| 截图模版状态。
|
Interval | Integer | 否 | 10 | 截图间隔时间,单位为 s,默认值为 10,取值范围为正整数 |
Bucket | String | 否 |
| ToS 的存储 Bucket。 说明
|
StorageDir | String | 否 | / | ToS 的存储目录,不传为空 |
SnapshotFormat | String | 否 |
| 截图格式。支持如下取值。
|
SnapshotObject | String | 否 | {PushDomain}/{App}/{Stream}/{UnixTimestamp} | 存储规则。存储在 ToS 时传,格式为{PushDomain}/{App}/{Stream}/{UnixTimestamp} |
CallbackDetailList | Array of CallbackDetailList | 否 | - | 回调详情 |
ServiceID | String | 否 |
| veImageX 的服务 ID。 说明
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
CallbackType | String | 否 | http | 回调类型。默认值为 http |
URL | String | 否 | 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" } }
访问公共错误码获取详细信息。