1. 接口描述
接口请求域名: vm.tencentcloudapi.com 。
通过查看审核任务列表接口,可查询任务队列;您可根据多种业务信息(业务类型、审核结果、任务状态等)筛选审核任务列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeTasks。 |
Version | 是 | String | 公共参数,本接口取值:2021-09-22。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Limit | 否 | Integer | 该参数表示任务列表每页展示的任务条数,默认值为10(每页展示10条任务)。 |
Filter | 否 | TaskFilter | 该参数表示任务筛选器的输入参数,可根据业务类型、审核文件类型、处理建议及任务状态筛选想要查看的审核任务,具体参数内容请参见TaskFilter数据结构的详细描述。 |
PageToken | 否 | String | 该参数表示翻页时使用的Token信息,由系统自动生成,并在翻页时向下一个生成的页面传递此参数,以方便快速翻页功能的实现。当到最后一页时,该字段为空。 |
StartTime | 否 | Timestamp ISO8601 | 该参数表示任务列表的开始时间,格式为ISO8601标准的时间戳。默认值为最近3天,若传入该参数,则在这一时间到EndTime之间的任务将会被筛选出来。 备注:该参数与Filter共同起到任务筛选作用,二者作用无先后顺序。 |
EndTime | 否 | Timestamp ISO8601 | 该参数表示任务列表的结束时间,格式为ISO8601标准的时间戳。默认值为空,若传入该参数,则在这StartTime到这一时间之间的任务将会被筛选出来。 备注:该参数与Filter共同起到任务筛选作用,二者作用无先后顺序。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Total | String | 该字段用于返回当前查询的任务总量,格式为int字符串。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Data | Array of TaskData | 该字段用于返回当前页的任务详细数据,具体输出内容请参见TaskData数据结构的详细描述。 注意:此字段可能返回 null,表示取不到有效值。 |
PageToken | String | 该字段用于返回翻页时使用的Token信息,由系统自动生成,并在翻页时向下一个生成的页面传递此参数,以方便快速翻页功能的实现。当到最后一页时,该字段为空。 注意:此字段可能返回 null,表示取不到有效值。 示例值:4765-48dXwxJtbkKXW8d3eb |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查看审核任务列表
查看审核任务列表
输入示例
POST / HTTP/1.1
Host: vm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTasks
<公共请求参数>
{
"Filter": {
"Type": "VIDEO"
}
}
输出示例
{
"Response": {
"Total": "1",
"Data": [
{
"TaskId": "task-video-XwxJtbkKXWgCt8AZ",
"DataId": "data_test_01",
"BizType": "1001",
"Name": "测试视频",
"Status": "FINISH",
"Type": "VIDEO",
"Suggestion": "Block",
"Labels": [
{
"Label": "Porn",
"SubLabel": "",
"Suggestion": "Block",
"Score": 99
},
{
"Label": "Hot",
"SubLabel": "",
"Suggestion": "Block",
"Score": 70
}
],
"MediaInfo": {
"Codecs": "h264 aac",
"Duration": 36,
"Width": 352,
"Height": 640,
"Thumbnail": "http://xxx.jpg"
},
"InputInfo": {
"Type": "URL",
"Url": "https://cms.myqcloud.com/video/test.mp3",
"BucketInfo": null
},
"CreatedAt": "2020-07-13T11:47:01.925Z",
"UpdatedAt": "2020-07-13T11:47:25.840Z"
}
],
"PageToken": "4765-48dXwxJtbkKXW8d3eb",
"RequestId": "8d3e4765-48db-40b5-8fdb-aaf1d7225a60"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |