1. 接口描述
接口请求域名: bdrc.tencentcloudapi.com 。
本接口用来浏览已有备份点详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeFileBackups。 |
| Version | 是 | String | 公共参数,本接口取值:2026-03-30。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Offset | 否 | Integer | 偏移量,默认0 示例值:0 |
| Limit | 否 | Integer | 返回数量,默认20,最大500 示例值:20 |
| OrderField | 否 | String | 排序字段 示例值:CREATE_TIME |
| Order | 否 | String | 排序方式 示例值:DESC |
| Filters.N | 否 | Array of FilterModel | 过滤条件。支持: backup-id, plan-id, instance-id, status, backup-type, auto-backup-policy-id |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合条件的备份点总数量 示例值:20 |
| BackupSet | Array of BackupInfo | 符合条件的备份点详情 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询备份列表详情
输入示例
POST / HTTP/1.1
Host: bdrc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFileBackups
<公共请求参数>
{
"Limit": 1
}
输出示例
{
"Response": {
"BackupSet": [
{
"AspInstanceId": "",
"BackupFileCount": 1351200,
"BackupId": "fb-m9nvo7l4",
"BackupName": "",
"BackupPaths": [
"/data"
],
"BackupSize": 40205298693,
"BackupSizeFormatted": "37.44 GiB",
"CreatedTime": "2026-04-01T15:00:34",
"EndTime": "",
"ExcludePatterns": null,
"ExcludeSystemDirectories": true,
"IncludeFileTypes": null,
"JobId": "j-20260401070034-a018b0d8",
"PlanId": null,
"Progress": 34.14,
"ResourceId": "ins-7630gzfm",
"ScannedFileCount": 4000000,
"ScannedSize": 117760571686,
"ScannedSizeFormatted": "109.67 GiB",
"StartTime": "2026-04-01T15:01:44",
"Status": 1
}
],
"RequestId": "c7ffb5b2-1000-400c-806a-ce2bd1ae86c8",
"TotalCount": 28
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.ComponentError | 第三方组件错误 |
| InvalidParameter.InvalidValue | 参数错误 |
| MissingParameter.MissingRequired | 必填参数缺失 |
| UnauthorizedOperation.HasNoStrategy | 未授权操作 |