查询回档任务详情

最近更新时间:2024-03-12 01:13:41

我的收藏

1. 接口描述

接口请求域名: cdb.tencentcloudapi.com 。

本接口(DescribeRollbackTaskDetail)用于查询云数据库实例回档任务详情。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeRollbackTaskDetail。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID。与云数据库控制台页面中显示的实例 ID 相同,可使用 查询实例列表
示例值:cdb-qwer1234
AsyncRequestId String 异步任务 ID。
示例值:"aaa"
Limit Integer 分页参数,每次请求返回的记录数。默认值为 20,最大值为 100。
示例值:1
Offset Integer 分页偏移量。默认为 0。
示例值:0

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合条件的记录总数。
示例值:2
Items Array of RollbackTask 回档任务详情。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询回档任务详情

输入示例

POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRollbackTaskDetail
<公共请求参数>

{
    "InstanceId": "cdb-qwer1234",
    "Limit": "1"
}

输出示例

{
    "Response": {
        "TotalCount": 2,
        "Items": [
            {
                "Info": "batch rollback success",
                "Status": "SUCCESS",
                "Progress": 100,
                "StartTime": "2020-04-22 10:01:23",
                "EndTime": "2020-04-22 10:06:25",
                "Detail": [
                    {
                        "InstanceId": "cdb-qwer1234",
                        "Strategy": "full",
                        "RollbackTime": "2020-04-22 10:00:57",
                        "Databases": [],
                        "Tables": [
                            {
                                "Table": [
                                    {
                                        "TableName": "sbtest1",
                                        "NewTableName": "sbtest1_bak"
                                    },
                                    {
                                        "TableName": "sbtest2",
                                        "NewTableName": "sbtest2_bak"
                                    }
                                ],
                                "Database": "dbtest_bak"
                            }
                        ]
                    }
                ]
            }
        ],
        "RequestId": "1ac120c8-744a-4c15-be4e-4431511c0233"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
CdbError.DatabaseError 后端数据库错误。
InternalError.CdbError 系统错误。
InvalidParameter.ResourceNotExists 资源不存在。
OperationDenied.UserHasNoStrategy 用户没有该策略权限。