1. 接口描述
接口请求域名: cynosdb.tencentcloudapi.com 。
本接口(DescribeBackupList)用于查询集群的备份文件列表。
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeBackupList。 | 
| 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 。 | 
| ClusterId | 是 | String | 集群ID 示例值:cynosdbpg-ilgo90hu | 
| Limit | 否 | Integer | 返回数量,取值范围(0,100] 示例值:10 | 
| Offset | 否 | Integer | 记录偏移量,取值范围[0,INF) 示例值:0 | 
| DbType | 否 | String | 数据库类型,取值范围: 示例值:MYSQL | 
| BackupIds.N | 否 | Array of Integer | 备份ID 示例值:172365 | 
| BackupType | 否 | String | 备份类型,可选值:snapshot,快照备份; logic,逻辑备份 示例值:snapshot | 
| BackupMethod | 否 | String | 备份方式,可选值:auto,自动备份;manual,手动备份 示例值:auto | 
| SnapShotType | 否 | String | 快照类型,可选值:full,全量;increment,增量 示例值:full | 
| StartTime | 否 | String | 备份开始时间 示例值:2022-01-01 12:00:00 | 
| EndTime | 否 | String | 备份结束时间 示例值:2022-01-01 14:00:00 | 
| FileNames.N | 否 | Array of String | 备份文件名,模糊查询 示例值:sls_20241028221204 | 
| BackupNames.N | 否 | Array of String | 备份备注名,模糊查询 示例值:一区备份 | 
| SnapshotIdList.N | 否 | Array of Integer | 快照备份Id列表 示例值:["1883726","1883728"] | 
| BackupRegion | 否 | String | 备份地域 示例值:ap-beijing | 
| IsCrossRegionsBackup | 否 | String | 是否跨地域备份 示例值:yes | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| TotalCount | Integer | 总共备份文件个数 示例值:1 | 
| BackupList | Array of BackupFileInfo | 备份文件列表 | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 查询备份文件列表
查询备份文件列表
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupList
<公共请求参数>
{
    "Limit": 2,
    "ClusterId": "cynosdbmysql-ck8fmktd",
    "Offset": 0
}输出示例
{
    "Response": {
        "BackupList": [
            {
                "BackupId": 1880312,
                "BackupMethod": "auto",
                "BackupName": "",
                "BackupStatus": "success",
                "BackupType": "snapshot",
                "FileName": "jia_20241028040005",
                "FileSize": 10426,
                "FinishTime": "2024-10-28 04:02:34",
                "SnapShotType": "increment",
                "SnapshotId": 1880312,
                "SnapshotTime": "2024-10-28 04:00:04",
                "StartTime": "2024-10-28 04:02:14"
            },
            {
                "BackupId": 1879681,
                "BackupMethod": "auto",
                "BackupName": "",
                "BackupStatus": "success",
                "BackupType": "logic",
                "FileName": "jia_20241028022147",
                "FileSize": 1684666,
                "FinishTime": "2024-10-28 02:22:24",
                "SnapShotType": "full",
                "SnapshotId": 1879681,
                "SnapshotTime": "2024-10-28 02:21:47",
                "StartTime": "2024-10-28 02:21:47"
            }
        ],
        "RequestId": "1f2f4b1e-424d-4740-9b26-d947e957780e",
        "TotalCount": 40
    }
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 | 
|---|---|
| FailedOperation.GetBackupStrategyError | 获取备份策略失败,请稍后重试。如果持续不成功,请联系客服进行处理。 | 
| FailedOperation.OperationFailedError | 操作失败,请稍后重试。如果持续不成功,请联系客服进行处理。 | 
| InternalError.DbOperationFailed | 查询数据库失败。 | 
| InternalError.SystemError | 系统内部错误。 | 
| InternalError.UnknownError | 未知的内部错误。 | 
| InvalidParameterValue.InvalidParameterValueError | 参数值无效。 | 
| InvalidParameterValue.ParamError | 参数错误。 | 
| InvalidParameterValue.StoragePoolNotFound | 未找到相关存储pool。 | 
| ResourceNotFound.ClusterNotFoundError | 集群不存在。 | 
| UnauthorizedOperation.PermissionDenied | CAM鉴权不通过。 |