最近更新时间：2023.10.23 16:14:01
首次发布时间：2023.09.25 14:34:04
添加截图审核配置。
说明
调用 UpdateCallback 和 CreateSnapshotAuditPreset API，都可以更新截图审核回调配置，当重复调用以上两个接口更新截图审核回调配置时，以最后一次调用的配置为准。例如，您先调用 UpdateCallback 为某域名空间下的 App 配置了回调地址https://live.example.com/callback，之后调用 CreateSnapshotAuditPreset 再次对该域名空间下的同一 App 配置了回调地址 https://live.example.com/callback1，则最终生效的回调地址为 https://live.example.com/callback1。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | CreateSnapshotAuditPreset | 接口名称。当前 API 的名称为 CreateSnapshotAuditPreset。 |
| Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Vhost | String | 否 |
| 域名空间名称。 说明 参数 |
Domain | String | 否 |
| 推流域名。 说明 参数 |
| App | String | 是 | live | App 名称。 |
| Interval | Integer | 是 | 3 | 截图间隔时间，单位秒，取值范围为 [0.1,10]，支持保留两位小数。 |
Bucket | String | 否 |
| ToS 存储空间 bucket。 说明 参数 |
| StorageDir | String | 否 | / | ToS 存储空间 bucket 下的存储目录。 |
| CallbackDetailList | Array of CallbackDetailList | 是 | - | 审核结果回调配置。 |
ServiceID | String | 否 |
| veImageX 的服务 ID。 说明 参数 |
| Description | String | 否 | 常用审核模版 | 审核模板描述。 |
StorageStrategy | Integer | 是 |
| 存储策略。支持以下取值。
|
Label | Array of String | 否 |
| 审核标签名称，若为空，则默认请求所有基础模型。支持以下取值。
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| CallbackType | String | 是 | http | 回调的类型 HTTP。 |
| URL | String | 是 | http://example.com/api/callback | 回调地址。 |
本接口无特有的返回参数。更多信息请见返回结构。
POST https://live.volcengineapi.com?Action=CreateSnapshotAuditPreset&Version=2023-01-01 { "Vhost":"push.example.com", "App":"live", "Interval ":3, "ServiceID":"WMK***UXe", "Label": ["301", "302"], "StorageStrategy":0, "CallbackDetailList":[ { "CallbackType":"http", "URL":"http://***" } ] }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "CreateSnapshotAuditPreset", "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 | - | 未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。 |
| 404 | ResourceNotFound.PresetNotExist | preset not found | 未找到配置模版。请检查传入的配置模版与创建好的配置模板是否一致。 |
| 429 | RequestLimitExceeded.Exist | %s already exist | 请求创建的资源（域名空间、域名、应用、配置模版、证书）已存在。 |
| 500 | InternalError | an internal error occurred, please contact the administrator. | 出现内部错误，请联系技术支持。 |
| 500 | InternalError.VhostOrDomain | an internal error related to vhost or domain occurred, please contact the administrator. | 出现与域名空间（Vhost）或域名（Domain）相关的内部错误。请联系技术支持。 |
| 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. | 内部服务超时，请联系技术支持。 |