1. 接口描述
接口请求域名： cynosdb.tencentcloudapi.com 。
计算修改备份保留时长后将会过期删除的备份文件列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CalculateBackupSaveSecExpires。 |
| 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 示例值：vault-01b0a50a-33b5-4104-8d10-e55a79d10562 |
| BackupSaveSeconds | 否 | Integer | 备份保留时长（秒），必须大于0 示例值：604800 |
| Limit | 否 | Integer | 每页数量，范围(0,100]，默认10 示例值：2 |
| Offset | 否 | Integer | 偏移量，范围[0,INF)，默认0 示例值：0 |
| OrderBy | 否 | String | 排序字段，可选值：VaultId,VaultName,BackupSaveSeconds,LockedTime,CreateTime,UpdateTime，默认endTime 示例值：VaultId |
| OrderByType | 否 | String | 排序方式，可选值：desc,asc,DESC,ASC，默认desc 示例值：desc |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| WillDeleteBackupFileCount | Integer | 将被删除的备份文件总数 示例值：0 |
| WillDeleteBackupFiles | Array of WillDeleteItem | 将被删除的备份文件列表 |
| WillDeleteBinlogFileCount | Integer | 将被删除的Binlog文件总数 示例值：45192 |
| WillDeleteBinlogFiles | Array of WillDeleteItem | 将被删除的Binlog文件列表 |
| WillDeleteRedoLogFileCount | Integer | 将被删除的Redolog文件总数 示例值：19098 |
| WillDeleteRedoLogFiles | Array of WillDeleteItem | 将被删除的Redolog文件列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 调整保险箱备份保存时间将会删除多少备份
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CalculateBackupSaveSecExpires
<公共请求参数>
{
"VaultId": "vault-a6ed23f2-f03e-4410-b946-624d1e7d9b5a",
"BackupSaveSeconds": 604800
}输出示例
{
"Response": {
"WillDeleteBackupFileCount": 0,
"WillDeleteBackupFiles": [],
"WillDeleteBinlogFileCount": 0,
"WillDeleteBinlogFiles": [],
"WillDeleteRedoLogFileCount": 0,
"WillDeleteRedoLogFiles": [],
"RequestId": "1d7f4916-bd01-4bef-949b-1ee1aef21e7f"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
