TDSQL Boundless 查询实例备份集信息

1. 接口描述

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

查询实例备份集信息 DescribeDBSBackupSets

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDBSBackupSets。
Version	是	String	公共参数，本接口取值：2021-11-22。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例ID 示例值：tdsql3-3f17e49d
BackupSetId	否	Integer	实例备份集ID 示例值：654434242
EndTime	否	String	结束时间示例值：2026-03-27 10:00:00
FilterBy	否	BackupSetsReqFilter	过滤条件
Limit	否	Integer	单次查询数量[0,200] 示例值：20
Offset	否	Integer	本次查询偏移[0,INF] 示例值：0
OrderBy	否	String	StartTime,EndTime,ExpiredTime,BackupSetId,BackupDuration 示例值：StartTime
OrderType	否	String	ASC,DESC 示例值：DESC
StartTime	否	String	开始时间示例值：2026-03-23 10:00:00

3. 输出参数

参数名称	类型	描述
Items	Array of BackupSetModel	备份集列表注意：此字段可能返回 null，表示取不到有效值。
TotalCount	Integer	总数示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询备份集列表

查询备份集列表

输入示例

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

{
    "InstanceId": "tdsql3-3f17e49d",
    "EndTime": "2026-03-27 10:00:00",
    "FilterBy": {
        "BackupMethod": "physical,snapshot",
        "BackupStatus": "running,success",
        "BackupType": "full",
        "ManualBackup": "0,1"
    },
    "Limit": 1,
    "Offset": 0,
    "OrderType": "DESC",
    "StartTime": "2026-03-23 10:00:00"
}

输出示例

{
    "Response": {
        "Items": [
            {
                "BackupDuration": 75,
                "BackupMethod": "physical",
                "BackupName": "tdsql3-3f17e49d_20260327000013",
                "BackupProgress": 100,
                "BackupSetId": 73180813688075,
                "BackupStatus": "success",
                "BackupType": "full",
                "DBVersion": "21.6.1",
                "EndTime": "2026-03-27 00:01:28",
                "EndTrxTime": "2026-03-27 00:00:49",
                "ErrorMessage": "",
                "ExpiredTime": "2026-04-03 00:01:28",
                "FileName": "tdstore-data",
                "FileSize": 9437184,
                "InstanceId": "tdsql3-3f17e49d",
                "ManualBackup": 0,
                "StartTime": "2026-03-27 00:00:13"
            }
        ],
        "TotalCount": 5,
        "RequestId": "66a71db2-18c5-445e-a28b-39ab02c1774e"
    }
}

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. 错误码

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

错误码	描述
InternalError.DatabaseAccessError	数据库访问错误。
InternalError.RouterNotFound	找不到路由，是否参数传递不对
ResourceNotFound.BizResourceNotFoundError	实例资源找不到

查询实例备份集信息

本页目录：