调用 CreateSnapshotAuditPreset 接口，添加截图审核配置，当直播流在截图审核配置生效范围内时，将对直播流进行截图审核。
添加截图审核配置后，当直播流的推流地址中的 Domain、Appname、StreamName 字段与截图审核配置匹配时，视频直播会按照截图审核配置中的规则对直播流进行截图审核并存储截图。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | CreateSnapshotAuditPreset | 接口名称。当前 API 的名称为 CreateSnapshotAuditPreset。 |
| Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Vhost | String | 否 |
| 域名空间，即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看直播流使用的域名所属的域名空间。 说明 参数 |
Domain | String | 否 |
| 推流域名，您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看直播流使用的推流域名。 说明 参数 |
| App | String | 是 | live | 应用名称，取值与直播流地址中 AppName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。 |
| Interval | Float | 是 | 2 | 截图间隔时间，单位为秒，取值范围为 [0.1,10]，支持保留两位小数。 |
Bucket | String | 否 |
| TOS 存储对应的 Bucket。 说明 参数 |
StorageDir | String | 否 |
| ToS 存储对应的 bucket 下的存储目录，默认为空。 |
ServiceID | String | 否 |
| veImageX 的服务 ID。 说明 参数 |
| Description | String | 否 | 常用审核配置 | 截图审核配置的描述。 |
StorageStrategy | Integer | 是 |
| 存储策略，支持的取值及含义如下。
|
Label | Array of String | 否 |
| 审核标签，缺省情况下取值为
|
| SnapshotObject | String | 否 | {Domain}/{App}/{Stream}/{UnixTimestamp} | 截图存储规则，支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符，最大长度为 180 个字符，默认值为 {audit}/{PushDomain}/{App}/{Stream}/{UnixTimestamp}。 |
本接口无特有的返回参数。更多信息请见返回结构。
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 ] }
{ "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. | 内部服务超时，请联系技术支持。 |
视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。