1. 接口描述
查询任务列表信息接口请求域名： redis.tencentcloudapi.com 。
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTaskList。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 否 | String | 实例Id |
| InstanceName | 否 | String | 实例名称 |
| Limit | 否 | Integer | 分页大小,默认20，上限不大于100 |
| Offset | 否 | Integer | 偏移量，取Limit整数倍（自动向下取整） |
| ProjectIds.N | 否 | Array of Integer | 项目Id |
| TaskTypes.N | 否 | Array of String | 任务类型 |
| BeginTime | 否 | String | 起始时间 |
| EndTime | 否 | String | 终止时间 |
| TaskStatus.N | 否 | Array of Integer | 任务状态 |
| Result.N | 否 | Array of Integer | 任务状态 |
| OperatorUin.N | 否 | Array of Integer | 操作者Uin，该字段已废弃，使用OperateUin代替 |
| OperateUin.N | 否 | Array of String | 操作者Uin |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 任务总数 |
| Tasks | Array of TaskInfoDetail | 任务详细信息 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskList
<公共请求参数>
{
"InstanceId": "crs-opcazbrb"
}输出示例
{
"Response": {
"RequestId": "19a7fb07-8e21-4827-88dd-fee57f38e8cd",
"Tasks": [
{
"EndTime": "2019-11-15 14:25:46",
"InstanceId": "crs-opcazbrb",
"InstanceName": "multidbccbugfix11153",
"Progress": 1,
"ProjectId": 0,
"Result": 2,
"StartTime": "2019-11-15 14:25:37",
"TaskId": 42372,
"TaskType": "037"
},
{
"EndTime": "2019-11-15 14:25:25",
"InstanceId": "crs-opcazbrb",
"InstanceName": "multidbccbugfix11153",
"Progress": 1,
"ProjectId": 0,
"Result": 2,
"StartTime": "2019-11-15 14:25:16",
"TaskId": 42371,
"TaskType": "037"
}
],
"TotalCount": 2
}
}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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.SystemError | 内部系统错误，和业务无关。 |
| InternalError.DbOperationFailed | 统一的 DB 操作错误，可以是 update insert select..。 |
| InternalError.InternalError | 内部错误。 |
| InvalidParameter.PermissionDenied | 接口没有cam权限。 |