有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

本接口(ModifyBackupConfig)用于修改数据库备份配置信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyBackupConfig。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同。
示例值:cdb-c1nl9rpv
ExpireDays Integer 备份文件的保留时间,单位为天。最小值为7天,最大值为1830天。
示例值:10
StartTime String (将废弃,建议使用 BackupTimeWindow 参数) 备份时间范围,格式为:02:00-06:00,起点和终点时间目前限制为整点,目前可以选择的范围为: 00:00-12:00,02:00-06:00,06:00-10:00,10:00-14:00,14:00-18:00,18:00-22:00,22:00-02:00。
示例值:02:00-06:00
BackupMethod String 自动备份方式,仅支持:physical - 物理冷备
示例值:logical
BinlogExpireDays Integer binlog的保留时间,单位为天。最小值为7天,最大值为1830天。该值的设置不能大于备份文件的保留时间。
示例值:8
BackupTimeWindow CommonTimeWindow 备份时间窗,比如要设置每周二和周日 10:00-14:00之间备份,该参数如下:{"Monday": "", "Tuesday": "10:00-14:00", "Wednesday": "", "Thursday": "", "Friday": "", "Saturday": "", "Sunday": "10:00-14:00"} (注:可以设置一周的某几天备份,但是每天的备份时间需要设置为相同的时间段。 如果设置了该字段,将忽略StartTime字段的设置)
EnableBackupPeriodSave String 定期保留开关,off - 不开启定期保留策略,on - 开启定期保留策略,默认为off。首次开启定期保留策略时,BackupPeriodSaveDays,BackupPeriodSaveInterval,BackupPeriodSaveCount,StartBackupPeriodSaveDate参数为必填项,否则定期保留策略不会生效
示例值:off
EnableBackupPeriodLongTermSave String 长期保留开关,该字段功能暂未上线,可忽略。off - 不开启长期保留策略,on - 开启长期保留策略,默认为off,如果开启,则BackupPeriodSaveDays,BackupPeriodSaveInterval,BackupPeriodSaveCount参数无效
示例值:off
BackupPeriodSaveDays Integer 定期保留最长天数,最小值:90,最大值:3650,默认值:1080
示例值:1080
BackupPeriodSaveInterval String 定期保留策略周期,可取值:weekly - 周,monthly - 月, quarterly - 季度,yearly - 年,默认为monthly
示例值:weekly
BackupPeriodSaveCount Integer 定期保留的备份数量,最小值为1,最大值不超过定期保留策略周期内常规备份个数,默认值为1
示例值:1
StartBackupPeriodSaveDate String 定期保留策略周期起始日期,格式:YYYY-MM-dd HH:mm:ss
示例值:1970-01-01 00:00:01
EnableBackupArchive String 是否开启数据备份归档策略,off-关闭,on-打开,如果不指定该入参, 则保持不变。
示例值:off
BackupArchiveDays Integer 数据备份归档起始天数,数据备份达到归档起始天数时进行归档,最小为180天,不得大于数据备份保留天数
示例值:30
BinlogArchiveDays Integer 日志备份归档起始天数,日志备份达到归档起始天数时进行归档,最小为180天,不得大于日志备份保留天数
示例值:30
EnableBinlogArchive String 是否开启日志备份归档策略,off-关闭,on-打开,如果不指定该入参, 则保持不变。
示例值:off
EnableBackupStandby String 是否开启数据备份标准存储策略,off-关闭,on-打开,如果不指定该入参, 则保持不变。
示例值:off
BackupStandbyDays Integer 数据备份标准存储起始天数,数据备份达到标准存储起始天数时进行转换,最小为30天,不得大于数据备份保留天数。如果开启备份归档,不得大于等于备份归档天数
示例值:30
EnableBinlogStandby String 是否开启日志备份标准存储策略,off-关闭,on-打开,如果不指定该入参, 则保持不变。
示例值:off
BinlogStandbyDays Integer 日志备份标准存储起始天数,日志备份达到标准存储起始天数时进行转换,最小为30天,不得大于日志备份保留天数。如果开启备份归档,不得大于等于备份归档天数
示例值:30

3. 输出参数

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

4. 示例

示例1 修改数据库备份配置

修改数据库备份配置

输入示例

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

{
    "InstanceId": "cdb-c1nl9rpv",
    "ExpireDays": "10",
    "BinlogExpireDays": "8",
    "BackupMethod": "logical",
    "StartTime": "02:00-06:00"
}

输出示例

{
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
CdbError 后端错误或者流程错误。
FailedOperation.StatusConflict 任务状态冲突。
InternalError.DatabaseAccessError 数据库内部错误。
InternalError.UndefinedError 未知错误。
InvalidParameter 参数错误。
InvalidParameter.InstanceNotFound 实例不存在。
OperationDenied.ActionNotSupport 不支持的操作。
OperationDenied.UserHasNoStrategy 用户没有该策略权限。