ModifyBackupConfig

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2022-01-19 11:36:38

Download PDF

1. API Description

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.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: ModifyBackupConfig.
Version	Yes	String	Common parameter. The value used for this API: 2017-03-20.
Region	Yes	String	Common parameter. 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-732.
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-732. It cannot 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)

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying the database backup configuration

Input Example

https://cdb.tencentcloudapi.com/?Action=ModifyBackupConfig
&InstanceId=cdb-c1nl9rpv
&ExpireDays=10
&BinlogExpireDays=8
&StartTime=02:00-06:00
&BackupMethod=logical
&<Common request parameters>

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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.

Recent Pages