tencent cloud

APIs

ModifyBackupConfig

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-10-28 10:19:25

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

Indicates the full backup start time, [0-24*3600], for example, 0:00, 1:00, 2:00 are 0, 3600, 7200 respectively

BackupTimeEnd No Integer

Refers to the full backup end time, [0-24*3600], for example, 0:00, 1:00, 2:00 correspond to 0, 3600, 7200 respectively

ReserveDuration No Integer

Indicates the backup retention period, in seconds. Data older than this period will be cleaned up. Seven days is represented as 3600247=604800, with a maximum of 158112000.

BackupFreq.N No Array of String

Currently this parameter cannot be modified and is not required. Backup frequency, an array of length 7, corresponding to Monday to Sunday backup methods, full-full backup, increment-incremental backup

BackupType No String

Currently this parameter does not support modification and is not required.

LogicBackupConfig No LogicBackupConfigInfo

Logical backup configuration

DeleteAutoLogicBackup No Boolean

Delete or not automatic logical backup

SnapshotSecondaryBackupConfig No SnapshotBackupConfig

Level-2 snapshot backup parameter

SparseBackupConfig No SparseBackupConfig

Sparse backup configuration

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

Modify the 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

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 strategy. Try again later. If the issue persists, contact customer service.
FailedOperation.DatabaseAccessError Database access failed. Try again later. If the issue persists, contact customer service.
FailedOperation.OperationFailedError Operation failed. Try again later. If the issue persists, contact customer service.
InternalError.InternalHttpServerError http request execution error.
InvalidParameterValue.InvalidParameterValueError Parameter value is invalid.
InvalidParameterValue.ParamError Parameter error.
ResourceNotFound.ClusterNotFoundError The cluster does not exist.
UnauthorizedOperation.PermissionDenied CAM authentication failed.

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック