API 文档

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

最近更新时间:2020-11-18 08:12:30

1. 接口描述

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

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

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cdb.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 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 实例自动备份的时间窗。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

https://cdb.tencentcloudapi.com/?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"
    },
    "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 数据库内部错误。
InvalidParameter 参数错误。
InvalidParameter.InstanceNotFound 实例不存在。
OperationDenied.ActionNotSupport 不支持的操作。
目录