文档中心>TDSQL MySQL版>API 文档>分布式数据库>查询云数据库备份配置信息

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

最近更新时间:2024-09-11 01:33:14

我的收藏

1. 接口描述

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

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

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

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

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
InstanceId String 实例 ID。
示例值:tdsqlshard-c1nl9rpv
Days Integer 常规备份存储时长,范围[1, 3650]。
示例值:30
StartBackupTime String 每天备份执行的区间的开始时间,格式 mm:ss,形如 22:00。
示例值:03:00
EndBackupTime String 每天备份执行的区间的结束时间,格式 mm:ss,形如 23:59。
示例值:05:59
WeekDays Array of String 执行备份周期,枚举值:Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
示例值:[Saturday, Sunday]
ArchiveDays Integer 沉降到归档存储时长,-1表示关闭归档设置。
示例值:91
BackupConfigSet Array of BackupConfig 超期备份配置。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

获取超期备份策略

输入示例

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

{
    "InstanceId": "tdsqlshard-6cmpk1rd"
}

输出示例

{
    "Response": {
        "Days": 30,
        "StartBackupTime": "03:00",
        "EndBackupTime": "05:00",
        "WeekDays": [
            "Monday",
            "Sunday"
        ],
        "ArchiveDays": 91,
        "BackupConfigSet": [
            {
                "BackupCount": 1,
                "BeginDate": "2023-06-08",
                "EnableBackupPolicy": true,
                "Frequency": "monthly",
                "MaxRetentionDays": 365,
                "WeekDays": []
            }
        ],
        "InstanceId": "tdsqlshard-6cmpk1rd",
        "RequestId": "827d5b16-d464-4f43-af92-06c63d25375e"
    }
}

示例2 示例1

示例1

输入示例

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

{
    "InstanceId": "tdsqlshard-2500dqmh"
}

输出示例

{
    "Response": {
        "Days": 30,
        "StartBackupTime": "03:00",
        "EndBackupTime": "05:00",
        "WeekDays": [
            "Monday",
            "Sunday"
        ],
        "ArchiveDays": 91,
        "BackupConfigSet": [
            {
                "BackupCount": 0,
                "BeginDate": "2023-07-20",
                "EnableBackupPolicy": true,
                "Frequency": "weekly",
                "MaxRetentionDays": 100,
                "WeekDays": [
                    "Monday",
                    "Tuesday"
                ]
            }
        ],
        "InstanceId": "tdsqlshard-2500dqmh",
        "RequestId": "c4712e5d-78f3-4899-b8f4-0b6af5a17b77"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码