最近更新时间:2023.11.07 16:44:40
首次发布时间:2023.09.25 14:34:04
调用接口添加视频直播截图配置。调用后会先增加截图模版,将新建模版加入模版库中,再将该模版绑定到对应的 App 上。
说明
调用 UpdateCallback 和 CreateSnapshotPreset API,都可以更新截图回调配置,当重复调用以上两个接口更新截图回调配置时,以最后一次调用的配置为准。例如,您先调用 UpdateCallback 为某域名空间下的 App 配置了回调地址https://live.example.com/callback
,之后调用 CreateSnapshotPreset 再次对该域名空间下的同一 App 配置了回调地址 https://live.example.com/callback1
,则最终生效的回调地址为 https://live.example.com/callback1
。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateSnapshotPreset | 接口名称。当前 API 的名称为 CreateSnapshotPreset 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Vhost | String | 是 | push.example.com | 域名空间名称。 |
App | String | 是 | live | 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。 |
Status | Integer | 否 |
| 截图模版状态状态。默认开启。
|
Interval | Integer | 是 | 300 | 截图间隔时间,单位为 s,默认值为 10,取值范围为正整数。 |
Bucket | String | 否 |
| ToS 存储的 Bucket。 说明
|
StorageDir | String | 否 | / | ToS 存储目录,不传为空。 |
SnapshotFormat | String | 否 |
| 截图格式。默认值为 jpeg,支持如下取值。
|
SnapshotObject | String | 否 | {Domain}/{App}/{Stream}/{UnixTimestamp} | 存储方式为实时存储时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、"-"、"!"、"_"、"."、"*"及占位符。 |
CallbackDetailList | Array of CallbackDetailList | 否 | - | 回调详情。 |
ServiceID | String | 否 |
| veImageX 的服务 ID。 说明
|
OverwriteObject | String | 否 | {Domain}/{App}/{Stream} | 存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、"-"、"!"、"_"、"."、"*"及占位符。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
CallbackType | String | 否 | http | 回调类型,默认值为 http。 |
URL | String | 否 | https://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" } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
200 | CommonErr | - | 未分类错误。建议重试,如果仍返回该错误码,请联系技术支持。 |
400 | InvalidParam | - | 输入的参数无效或不符合要求,请参照请求参数说明进行检查。 |
400 | InvalidParam.BindError | Request parameter error, please check input data | 参数未通过校验,请检查参数类型是否正确。 |
403 | RequestForbidden | - | 请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。 |
403 | RequestForbidden.AccountIDNotAllow | this AccountID does not have permission to access the corresponding resource, please check the request parameters | 请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。 |
403 | RequestForbidden.BillingStatus | Billing status is not available for the AccountID, please activate the service or recharge. | 未开通视频直播服务或账号欠费,造成账单不可用,请检查服务开通情况和账号欠费情况。 |
404 | ResourceNotFound | - | 未找到资源(域名空间、域名、应用、配置模版、证书)。建议重试,如果仍返回该错误码,请联系技术支持。 |
429 | RequestLimitExceeded.Exist | %s already exist | 请求创建的资源(域名空间、域名、应用、配置模版、证书)已存在。 |
500 | InternalError | an internal error occurred, please contact the administrator. | 出现内部错误,请联系技术支持。 |
500 | InternalError.Preset | an internal error related to preset occurred, please contact the administrator. | 出现与功能配置相关的内部错误,请联系技术支持。 |
502 | InternalServiceError | an internal error occurred, please contact the administrator. | 服务间出现错误,请联系技术支持。 |
502 | InternalServiceError.BadResponse | an internal error occurred, please contact the administrator. | 服务间出现错误,请联系技术支持。 |
504 | InternalServiceTimeout | Internal Service is timeout. please contact the administrator. | 内部服务超时,请联系技术支持。 |