操作指南

API 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

1. 接口描述

本接口(DescribeTasks)用于查询云数据库实例任务列表。接口请求域名: cdb.tencentcloudapi.com 。

默认接口请求频率限制:50次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTasks。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同,可使用 查询实例列表 接口获取,其值为输出参数中字段 InstanceId 的值。
AsyncRequestId String 异步任务请求 ID,执行云数据库相关操作返回的 AsyncRequestId。
TaskTypes.N Array of Integer 任务类型,不传值则查询所有任务类型,支持的值包括:
1 - 数据库回档;
2 - SQL操作;
3 - 数据导入;
5 - 参数设置;
6 - 初始化云数据库实例;
7 - 重启云数据库实例;
8 - 开启云数据库实例GTID;
9 - 只读实例升级;
10 - 数据库批量回档;
11 - 主实例升级;
12 - 删除云数据库库表;
13 - 灾备实例提升为主。
TaskStatus.N Array of Integer 任务状态,不传值则查询所有任务状态,支持的值包括:
-1 - 未定义;
0 - 初始化;
1 - 运行中;
2 - 执行成功;
3 - 执行失败;
4 - 已终止;
5 - 已删除;
6 - 已暂停。
StartTimeBegin String 第一个任务的开始时间,用于范围查询,时间格式如:2017-12-31 10:40:01。
StartTimeEnd String 最后一个任务的开始时间,用于范围查询,时间格式如:2017-12-31 10:40:01。
Offset Integer 记录偏移量,默认值为0。
Limit Integer 单次请求返回的数量,默认值为20,最大值为100。

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合查询条件的实例总数。
Items Array of TaskDetail 返回的实例任务信息。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询云数据库实例任务列表

输入示例

https://cdb.tencentcloudapi.com/?Action=DescribeTasks
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 5,
        "Items": [
            {
                "Code": 9013,
                "Message": "[Operate CDB Fail][Upgrade Service Fail!] reason: ERR#-999: lock_inst.cgi: 某些实例id不存在对应的实例记录",
                "JobId": 79,
                "AsyncRequestId": "9d21004b-3aa1896a-eeddca4b-a68f106d",
                "Progress": 10,
                "StartTime": "2019-10-09 20:03:39",
                "EndTime": "2019-10-09 20:39:34",
                "InstanceIds": [
                    "cdb-qlfpnobr"
                ],
                "TaskType": "OPEN GTID",
                "TaskStatus": "FAILED"
            },
            {
                "Code": 0,
                "Message": "设置参数成功",
                "JobId": 70,
                "AsyncRequestId": "1d564380-2e391736-f28fa246-43cea3aa",
                "Progress": 100,
                "StartTime": "2018-07-06 22:03:05",
                "EndTime": "2018-07-06 22:03:28",
                "InstanceIds": [
                    "cdb-6kd9h71i"
                ],
                "TaskType": "MODIFY PARAM",
                "TaskStatus": "SUCCEED"
            },
            {
                "Code": 0,
                "Message": "初始化实例成功",
                "JobId": 69,
                "AsyncRequestId": "ea39295d-420a0b4e-a98298c7-8751e1ad",
                "Progress": 100,
                "StartTime": "2018-07-06 22:01:42",
                "EndTime": "2018-07-06 22:02:26",
                "InstanceIds": [
                    "cdb-6kd9h71i"
                ],
                "TaskType": "INITIAL",
                "TaskStatus": "SUCCEED"
            },
            {
                "Code": 0,
                "Message": "实例升级任务完成",
                "JobId": 68,
                "AsyncRequestId": "",
                "Progress": 100,
                "StartTime": "2018-07-05 23:53:48",
                "EndTime": "2018-07-06 22:05:10",
                "InstanceIds": [
                    "cdb-6kd9h71i"
                ],
                "TaskType": "UPGRADE MASTER",
                "TaskStatus": "SUCCEED"
            },
            {
                "Code": -1,
                "Message": "设置参数失败",
                "JobId": 66,
                "AsyncRequestId": "780b2e32-79cb0f4c-ec7854c5-44ff5371",
                "Progress": 0,
                "StartTime": "2018-07-05 23:30:36",
                "EndTime": "2018-07-05 23:30:37",
                "InstanceIds": [
                    "cdb-o02fxj9g"
                ],
                "TaskType": "MODIFY PARAM",
                "TaskStatus": "FAILED"
            }
        ],
        "RequestId": "9a4b22f5-0f93-4a72-ba05-1eb6cdf37a1e"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
CdbError 后端错误或者流程错误。
InternalError.DatabaseAccessError 数据库内部错误。
InternalError.DesError 系统内部错误。
InternalError.FtpError 文件传输异常。
InternalError.UnknownError 未知错误。
InvalidParameter 参数错误。
InvalidParameter.InstanceNotFound 实例不存在。
OperationDenied 操作被拒绝。
OperationDenied.UserHasNoStrategy 用户没有该策略权限。
OperationDenied.WrongStatus 后端任务状态非法。
目录