ModifyDBSBackupPolicy

Last updated:2026-03-13 18:56:45

ModifyDBSBackupPolicy

Last updated: 2026-03-13 18:56:45

1. API Description

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

Modify the instance backup strategy.

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: ModifyDBSBackupPolicy.
Version	Yes	String	Common Params. The value used for this API: 2021-11-22.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
BackupPolicy	Yes	BackupPolicyModelInput	Backup policy.
InstanceId	Yes	String	Instance ID.

3. Output Parameters

Parameter Name	Type	Description
IsSuccess	Boolean	Success status.
Msg	String	Message.
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 Modifying the Instance Backup Strategy

Modify instance backup strategy

Input Example

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

{
    "InstanceId": "tdsql3-31l2r0yn912rg",
    "BackupPolicy": {
        "FullRetentionPeriod": 7,
        "LogRetentionPeriod": 8,
        "PeriodTime": "0,1,2,3,4,5,6",
        "BackupMethod": "physical",
        "BackupStartTime": "00:00",
        "BackupEndTime": "04:00",
        "StorageType": "COS"
    }
}

Output Example

{
    "Response": {
        "IsSuccess": true,
        "Msg": "Modify backup policy successfully",
        "RequestId": "5cf77a8a-94e8-4fae-8abf-a48284f75606"
    }
}

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.ModifyBackupPolicyErr	Modify backup policy failed.
FailedOperation.ModifyPolicyErr	Modify backup policy failed.
InternalError.DatabaseAccessError	Database access error.
InternalError.DescribeDBObjectsError	Query database object failed.
InternalError.RouterNotFound	Route not found. whether parameter passing is incorrect.
InvalidParameter.IllegalBackupPolicyParamsErr	Invalid backup policy parameters.
InvalidParameter.InputIllegal	Parameter validation error.
InvalidParameter.InvalidParameterError	Parameter verification failed.
InvalidParameterValue	Parameter value error.
InvalidParameterValue.BizInvalidParameterValueError	Parameter value is invalid or out of range.
InvalidParameterValue.InvalidParameterValueError	Parameter error
MissingParameter.MissingParameterError	Missing parameter error.
ResourceNotFound.BizResourceNotFoundError	Instance resource not found.

Was this page helpful?

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

Yes

Feedback

tencent cloud