云数据库 KeeWiDB 查询实例全量备份列表-备份相关接口-API 中心-腾讯云

1. 接口描述

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

本接口（DescribeInstanceBackups）用于查询实例全量备份列表。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeInstanceBackups。
Version	是	String	公共参数，本接口取值：2022-03-08。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	待操作的实例ID，可通过 DescribeInstance 接口返回值中的 InstanceId 获取。示例值：kee-7iw94215
Limit	否	Integer	每页输出的备份列表大小，即每页输出的备份文件的数量，默认值20，取值范围为[1,100]。示例值：10
Offset	否	Integer	备份列表分页偏移量，取Limit整数倍。计算公式为offset=limit*(页码-1)。例如 limit=10，第1页offset就为0，第2页offset就为10，依次类推。示例值：0
BeginTime	否	String	查询备份文件的开始时间，格式如：2017-02-08 16:46:34。查询实例在 [BeginTime, EndTime] 时间段内的备份列表。示例值：2022-02-08 16:46:34
EndTime	否	String	查询备份文件的结束时间，格式如：2017-02-08 19:09:26。查询实例在 [beginTime, endTime] 时间段内的备份列表。示例值：2022-02-08 20:46:34
Status.N	否	Array of Integer	备份任务状态。 1：备份在流程中。 2：备份正常。 3：备份转RDB文件处理中。 4：已完成RDB转换。 -1：备份已过期。 -2：备份已删除。示例值：2

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	备份文件总数。示例值：10
BackupSet	Array of BinlogInfo	废弃字段。
BackupRecord	Array of BackupInfo	实例备份信息列表。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例1

输入示例

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

{
    "InstanceId": "kee-i0krexg9",
    "Limit": "10",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "BackupRecord": [
            {
                "BackupId": "",
                "BackupType": "1",
                "Locked": 0,
                "Remark": "",
                "StartTime": "2022-08-28 16:00:07",
                "Status": 2
            },
            {
                "BackupId": "",
                "BackupType": "1",
                "Locked": 0,
                "Remark": "",
                "StartTime": "2022-08-27 16:00:57",
                "Status": 2
            },
            {
                "BackupId": "",
                "BackupType": "1",
                "Locked": 0,
                "Remark": "",
                "StartTime": "2022-08-26 16:00:43",
                "Status": 2
            }
        ],
        "BackupSet": [],
        "RequestId": "1bb3c529-3db5-4bca-9f2b-4c04f919adf5",
        "TotalCount": 3
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError.DbOperationFailed	统一的 DB 操作错误，可以是 update insert select..。
InternalError.InternalError	内部错误。
InvalidParameter.InvalidParameter	业务参数错误。
InvalidParameter.PermissionDenied	接口没有cam权限。
ResourceNotFound.InstanceNotExists	找不到对应实例
UnsupportedOperation	操作不支持。

查询实例全量备份列表

本页目录：