ModifyBackupConfig

Last updated: 2025-11-13 20:51:44

ModifyBackupConfig

Last updated: 2025-11-13 20:51:44

1. API Description

Domain name for API request: cynosdb.intl.tencentcloudapi.com.

This API is used to modify the backup configuration of a specified cluster.

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.

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: 2019-01-07.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
ClusterId	Yes	String	Cluster ID
BackupTimeBeg	No	Integer	Full backup start time. Value range: [0-24*3600]. For example, 0:00 AM, 1:00 AM, and 2:00 AM are represented by 0, 3600, and 7200, respectively
BackupTimeEnd	No	Integer	Full backup end time. Value range: [0-24*3600]. For example, 0:00 AM, 1:00 AM, and 2:00 AM are represented by 0, 3600, and 7200, respectively.
ReserveDuration	No	Integer	Backup retention period in seconds. Backups will be cleared after this period elapses. 7 days is represented by 3600247 = 604800. Maximum value: 158112000.
BackupFreq.N	No	Array of String	Backup frequency. It is an array of 7 elements corresponding to Monday through Sunday. full: full backup; increment: incremental backup. This parameter cannot be modified currently and doesn't need to be entered.
BackupType	No	String	Currently, this parameter does not support modification and is not required.
LogicBackupConfig	No	LogicBackupConfigInfo
DeleteAutoLogicBackup	No	Boolean

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Modify Cluster Backup Configuration

This example shows you how to modify backup configuration.

Input Example

POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyBackupConfig
<Common request parameters>

{
    "BackupTimeBeg": 7200,
    "ReserveDuration": 604800,
    "ClusterId": "cynosdbmysql-45knmnra",
    "BackupTimeEnd": 21600
}

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
FailedOperation.CynosdbMysqlSetBackupStrategy	Failed to set the backup policy. Please try again later. If the failure persists, please contact customer service for handling.
FailedOperation.DatabaseAccessError	Failed to access the database. Please try again later. If the problem persists, please contact customer service.
FailedOperation.OperationFailedError	Operation failed. Try again later. If the problem persists, contact customer service.
InternalError.InternalHttpServerError	An exception occurred while executing the HTTP request.
InvalidParameterValue.InvalidParameterValueError	Invalid parameter value.
InvalidParameterValue.ParamError	Incorrect parameter.
ResourceNotFound.ClusterNotFoundError	The cluster does not exist.
UnauthorizedOperation.PermissionDenied	CAM authentication failed.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud