修改备份信息

最近更新时间:2017-12-14 11:28:07

1. 接口描述

本接口(ModifyCdbBackupInfo)用于修改备份信息,例如修改备份的名称。
接口请求域名:cdb.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的Action字段为ModifyCdbBackupInfo。

参数名称 是否必选 类型 描述
cdbInstanceIds String 一个或者多个实例ID,n表示从0开始的数组下标。实例ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同,可使用查询实例列表 接口获取,其值为输出参数中字段 uInstanceId 的值。
backupMethod String 目标备份方法,可选的值为:逻辑冷备"mysql",或者物理冷备"xtrabackup"

3. 输出参数

参数名称 类型 描述
code Int 公共错误码, 0表示成功,其他值表示失败。详见错误码页面的公共错误码
message String 模块错误信息描述,与接口相关。
codeDesc String 英文错误描述
data Array 返回数据,成功时数组为空

4. 错误码表

以下错误码表仅列出了该接口的业务逻辑错误码。

错误代码 英文提示 错误描述
9003 InvalidParameter 参数错误
9013 InternalError 系统内部错误
9544 OperationDenied 实例不存在
9572 InstanceNotExists 实例不存在

5. 示例

输入

https://cdb.api.qcloud.com/v2/index.php?Action=ModifyCdbBackupInfo
&<公共请求参数>
&cdbInstanceIds.0=cdb-0ty37vfg
&backupMethod=mysql

输出

{
    "code":"0",
    "message":"",
    "codeDesc":"Success",
    "data":[]
}