云数据库 MySQL 创建云数据库备份-备份相关接口-API 中心-腾讯云

1. 接口描述

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

本接口(CreateBackup)用于创建数据库备份。

默认接口请求频率限制：5次/秒。

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateBackup。
Version	是	String	公共参数，本接口取值：2017-03-20。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例 ID，格式如：cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。示例值：""
BackupMethod	是	String	目标备份方法，可选的值：logical - 逻辑冷备，physical - 物理冷备，snapshot - 快照备份。基础版实例仅支持快照备份。示例值：""
BackupDBTableList.N	否	Array of BackupItem	需要备份的库表信息，如果不设置该参数，则默认整实例备份。在 BackupMethod=logical 逻辑备份中才可设置该参数。指定的库表必须存在，否则可能导致备份失败。例：如果需要备份 db1 库的 tb1、tb2 表和 db2 库。则该参数设置为 [{"Db": "db1", "Table": "tb1"}, {"Db": "db1", "Table": "tb2"}, {"Db": "db2"} ]。
ManualBackupName	否	String	手动备份别名示例值：""

3. 输出参数

参数名称	类型	描述
BackupId	Integer	备份任务 ID。示例值：102996666
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建数据库备份

输入示例

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

{
    "InstanceId": "cdb-c1nl9rpv",
    "BackupDBTableList": [
        {
            "Table": "tb1",
            "Db": "db1"
        }
    ],
    "BackupMethod": "logical"
}

输出示例

{
    "Response": {
        "BackupId": 102996666,
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
CdbError	后端错误或者流程错误。
FailedOperation.StatusConflict	任务状态冲突。
InternalError.CdbError	系统错误。
InternalError.DatabaseAccessError	数据库内部错误。
InternalError.DesError	系统内部错误。
InternalError.HttpError	Http请求异常。
InternalError.NetworkError	网络错误。
InternalError.OssError	高可用版服务错误。
InternalError.UndefinedError	未知错误。
InternalError.UnknownError	未知错误。
InvalidParameter	参数错误。
InvalidParameter.InstanceNotFound	实例不存在。
InvalidParameterValue.DataConvertError	数据转换失败。
OperationDenied.ActionInProcess	实例正在执行其他任务。
OperationDenied.ActionNotSupport	不支持的操作。
OperationDenied.UserHasNoStrategy	用户没有该策略权限。
OverQuota	超限错误。

创建云数据库备份

本页目录：