1. 接口描述
接口请求域名: ivld.tencentcloudapi.com 。
依照输入条件,描述命中的任务信息,包括任务创建时间,处理时间信息等。
请注意,本接口最多支持同时描述50个任务信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeTasks。 |
Version | 是 | String | 公共参数,本接口取值:2021-09-03。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
PageNumber | 否 | Integer | 分页序号,从1开始 示例值:1 |
PageSize | 否 | Integer | 每个分页所包含的元素数量,最大为50 示例值:15 |
TaskFilter | 否 | TaskFilter | 任务过滤条件,相关限制参见TaskFilter |
SortBy | 否 | SortBy | 返回结果排序信息,By字段只支持CreateTimeStamp |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 满足过滤条件的任务总数量 示例值:1 |
TaskInfoSet | Array of TaskInfo | 满足过滤条件的任务数组 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 描述前5个完成的任务
输入示例
POST / HTTP/1.1
Host: ivld.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTasks
<公共请求参数>
{
"PageNumber": 1,
"PageSize": 5,
"TaskFilter": {
"TaskStatusSet": [
8
]
}
}
输出示例
{
"Response": {
"RequestId": "dcbd578a-caea-487a-b761-d49c9b7f2ac3",
"TaskInfoSet": [
{
"FailedReason": "",
"MediaId": "media-fdk9hp2v",
"MediaPreknownInfo": {
"MediaLabel": 1,
"MediaLang": 1,
"MediaSecondLabel": 1,
"MediaType": 2
},
"TaskCreateTime": 1634014749,
"TaskId": "task-ctl3bk8k",
"TaskName": "TaskNameTest",
"TaskProgress": 0,
"TaskStartTime": 1634014751,
"TaskStatus": 8,
"TaskTimeCost": 111
},
{
"FailedReason": "",
"MediaId": "media-t9Igr9jf",
"MediaPreknownInfo": {
"MediaLabel": 1,
"MediaLang": 1,
"MediaSecondLabel": 0,
"MediaType": 2
},
"TaskCreateTime": 1634017967,
"TaskId": "task-wodahg5t",
"TaskName": "test-task-0",
"TaskProgress": 0,
"TaskStartTime": 1634017971,
"TaskStatus": 8,
"TaskTimeCost": 131
},
{
"FailedReason": "",
"MediaId": "media-fdk9hp2u",
"MediaPreknownInfo": {
"MediaLabel": 1,
"MediaLang": 1,
"MediaSecondLabel": 1,
"MediaType": 2
},
"TaskCreateTime": 1634019460,
"TaskId": "task-qq38azcb",
"TaskName": "TaskNameTest",
"TaskProgress": 0,
"TaskStartTime": 1634019464,
"TaskStatus": 8,
"TaskTimeCost": 138
},
{
"FailedReason": "",
"MediaId": "media-fdk9hp2u",
"MediaPreknownInfo": {
"MediaLabel": 1,
"MediaLang": 1,
"MediaSecondLabel": 1,
"MediaType": 2
},
"TaskCreateTime": 1634019990,
"TaskId": "task-kzjesg12",
"TaskName": "TaskNameTest",
"TaskProgress": 0,
"TaskStartTime": 1634019994,
"TaskStatus": 8,
"TaskTimeCost": 148
},
{
"FailedReason": "",
"MediaId": "media-ly5qgk6j",
"MediaPreknownInfo": {
"MediaLabel": 1,
"MediaLang": 1,
"MediaSecondLabel": 1,
"MediaType": 2
},
"TaskCreateTime": 1634021166,
"TaskId": "task-krmtkhia",
"TaskName": "demo-task-0",
"TaskProgress": 0,
"TaskStartTime": 1634021170,
"TaskStatus": 8,
"TaskTimeCost": 111
}
],
"TotalCount": 17
}
}
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.UserInvalidStatus | 用户状态异常。 |
AuthFailure.UserNotFound | 用户无权限。 |
AuthFailure.UserStopArrear | 用户已欠费停服。 |
FailedOperation.GetTaskListFailed | 获取任务列表失败。 |
InternalError.InnerError | 内部错误。 |
InvalidParameter.InvalidPageNumber | 分页序号不合法。 |
InvalidParameter.InvalidPageSize | 分页大小不合法。 |
InvalidParameter.InvalidParam | 输入字段 %!s(MISSING) 不合法。 |
InvalidParameter.InvalidSortBy | 排序字段不合法。 |
InvalidParameter.InvalidTaskId | 任务ID不合法。 |
InvalidParameter.InvalidTaskName | 任务名称不合法。 |
InvalidParameter.InvalidTaskStatus | 任务状态不合法。 |
InvalidParameter.InvalidUin | 用户Uin无效。 |
UnauthorizedOperation.UnauthorizedProduct | 用户未激活该产品。 |