文档中心 云数据库 Redis API文档 实例相关接口 查询任务列表信息

查询任务列表信息

最近更新时间：2019-11-19 19:58:40

查看pdf

在这篇文章中：

1. 接口描述

接口请求域名： redis.tencentcloudapi.com 。

查询任务列表信息

默认接口请求频率限制：100次/秒。

注意：本接口支持金融区地域。由于金融区和非金融区是隔离不互通的，因此当公共参数 Region 为金融区地域（例如 ap-shanghai-fsi）时，需要同时指定带金融区地域的域名，最好和 Region 的地域保持一致，例如：redis.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeTaskList
Version 是 String 公共参数，本接口取值：2018-04-12
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 否 String 实例Id
InstanceName 否 String 实例名称
Limit 否 Integer 分页大小
Offset 否 Integer 偏移量，取Limit整数倍（自动向下取整）
ProjectIds.N 否 Array of Integer 项目Id
TaskTypes.N 否 Array of String 任务类型
BeginTime 否 String 起始时间
EndTime 否 String 终止时间
TaskStatus.N 否 Array of Integer 任务状态

3. 输出参数

参数名称 类型 描述
TotalCount Integer 任务总数
Tasks Array of TaskInfoDetail 任务详细信息
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

https://redis.tencentcloudapi.com/?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 Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力，能显著降低使用云 API 的难度，推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation.SystemError 内部系统错误，和业务无关。
InternalError.DbOperationFailed 统一的 DB 操作错误，可以是 update insert select..。
InternalError.InternalError 内部错误。
InvalidParameter.PermissionDenied 接口没有cam权限。

云数据库 Redis 相关文档