数据库备份服务配置备份计划

1. 接口描述

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

本接口（ConfigureBackupPlan）用于配置备份计划。包括配置备份源实例信息、备份对象以及备份策略等。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ConfigureBackupPlan。
Version	是	String	公共参数，本接口取值：2021-11-08。
Region	是	String	公共参数，详见产品支持的地域列表。
BackupPlanId	是	String	备份计划 ID。示例值：dbs-xxxxxxxx
BackupPlanName	否	String	备份计划名称。支持数字、英文大小写字母、中文以及特殊字符_-./()（）[]+=：:@,且长度不能超过60。示例值：name-xxxxx
SourceEndPoint	否	BackupEndpoint	备份源实例信息。
BackupObject	否	BackupObject	备份对象信息。
BackupStrategy	否	BackupStrategy	备份策略。
PlainText	否	String	加密信息。当需要使用SSE-KMS需要传入该值，你可以通过 KMS 的 GenerateDataKey 接口生成。示例值：q+EouJ/tGeiZIo9/tIl2baxQOBFxcN0PNn7F6EIEvp

3. 输出参数

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

4. 示例

示例1 ConfigureBackupPlan

输入示例

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

{
    "BackupPlanId": "dbs-xxxxxx",
    "SourceEndPoint": {
        "Region": "ap-guangzhou",
        "DatabaseType": "mysql",
        "AccessType": "cdb",
        "InstanceId": "cdb-xxxxxxxx",
        "Supplier": "others",
        "UserName": "root",
        "Password": "xxxxxxxx"
    },
    "BackupObject": {
        "ObjectMode": "all",
        "ObjectItems": []
    },
    "BackupStrategy": {
        "BackupPeriod": {
            "PeriodType": "Weekly",
            "Day": [
                "Monday"
            ]
        },
        "BackupMethod": "logical",
        "StrategyType": "period",
        "BackupStartTime": "02:00",
        "EnableIncrement": true,
        "StorageStrategy": {
            "BackupRetentionPeriod": 30,
            "StorageType": "system"
        }
    },
    "BackupPlanName": "backupPlan"
}

输出示例

{
    "Response": {
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

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	内部错误。
InternalError.DatabaseAccessError	数据库访问错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
OperationDenied	操作被拒绝。
ResourceNotFound	资源不存在。

配置备份计划

本页目录：