有奖:语音产品征文挑战赛等你来> HOT
文档中心 > 云数据库 MySQL > API 文档 > 备份相关接口 > 查询云数据库异地备份配置信息

1. 接口描述

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

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

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

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

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
ExpireDays Integer 异地备份保留时间,单位为天
示例值:1
RemoteBackupSave String 异地数据备份开关,off - 关闭异地备份,on-开启异地备份
示例值:on
RemoteBinlogSave String 异地日志备份开关,off - 关闭异地备份,on-开启异地备份,只有在参数RemoteBackupSave为on时,RemoteBinlogSave参数才可设置为on
示例值:on
RemoteRegion Array of String 用户已设置异地备份地域列表
示例值:["ap-guangzhou"]
RegionList Array of String 用户可设置异地备份地域列表
示例值:["ap-guangzhou"]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

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

输入示例

https://cdb.tencentcloudapi.com/?Action=DescribeRemoteBackupConfig
&InstanceId=cdb-c1nl9rpv
&<公共请求参数>

输出示例

{
    "Response": {
        "ExpireDays": 7,
        "RemoteBackupSave": "on",
        "RemoteBinlogSave": "on",
        "RemoteRegion": [
            "ap-guangzhou",
            "ap-shanghai"
        ],
        "RegionList": [
            "ap-guangzhou",
            "ap-shanghai",
            "ap-beijing",
            "ap-shanghai"
        ],
        "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.UnknownError 未知错误。
ResourceNotFound.CdbInstanceNotFoundError 未找到数据库实例,请确认您的实例状态是否正常。