1. 接口描述
接口请求域名: vclm.tencentcloudapi.com 。
用于查询视频风格化任务。视频风格化支持将输入视频生成特定风格的视频。生成后的视频画面风格多样、流畅自然,能够满足社交娱乐、互动营销、视频素材制作等场景的需求。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeVideoStylizationJob。 |
Version | 是 | String | 公共参数,本接口取值:2024-05-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
JobId | 是 | String | 任务ID 示例值:145fa4a42d9440d191b3035f1beafa01 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
JobId | String | 任务ID。 示例值:145fa4a42d9440d191b3035f1beafa01 |
StatusCode | String | 任务状态码。取值说明: JobInit: "初始化中"; JobModerationFailed: "审核失败"; JobRunning: "处理中"; JobFailed: "处理失败"; JobSuccess: "处理完成"。 示例值:JobSuccess |
StatusMsg | String | 任务状态描述。取值说明: JobInit: "初始化中"; JobModerationFailed: "审核失败"; JobRunning: "处理中"; JobFailed: "处理失败"; JobSuccess: "处理完成"。 示例值:处理完成 |
ResultVideoUrl | String | 处理结果视频Url。URL有效期为24小时。 示例值:https://vcg-prod-xxx.cos.ap-guangzhou.tencentcos.cn/xxx.mp4 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功调用-任务完成
成功调用查询任务接口,任务完成。
输入示例
POST / HTTP/1.1
Host: vclm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVideoStylizationJob
<公共请求参数>
{
"JobId": "c5daf8f7077d41a69c13aab31a7164f3"
}
输出示例
{
"Response": {
"JobId": "c5daf8f7077d41a69c13aab31a7164f3",
"RequestId": "c048e3cf-79b3-4080-9892-15bb96a680e5",
"ResultVideoUrl": "https://vcg-prod-xxx.cos.ap-guangzhou.tencentcos.cn/xxx.mp4",
"StatusCode": "JobSuccess",
"StatusMsg": "处理完成"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.InnerError | 服务内部错误,请重试。 |
FailedOperation.TaskNotExist | 任务不存在。 |
FailedOperation.TaskStatusError | 任务状态异常。 |
InvalidParameterValue.ParameterValueError | 参数字段或者值有误。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInsufficient | 资源不足。 |
ResourceUnavailable.NotExist | 计费状态未知。 |