1. 接口描述
接口请求域名： cme.tencentcloudapi.com 。
获取任务列表，支持条件筛选，返回对应的任务基础信息列表。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTasks。 |
| Version | 是 | String | 公共参数，本接口取值：2019-10-29。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Platform | 是 | String | 平台 Id，指定访问的平台。关于平台概念，请参见文档 平台。 示例值：test |
| ProjectId | 否 | String | 项目 Id，使用项目 Id 进行过滤。 |
| TaskTypeSet.N | 否 | Array of String | 任务类型集合，取值有： 注：不填不使用任务类型进行过滤。 |
| StatusSet.N | 否 | Array of String | 任务状态集合，取值有： 注：不填则不使用任务状态进行过滤。 示例值：PROCESSING |
| Offset | 否 | Integer | 分页返回的起始偏移量，默认值：0。 示例值：0 |
| Limit | 否 | Integer | 分页返回的记录条数，默认值：10。最大值：20。 示例值：10 |
| Operator | 否 | String | 操作者。如不填，默认为 cmeid_system，表示平台管理员操作，可以获取所有任务信息。如果指定操作者，则操作者需要是任务发起者。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合搜索条件的记录总数。 示例值：1 |
| TaskBaseInfoSet | Array of TaskBaseInfo | 任务基础信息列表。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 分页获取视频导出任务列表
输入示例
https://cme.tencentcloudapi.com/?Action=DescribeTasks
&Platform=test
&Offset=0
&Limit=10
&<公共请求参数>输出示例
{
"Response": {
"TotalCount": 1,
"TaskBaseInfoSet": [
{
"CreateTime": "2020-04-30T03:26:37Z",
"ErrCode": 0,
"ErrMsg": "SUCCESS",
"Progress": 100,
"Status": "SUCCESS",
"TaskId": "181xxxxxxxx9-procedurev2-b718fcee09a72470bf665cf55351d810t0",
"TaskType": "VIDEO_EDIT_PROJECT_EXPORT"
}
],
"RequestId": "efde1a47-f1c9-4c1b-911c-9865a6a4d1ac"
}
}示例2 指定项目 Id 获取视频导出任务列表
输入示例
https://cme.tencentcloudapi.com/?Action=DescribeTasks
&Platform=test
&Offset=0
&ProjectId=cmepid_5fd8ad3d628dc30001bd0895
&Limit=10
&<公共请求参数>输出示例
{
"Response": {
"TotalCount": 1,
"TaskBaseInfoSet": [
{
"CreateTime": "2020-04-30T03:26:37Z",
"ErrCode": 0,
"ErrMsg": "SUCCESS",
"Progress": 100,
"Status": "SUCCESS",
"TaskId": "181xxxxxxxx9-procedurev2-b718fcee09a72470bf665cf55351d810t0",
"TaskType": "VIDEO_EDIT_PROJECT_EXPORT"
}
],
"RequestId": "efde1a47-f1c9-4c1b-911c-9865a6a4d1ad"
}
}示例3 指定任务状态获取视频导出任务列表
输入示例
https://cme.tencentcloudapi.com/?Action=DescribeTasks
&Platform=test
&StatusSet.0=SUCCESS
&Offset=0
&Limit=10
&<公共请求参数>输出示例
{
"Response": {
"TotalCount": 1,
"TaskBaseInfoSet": [
{
"CreateTime": "2020-04-30T03:26:37Z",
"ErrCode": 0,
"ErrMsg": "SUCCESS",
"Progress": 100,
"Status": "SUCCESS",
"TaskId": "181xxxxxxxx9-procedurev2-b718fcee09a72470bf665cf55351d810t0",
"TaskType": "VIDEO_EDIT_PROJECT_EXPORT"
}
],
"RequestId": "efde1a47-f1c9-4c1b-911c-9865a6a4d1ae"
}
}示例4 指定任务类型获取视频导出任务列表
输入示例
https://cme.tencentcloudapi.com/?Action=DescribeTasks
&Platform=test
&TaskTypeSet.0=VIDEO_EDIT_PROJECT_EXPORT
&Offset=0
&Limit=10
&<公共请求参数>输出示例
{
"Response": {
"TotalCount": 1,
"TaskBaseInfoSet": [
{
"CreateTime": "2020-04-30T03:26:37Z",
"ErrCode": 0,
"ErrMsg": "SUCCESS",
"Progress": 100,
"Status": "SUCCESS",
"TaskId": "181xxxxxxxx9-procedurev2-b718fcee09a72470bf665cf55351d810t0",
"TaskType": "VIDEO_EDIT_PROJECT_EXPORT"
}
],
"RequestId": "efde1a47-f1c9-4c1b-911c-9865a6a4d133"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameterValue.Platform | 平台参数取值错误。 |
| OperationDenied.PermissionDeny | 权限不足，请检查对应操作者的权限。 |
| ResourceNotFound.Platform | 平台不存在。 |
| UnauthorizedOperation | 未授权操作。 |