灾备中心创建文件备份-API 文档-Help & Documentation-Tencent Cloud

1. 接口描述

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

本接口用于创建文件备份点

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateFileBackup。
Version	是	String	公共参数，本接口取值：2026-03-30。
Region	是	String	公共参数，详见产品支持的地域列表。
ResourceId	是	String	资源ID列表示例值：ins-eej84hs4
PlanId	否	String	计划ID 示例值：fbp-9odiqj9d
BackupPaths.N	否	Array of String	备份路径列表，1~20 个示例值：["/data"]
IncludeFileTypes.N	否	Array of String	包含文件类型，0~20 个示例值：["*.log"]
ExcludePatterns.N	否	Array of String	排除文件路径列表，0~20 个示例值：["/sys"]
ExcludeSystemDirectories	否	Boolean	是否排除系统目录示例值：true
BackupStorageId	否	String	备份库ID 示例值：vault-qjhn63ku
Deadline	否	String	备份到期时间示例值：2026-03-31 08:00:00
BackupName	否	String	备份名称示例值：backup-name

3. 输出参数

参数名称	类型	描述
BackupId	String	备份Id 示例值：fb-diakqif9
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建文件备份点

输入示例

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

{
    "ResourceId": "ins-0dl6ai18",
    "BackupPaths": [
        "/var/log"
    ],
    "ExcludeSystemDirectories": true,
    "BackupStorageId": "vault-ivsapm9k"
}

输出示例

{
    "Response": {
        "BackupId": "fb-hjyz84u8",
        "RequestId": "4fcb2255-91b4-466b-98a1-1169ede37e8f"
    }
}

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.CvmQueryFailed	查询CVM实例信息失败，请稍后重试
InternalError.InitRepositoryFailed	初始化备份库失败，请稍后重试
InternalError.TradeError	计费系统调用失败，请稍后重试
InvalidParameter.PathNested	备份路径存在嵌套关系，请确保路径之间无父子目录包含关系
InvalidParameterValue.VaultStateError	备份库当前状态不可写，请检查备份库是否正常
ResourceNotFound.AgentNotInstalled	指定实例未找到对应的Agent，请确认Agent是否已安装
ResourceNotFound.VaultNotExist	备份库不存在
UnauthorizedOperation.LackOfQualification	用户资质不满足要求，无法创建备份资源
UnsupportedOperation.AgentNotActive	Agent当前状态不是活跃状态，无法创建备份
UnsupportedOperation.FileBackupRestoreConflict	路径冲突
UnsupportedOperation.FileBackupTaskDuplicate	指定路径已有创建中的备份任务，请等待完成后再试

创建文件备份

On this page: