操作指南

API 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

1. 接口描述

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

本接口(DescribeBackupConfig)用于查询数据库备份配置信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBackupConfig。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。

3. 输出参数

参数名称 类型 描述
StartTimeMin Integer 自动备份开始的最早时间点,单位为时刻。例如,2 - 凌晨 2:00。(该字段已废弃,建议使用 BackupTimeWindow 字段)
StartTimeMax Integer 自动备份开始的最晚时间点,单位为时刻。例如,6 - 凌晨 6:00。(该字段已废弃,建议使用 BackupTimeWindow 字段)
BackupExpireDays Integer 备份文件保留时间,单位为天。
BackupMethod String 备份方式,可能的值为:physical - 物理备份,logical - 逻辑备份。
BinlogExpireDays Integer Binlog 文件保留时间,单位为天。
BackupTimeWindow CommonTimeWindow 实例自动备份的时间窗。
EnableBackupPeriodSave String 定期保留开关,off - 不开启定期保留策略,on - 开启定期保留策略,默认为off
BackupPeriodSaveDays Integer 定期保留最长天数,最小值:90,最大值:3650,默认值:1080
BackupPeriodSaveInterval String 定期保留策略周期,可取值:weekly - 周,monthly - 月, quarterly - 季度,yearly - 年,默认为monthly
BackupPeriodSaveCount Integer 定期保留的备份数量,最小值为1,最大值不超过定期保留策略周期内常规备份个数,默认值为1
StartBackupPeriodSaveDate String 定期保留策略周期起始日期,格式:YYYY-MM-dd HH:mm:ss
EnableBackupArchive String 是否开启数据备份归档策略,off-关闭,on-打开,默认为off
BackupArchiveDays Integer 数据备份归档起始天数,数据备份达到归档起始天数时进行归档,最小为180天,不得大于数据备份保留天数
EnableBinlogArchive String 是否开启日志备份归档策略,off-关闭,on-打开,默认为off
BinlogArchiveDays Integer 日志备份归档起始天数,日志备份达到归档起始天数时进行归档,最小为180天,不得大于日志备份保留天数
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询云数据库备份配置信息

输入示例

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

{
    "InstanceId": "cdb-c1nl9rpv"
}

输出示例

{
    "Response": {
        "BackupMethod": "physical",
        "BinlogExpireDays": 7,
        "BackupExpireDays": 7,
        "StartTimeMin": 10,
        "StartTimeMax": 14,
        "BackupTimeWindow": {
            "Friday": "10:00-14:00",
            "Monday": "10:00-14:00",
            "Saturday": "10:00-14:00",
            "Sunday": "10:00-14:00",
            "Thursday": "10:00-14:00",
            "Tuesday": "10:00-14:00",
            "Wednesday": "10:00-14:00"
        },
        "EnableBackupPeriodSave": "off",
        "BackupPeriodSaveDays": 1080,
        "BackupPeriodSaveInterval": "monthly",
        "BackupPeriodSaveCount": 1,
        "StartBackupPeriodSaveDate": "2021-12-12 00:00:00",
        "EnableBackupArchive": "on",
        "BackupArchiveDays": 180,
        "EnableBinlogArchive": "on",
        "BinlogArchiveDays": 180,
        "RequestId": "9d73ec37-89b8-4d36-9f40-123123123"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.CdbCgwError 系统内部错误。
InternalError.DatabaseAccessError 数据库内部错误。
InternalError.FtpError 文件传输异常。
InternalError.UndefinedError 未知错误。
InvalidParameter 参数错误。
InvalidParameter.InstanceNotFound 实例不存在。
OperationDenied.ActionNotSupport 不支持的操作。
OperationDenied.UserHasNoStrategy 用户没有该策略权限。
目录