1. 接口描述
接口请求域名: mps.tencentcloudapi.com 。
修改用户自定义智能擦除模板。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifySmartEraseTemplate。 |
Version | 是 | String | 公共参数,本接口取值:2019-06-12。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Definition | 是 | Integer | 智能擦除模板唯一标识 示例值:30 |
Name | 否 | String | 智能擦除模板名称长度限制:64 个字符。 示例值:模板1 |
Comment | 否 | String | 智能擦除模板描述信息长度限制:256 个字符。 示例值:模板2 |
EraseType | 否 | String | 擦除类型 - subtitle 去字幕 - watermark 去水印 - privacy 隐私保护 示例值:subtitle |
EraseSubtitleConfig | 否 | SmartEraseSubtitleConfig | 字幕擦除配置,EraseType取subtitle或者EraseType不填,对应模板原EraseType为subtitle时生效。 |
EraseWatermarkConfig | 否 | SmartEraseWatermarkConfig | 水印擦除配置,EraseType取watermark或者EraseType不填,对应模板原EraseType为watermark时生效。 |
ErasePrivacyConfig | 否 | SmartErasePrivacyConfig | 隐私保护配置,EraseType取privacy或者EraseType不填,对应模板原EraseType为privacy时生效。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改擦除字幕模板打开提取功能
修改擦除字幕模板,打开OCR提取以及翻译功能
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySmartEraseTemplate
<公共请求参数>
{
"Definition": 200410,
"EraseSubtitleConfig": {
"SubtitleEraseMethod": "auto",
"SubtitleModel": "standard",
"OcrSwitch": "ON",
"SubtitleLang": "zh_en",
"SubtitleFormat": "vtt",
"TransSwitch": "ON",
"TransDstLang": "en"
}
}
输出示例
{
"Response": {
"RequestId": "84265f8e-43ec-4449-9521-b9332f64ee79"
}
}
示例2 修改擦除水印模板更改模型
修改擦除水印模板,将擦除水印模型更改为高级版
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySmartEraseTemplate
<公共请求参数>
{
"Definition": 200407,
"EraseWatermarkConfig": {
"WatermarkEraseMethod": "auto",
"WatermarkModel": "advanced"
}
}
输出示例
{
"Response": {
"RequestId": "e4d526f3-f1bb-4030-9f0d-00df485a7eae"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.InvalidMpsUser | 操作失败:非法 mps 用户。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue.AutoAreas | 擦除模板自动区域错误 |
InvalidParameterValue.Comment | 参数错误:对该模板的描述。 |
InvalidParameterValue.CustomAreas | 擦除模板指定区域错误 |
InvalidParameterValue.Definition | 参数错误:Definition。 |
InvalidParameterValue.ErasePrivacyConfig | 擦除模板隐私保护配置错误 |
InvalidParameterValue.EraseSubtitleConfig | 擦除模板字幕擦除配置错误 |
InvalidParameterValue.EraseType | 擦除模板擦除类型错误 |
InvalidParameterValue.EraseWatermarkConfig | 擦除模板水印擦除配置错误 |
InvalidParameterValue.ModifyDefaultTemplate | 参数值错误:不允许修改默认模板。 |
InvalidParameterValue.Name | 参数值错误:Name 超过长度限制。 |
InvalidParameterValue.PrivacyModel | 擦除模板隐私保护模型错误 |
InvalidParameterValue.PrivacyTargets | 擦除模板隐私保护目标错误 |
InvalidParameterValue.SubtitleEraseMethod | 擦除模板字幕擦除方式错误 |
InvalidParameterValue.SubtitleFormat | 参数值错误:SubtitleFormat 参数非法。 |
InvalidParameterValue.SubtitleLang | 擦除模板字幕擦除语种错误 |
InvalidParameterValue.SubtitleModel | 擦除模板字幕擦除模型错误 |
InvalidParameterValue.TransDstLang | 擦除模板字幕擦除翻译目标语种错误 |
InvalidParameterValue.WatermarkEraseMethod | 擦除模板去水印擦除方式错误 |
InvalidParameterValue.WatermarkModel | 擦除模板去水印擦除模型错误 |
ResourceNotFound.TemplateNotExist | 资源不存在:模板不存在。 |