You need to enable JavaScript to run this app.
导航
添加截图配置 V1
最近更新时间:2024.05.14 10:43:18首次发布时间:2023.09.25 14:34:04

调用接口添加视频直播截图配置。调用后会先增加截图模版,将新建模版加入模版库中,再将该模版绑定到对应的 App 上。

说明

该接口属于历史版本 API,我们计划于 2024 年 04 月 25 日停止对其进行维护,并于 2024 年 7 月 25 日下线文档,建议您使用新版CreateSnapshotPresetV2接口。

注意事项

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

请求说明

  • 请求方式:POST
  • 请求地址:https://live.volcengineapi.com?Action=CreateSnapshotPreset&Version=2023-01-01

调试

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringCreateSnapshotPreset接口名称。当前 API 的名称为 CreateSnapshotPreset
VersionString2023-01-01接口版本。当前 API 的版本为 2023-01-01

Body

参数类型是否必选示例值描述
VhostStringpush.example.com域名空间名称。
AppStringlive应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。

Status

Integer

1

截图模版状态状态。默认开启。

  • 1:开启。
  • 0:关闭。
IntervalInteger300截图间隔时间,单位为 s,默认值为 10,取值范围为正整数。

Bucket

String

live-test-tos-example

ToS 存储的 Bucket。

说明

BucketServiceID 传且仅传一个。

StorageDirString/ToS 存储目录,不传为空。

SnapshotFormat

String

jpeg

截图格式。默认值为 jpeg,支持如下取值。

  • jpeg
  • jpg
SnapshotObjectString{Domain}/{App}/{Stream}/{UnixTimestamp}存储方式为实时存储时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、"-"、"!"、"_"、"."、"*"及占位符。
CallbackDetailListArray of CallbackDetailList-回调详情。

ServiceID

String

WMK***UX

veImageX 的服务 ID。

说明

BucketServiceID 传且仅传一个。

OverwriteObjectString{Domain}/{App}/{Stream}存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、"-"、"!"、"_"、"."、"*"及占位符。

CallbackDetailList

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

返回参数

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

请求示例

POST https://live.volcengineapi.com?Action=CreateSnapshotPreset&Version=2023-01-01

{
  "Vhost": "push.example.com",
  "App": "live",
  "Interval ": 300,
  "ServiceID": "xxserID"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "CreateSnapshotPreset",
    "Version": "2023-01-01",
    "Service": "live",
    "Region": "cn-north-1"
  }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试,如果仍返回该错误码,请联系技术支持
400InvalidParam-输入的参数无效或不符合要求,请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验,请检查参数类型是否正确。
403RequestForbidden-请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费,造成账单不可用,请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源(域名空间、域名、应用、配置模版、证书)。建议重试,如果仍返回该错误码,请联系技术支持
429RequestLimitExceeded.Exist%s already exist请求创建的资源(域名空间、域名、应用、配置模版、证书)已存在。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误,请联系技术支持
500InternalError.Presetan internal error related to preset occurred, please contact the administrator.出现与功能配置相关的内部错误,请联系技术支持
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误,请联系技术支持
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误,请联系技术支持
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时,请联系技术支持

服务端 SDK

视频直播提供了配套的开发工具集 SDK,支持多种编程语言,帮助您更方便的调用 API。