Docs

RDS for SQL Server

Backup

ModifyBackupPolicy - Modify backup policy

Call the ModifyBackupPolicy API to modify the automatic backup policy of an instance, such as the backup cycle and backup time window.

Request parameters

This section lists only the request parameters specific to this API and some common parameters. For more information, see Common Parameters.

Action string Example value: ModifyBackupPolicy

The action to perform. The value is: ModifyBackupPolicy.

Version string Example value: 2022-01-01

The API version is 2022-01-01.

LogBackupInterval integer Optional. Example value: 5

The log backup frequency can be one of the following values:

5: The default value. The log backup frequency is 5 minutes.

30: The log backup frequency is 30 minutes.

InstanceId string Example value: mssql-bbe31c86****

Instance ID.

tip

You can call the DescribeDBInstances API to query the instance ID.

BackupTimestringExample value: 19:00Z-20:00Z

The time window to start the backup task. The interval is 1 hour. Format: HH:mmZ-HH:mmZ (UTC time).

FullBackupPeriod stringExample value: Monday,Wednesday

Full backup cycle. Separate multiple values with a comma (,). The values are as follows:

Monday: Monday.

Tuesday: Tuesday.

Wednesday: Wednesday.

Thursday: Thursday.

Friday: Friday.

Saturday: Saturday.

Sunday: Sunday.

BackupRetentionPeriod integer Example value: 7

The number of days to retain data backups, ranging from 7 to 30.

Response parameters

This section lists only the response parameters specific to this API. For more information, see Response Structure.

InstanceId string Example value: mssql-1be522b5****

Instance ID.

Request example

POST /?Action=ModifyBackupPolicy&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host: rds-mssql.cn-beijing.volcengineapi.com​
X-Date: 20230131T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mssql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
​
{​
    "InstanceId":"mssql-bbe31c86d8ed",​
    "BackupTime":"19:00Z-20:00Z",​
    "FullBackupPeriod": "Monday,Wednesday",​
    "BackupRetentionPeriod":8​
}​

Response example

{​
    "ResponseMetadata": {​
        "RequestId": "2023082311541064165329E5946A3A8FFE",​
        "Action": "ModifyBackupPolicy",​
        "Version": "2022-01-01",​
        "Service": "rds_mssql",​
        "Region": "cn-beijing"​
    },​
    "Result": null​
}​

Error code

The following table lists the error codes for this API and its business logic. Common error codes See the Common error codes document.

Status code	Error code	Error message	Description
400	OperationDenied_ImportJobExists	The operation is not permitted due to existing running import jobs.	This operation cannot be performed while the instance is importing data.
400	UserBackupAmountOverTheLimit	The operation is not permitted due to the user backup amount over the limit.	The number of manual backups exceeds the limit.
400	OperationDenied_BackupJobExists	The operation is not permitted due to existing running import jobs.	This action can not be performed because the instance is running a backup task.
400	OperationUnsupported	The operation is unsupported for the specified instance.	The operation is not supported.
400	InstanceIsNotRunning	The specified instance is not running.	The current instance is not running.
400	OperationDenied_IncrBackupUnsupportRecovery	The operation is not permitted due to incr backup unsupport recovery.	This action can not be performed on an incremental backup.
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.	The {parameter1} parameter is missing.
400	InvalidDBName_Duplicate	The specified DBName already exists.	The database already exists.
400	TosRestoreTaskDbVerifyFailed	db verify failed, reason:%s.	DB validation failed due to {parameter1}.
400	InvalidParameter	The specified parameter %s is not valid.	The value of parameter {parameter1} is invalid.
400	InvalidParameterFormat	The input parameter is not valid.	Invalid parameter.
403	QuotaExceeded_RestoreDB	The quota of restore db exceeds.	The database restoration exceeds the quota limit.
403	OperationDenied_ResourceSoldOut	The requested resource is sold out in the specified zone; try other types of resources or other regions and zones.	Insufficient resources in the current availability zone.
404	BackupNotFound	The specified instance does not exist available backup records.	No available backup records were found.
404	InstanceNotFound	The specified instance does not exist.	The specified instance was not found.
500	InternalError	The request has failed with internal server error.	Internal error.
500	TosRestoreTaskNumExceedLimit	Too many tasks are being executed. Please submit them later.	Too many tasks are currently running. Try submit again later.

Last updated: 2026.02.11 15:34:54