帮你快速理解、总结文档立即下载

查询备份计划

最近更新时间:2026-08-24 21:39:36
我的收藏

1. 接口描述

接口请求域名: bdrc.tencentcloudapi.com 。

本接口用来浏览已有备份计划内容

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeFileBackupPlans。
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 过滤条件。支持: instance-id, plan-id, plan-name, status, auto-backup-policy-id

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合条件的计划总数量
示例值:0
PlanSet Array of PlanInfo 符合条件的计划详情
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询备份计划列表

输入示例

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

{
    "Limit": 1
}

输出示例

{
    "Response": {
        "PlanSet": [
            {
                "AspPolicy": {
                    "AspId": "abp-7riwzmpp",
                    "AspName": "adminpolicy",
                    "AspState": "normal",
                    "CreateTime": "2026-06-10T21:15:45",
                    "IsActivated": true,
                    "IsPermanent": false,
                    "Policy": [
                        {
                            "Hour": [
                                0
                            ],
                            "IntervalDays": 1
                        }
                    ],
                    "RetentionDays": 0
                },
                "BackupCount": 0,
                "BackupPaths": [
                    "/tmp"
                ],
                "CreatedTime": "2026-06-10T21:16:12",
                "ExcludePatterns": [],
                "ExcludeSystemDirectories": true,
                "FlowControlSettings": [],
                "IncludeFileTypes": [],
                "LastExecuteTime": "2026-06-11T00:00:14",
                "LastTriggerError": "",
                "NextTriggerTime": "2026-06-12T00:00:00",
                "PlanId": "fbp-rbr9gp29",
                "PlanName": "未命名",
                "ResourceIds": [
                    "ins-852rp810"
                ],
                "Status": "normal",
                "VaultId": "vault-ivsapm9k"
            }
        ],
        "TotalCount": 8,
        "RequestId": "d9e76b63-23cb-431c-afc2-beb98e132c65"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InternalError.ComponentError 第三方组件错误
InvalidParameter.InvalidValue 参数错误
MissingParameter.MissingRequired 必填参数缺失
UnauthorizedOperation.HasNoStrategy 未授权操作