1. 接口描述
接口请求域名: bda.tencentcloudapi.com 。
可以查看单条任务的处理情况,包括处理状态,处理结果。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeSegmentationTask。 |
Version | 是 | String | 公共参数,本接口取值:2020-03-24。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou 。 |
TaskID | 是 | String | 在提交分割任务成功时返回的任务标识ID。 示例值:12433580546999111111 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskStatus | String | 当前任务状态: QUEUING 排队中 PROCESSING 处理中 FINISHED 处理完成 示例值:PROCESSING |
ResultVideoUrl | String | 分割后视频URL, 存储于腾讯云COS 注意:此字段可能返回 null,表示取不到有效值。 示例值:https://liudehua-9527.cos.ap-guangzhou.myqcloud.com/result.mp4?q-sign-algorithm=sha1&q-ak=AKID********EXAMPLE&q-sign-time=8888;9999&q-key-time=8888;9999&q-header-list=&q-url-param-list=&q-signature=7de87f7bf9cfd23df9da32f46661e7cf97a5603c |
ResultVideoMD5 | String | 分割后视频MD5,用于校验 注意:此字段可能返回 null,表示取不到有效值。 示例值:4972F083D7F05E9474FDFA52AA616DEE |
VideoBasicInformation | VideoBasicInformation | 视频基本信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"FrameWidth":720,"FrameHeight":1280,"FramesPerSecond":29,"Duration":0,"TotalFrames":439} |
ErrorMsg | String | 分割任务错误信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:video error |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询任务成功
查询视频人像分割处理任务成功
输入示例
POST / HTTP/1.1
Host: bda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSegmentationTask
<公共请求参数>
{
"TaskID": "12433580546999111111"
}
输出示例
{
"Response": {
"RequestId": "0352ed67-66b0-4515-a04f-ddc0ab129658",
"TaskStatus": "FINISHED",
"ErrorMsg": "",
"ResultVideoUrl": "https://liudehua-9527.cos.ap-guangzhou.myqcloud.com/result.mp4?q-sign-algorithm=sha1&q-ak=AKID********EXAMPLE&q-sign-time=8888;9999&q-key-time=8888;9999&q-header-list=&q-url-param-list=&q-signature=7de87f7bf9cfd23df9da32f46661e7cf97a5603c",
"ResultVideoMD5": "somemd5",
"VideoBasicInformation": {
"FrameWidth": 1280,
"FrameHeight": 590,
"FramesPerSecond": 28,
"Duration": 21,
"TotalFrames": 630
}
}
}
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.AudioDecodeFailed | 音频解码失败。 |
FailedOperation.AudioEncodeFailed | 音频编码失败。 |
FailedOperation.InnerError | 服务内部错误,请重试。 |
FailedOperation.RequestTimeout | 后端服务超时。 |
FailedOperation.TaskNotExist | 任务不存在。 |
FailedOperation.VideoDecodeFailed | 视频解码失败。 |
InvalidParameter.InvalidParameter | 参数不合法。 |