Domain name for API request: cdb.tencentcloudapi.com.
This API (ModifyBackupConfig) is used to modify the database backup configuration.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: ModifyBackupConfig. |
Version | Yes | String | Common Params. The value used for this API: 2017-03-20. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
InstanceId | Yes | String | Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page. |
ExpireDays | No | Integer | Backup file retention period in days. Value range: 7-1830. |
StartTime | No | String | (This parameter will be disused. The BackupTimeWindow parameter is recommended.) Backup time range in the format of 02:00-06:00, with the start time and end time on the hour. Valid values: 00:00-12:00, 02:00-06:00, 06:00-10:00, 10:00-14:00, 14:00-18:00, 18:00-22:00, 22:00-02:00. |
BackupMethod | No | String | Automatic backup mode. Only physical (physical cold backup) is supported |
BinlogExpireDays | No | Integer | Binlog retention period in days. Value range: 7-1830. It can’t be greater than the retention period of backup files. |
BackupTimeWindow | No | CommonTimeWindow | Backup time window; for example, to set up backup between 10:00 and 14:00 on every Tuesday and Sunday, you should set this parameter as follows: {"Monday": "", "Tuesday": "10:00-14:00", "Wednesday": "", "Thursday": "", "Friday": "", "Saturday": "", "Sunday": "10:00-14:00"} (Note: You can set up backup on different days, but the backup time windows need to be the same. If this field is set, the StartTime field will be ignored) |
EnableBackupPeriodSave | No | String | Switch for archive backup retention. Valid values: off (disable), on (enable). Default value:off . |
EnableBackupPeriodLongTermSave | No | String | Switch for long-term backup retention (This field can be ignored, for its feature hasn’t been launched). Valid values: off (disable), on (enable). Default value: off . Once enabled, the parameters (BackupPeriodSaveDays, BackupPeriodSaveInterval, and BackupPeriodSaveCount) will be invalid. |
BackupPeriodSaveDays | No | Integer | Maximum days of archive backup retention. Valid range: 90-3650. Default value: 1080. |
BackupPeriodSaveInterval | No | String | Archive backup retention period. Valid values: weekly (a week), monthly (a month), quarterly (a quarter), yearly (a year). Default value: monthly . |
BackupPeriodSaveCount | No | Integer | Number of archive backups. Minimum value: 1 , Maximum value: Number of non-archive backups in archive backup retention period. Default value: 1 . |
StartBackupPeriodSaveDate | No | String | The start time in the format of yyyy-mm-dd HH:MM:SS, which is used to enable archive backup retention policy. |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://cdb.tencentcloudapi.com/?Action=ModifyBackupConfig
&InstanceId=cdb-c1nl9rpv
&ExpireDays=10
&BinlogExpireDays=8
&StartTime=02:00-06:00
&BackupMethod=logical
&<Common request parameters>
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
CdbError | Backend or process error. |
InternalError.DatabaseAccessError | Internal database error. |
InternalError.UndefinedError | Unknown error |
InvalidParameter | Parameter error. |
InvalidParameter.InstanceNotFound | The instance does not exist. |
OperationDenied.UserHasNoStrategy | This account is not authorized to access the requested resource. |
Was this page helpful?