数据库备份服务创建备份计划

1. 接口描述

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

该接口用于创建备份计划。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateBackupPlan。
Version	是	String	公共参数，本接口取值：2021-11-08。
Region	是	String	公共参数，详见产品支持的地域列表。
DatabaseType	是	String	源端数据库类型。当前支持值为: ["mysql","cynosdbmysql","percona","mariadb","tdsqlmysql"]。示例值：mysql
BackupMethod	否	String	备份方式。当前仅支持"logical"，即逻辑备份。示例值：logical
InstanceClass	否	String	规格。当前支持值为: ["micro","small","medium","large","xlarge"]。默认为"small"。示例值：large
Period	否	Integer	购买时长，单位为月，默认值为1。示例值：3
PayType	否	String	计费模式。当前仅支持"prepay"，即包年包月。示例值：prepay
Count	否	Integer	购买数量。取值范围为[1, 10]，默认值为1。示例值：1
AutoRenew	否	Integer	自动续费标识。1 - 开启自动续费；0 - 不开启自动续费。示例值：1
Tags.N	否	Array of Tag	标签值。

3. 输出参数

参数名称	类型	描述
OrderId	String	订单参数。示例值：20251216711021858208781
BackupPlanIds	Array of String	资源ID。示例值：["dbs-3enedogk"]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 购买备份计划

输入示例

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

{
    "DatabaseType": "mysql",
    "BackupMethod": "logical",
    "InstanceClass": "large",
    "Period": 3,
    "PayType": "prepay",
    "Count": 1,
    "AutoRenew": 1
}

输出示例

{
    "Response": {
        "BackupPlanIds": [
            "dbs-3enedogk"
        ],
        "OrderId": "20251216711021858208781",
        "RequestId": "ce31a435-eb3d-4508-b6e9-1b96cf86c8c7"
    }
}

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. 错误码

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

错误码	描述
FailedOperation.CreateBackupErr	创建备份失败
InvalidParameter	参数错误。

创建备份计划

本页目录：