Change Backup Info

Last updated: 2017-12-14 11:28:07

1. API Description

This API (ModifyCdbBackupInfo) is used to modify backup information, for example, to modify the name of a backup.
Domain for API request: cdb.api.qcloud.com

2. Input Parameters

The following request parameter list only provides API request parameters. Common request parameters are also needed when API is called. For more information, please refer to Common Request Parameters. The Action field for this API is ModifyCdbBackupInfo.

Parameter Name Required Type Description
cdbInstanceIds Yes String One or more instance IDs (n represents array subscript starting with 0). Instance ID, such as: cdb-c1nl9rpv. It is identical to the instance ID displayed in the Cloud Database console page and can be obtained using API Query List of Instances. Its value equals to the uInstanceId field value in the output parameter.
backupMethod Yes String Target backup method, with optional values: logic cold backup "mysql", or physical cold backup "xtrabackup"

3. Output Parameters

Parameter Name Type Description
code Int Common error code; 0: Succeeded; other values: Failed. For more information, please refer to Common Error Codes on the Error Code page.
message String Module error message description depending on API.
codeDesc String Error description
data Array Returned data. Array being empty indicates success.

4. Error Codes

The following error codes only include the business logic error codes for this API.

Error Code Error Message Error Description
9003 InvalidParameter Incorrect parameter
9013 InternalError System internal error
9544 OperationDenied Instance does not exist
9572 InstanceNotExists Instance does not exist

5. Example

Input

https://cdb.api.qcloud.com/v2/index.php?Action=ModifyCdbBackupInfo
&<Common request parameters>
&cdbInstanceIds.0=cdb-0ty37vfg
&backupMethod=mysql

Output

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