查询备份配置信息

最近更新时间:2024-09-30 01:15:52

我的收藏

1. 接口描述

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

本接口(DescribeBackupConfig)用于获取指定集群的备份配置信息,包括全量备份时间段、备份文件保留时间。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBackupConfig。
Version String 公共参数,本接口取值:2019-01-07。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。
ClusterId String 集群ID
示例值:cynosdbmysql-45knmnra

3. 输出参数

参数名称 类型 描述
BackupTimeBeg Integer 表示全备开始时间,[0-24*3600], 如0:00, 1:00, 2:00 分别为 0,3600, 7200
示例值:7200
BackupTimeEnd Integer 表示全备开始时间,[0-24*3600], 如0:00, 1:00, 2:00 分别为 0,3600, 7200
示例值:21600
ReserveDuration Integer 表示保留备份时长, 单位秒,超过该时间将被清理, 七天表示为3600247=604800
示例值:604800
BackupFreq Array of String 备份频率,长度为7的数组,分别对应周一到周日的备份方式,full-全量备份,increment-增量备份
注意:此字段可能返回 null,表示取不到有效值。
示例值:["full","increment","increment","increment","increment","increment","increment"]
BackupType String 备份方式,logic-逻辑备份,snapshot-快照备份
注意:此字段可能返回 null,表示取不到有效值。
示例值:"snapshot"
LogicCrossRegionsConfigUpdateTime String 跨地域逻辑备份配置修改时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:"2023-07-12 12:00:00"
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询备份配置信息

输入示例

https://cynosdb.tencentcloudapi.com/?Action=DescribeBackupConfig
&ClusterId=cynosdbmysql-45knmnra
&<公共请求参数>

输出示例

{
    "Response": {
        "BackupFreq": [
            "full",
            "increment",
            "increment",
            "increment",
            "increment",
            "increment",
            "increment"
        ],
        "BackupType": "",
        "BackupTimeEnd": 21600,
        "BackupTimeBeg": 7200,
        "RequestId": "180877",
        "ReserveDuration": 604800
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.DatabaseAccessError 数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。
FailedOperation.GetBackupStrategyError 获取备份策略失败,请稍后重试。如果持续不成功,请联系客服进行处理。
FailedOperation.OperationFailedError 操作失败,请稍后重试。如果持续不成功,请联系客服进行处理。
InternalError.SystemError 系统内部错误。
InvalidParameterValue.ParamError 参数错误。
InvalidParameterValue.StoragePoolNotFound 未找到相关存储pool。
ResourceNotFound.ClusterNotFoundError 集群不存在。
UnauthorizedOperation.PermissionDenied CAM鉴权不通过。