TDSQL-C MySQL 版查询保险箱内的备份

1. 接口描述

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

根据保险箱ID查询备份文件列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeBackupListByVault。
Version	是	String	公共参数，本接口取值：2019-01-07。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo 。
VaultId	是	String	保险箱ID，长度必须大于0 示例值：vault-b5044c44-9e41-4c88-b75d-72a77ed8a759
BackupIds.N	否	Array of Integer	备份文件ID列表，用于筛选特定备份示例值：[123]
ClusterId	否	String	集群ID，用于筛选特定集群的备份示例值：cynosdbmysql-lzvkp2d0
BackupNames.N	否	Array of String	备份名称列表，用于精确匹配筛选示例值：["query"]
FileNames.N	否	Array of String	文件名称列表，用于精确匹配筛选示例值：["query"]
Limit	否	Integer	分页数量，取值范围：(0, 100]，默认100 示例值：2
Offset	否	Integer	分页偏移量，取值范围：[0, INF)，默认0 示例值：0
OrderBy	否	String	排序字段，可选值：VaultId, VaultName, BackupSaveSeconds, LockedTime, CreateTime, UpdateTime，默认createTime 示例值：VaultId
OrderByType	否	String	排序方式，可选值：desc, asc, DESC, ASC，默认desc 示例值：desc
Status	否	String	状态示例值：running

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合条件的备份文件总数示例值：1
BackupList	Array of DescribeBackupListByVaultItem	备份文件列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询保险箱下数据备份列表

输入示例

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

{
    "VaultId": "vault-a6ed23f2-f03e-4410-b946-624d1e7d9b5a"
}

输出示例

{
    "Response": {
        "BackupList": [
            {
                "BackupFileInfo": {
                    "BackupId": 631,
                    "BackupMethod": "manual",
                    "BackupName": "",
                    "BackupStatus": "success",
                    "BackupType": "snapshot",
                    "CopyStatus": "done",
                    "FileName": "backupT_202602021412_20260202150536",
                    "FileSize": 4183356,
                    "FinishTime": "2026-02-02 15:05:41",
                    "SnapShotType": "full",
                    "SnapshotId": 631,
                    "SnapshotTime": "2026-02-02 14:47:38",
                    "StartTime": "2026-02-02 15:05:36"
                },
                "ClusterId": "cynosdbmysql-h30xf5d7",
                "ClusterName": "backupT_202602021412"
            }
        ],
        "TotalCount": 1,
        "RequestId": "805500d0-0399-4f8c-acaf-3d6de1d607d5"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

查询保险箱内的备份

本页目录：