ModifyBackupPolicy - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Modifies a backup policy for an ApsaraDB for MongoDB instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	dds-bp16cb162771****
PreferredBackupTime	string	Yes	The start time of the backup. Specify the time in the ISO 8601 standard in the HH:mmZ-HH:mmZ format. The time must be in UTC. Note The time range is 1 hour.	03:00Z-04:00Z
PreferredBackupPeriod	string	Yes	The day of a week when the system regularly backs up data. Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday Note Separate multiple values with commas (,).	Monday,Wednesday,Friday,Sunday
BackupRetentionPeriod	long	No	The retention period of full backups. Note If your instance is created before September 10, 2021, backups are retained for seven days by default. If your instance is created after September 10, 2021, backups are retained for 30 days by default.	30
EnableBackupLog	long	No	Specifies whether to enable the log backup feature. Valid values: 0 (default): The log backup feature is disabled. 1: The log backup feature is enabled.	0
LogBackupRetentionPeriod	long	No	The number of days for which log backups are retained. Default value: 7. Valid values: 7 to 730.	7
SnapshotBackupType	string	No	The snapshot backup type. Valid values: Flash: single-digit second backup Standard (default): standard backup	Standard
BackupInterval	string	No	The frequency at which high-frequency backup is created. Valid values: -1: High-frequency backup is disabled. 30: High-frequency backups are generated every 30 minutes. 60: High-frequency backups are generated every 1 hour. 120: High-frequency backups are generated every 2 hours. 180: High-frequency backups are generated every 3 hours. 240: High-frequency backups are generated every 4 hours. 360: High-frequency backups are generated every 6 hours. 480: High-frequency backups are generated every 8 hours. 720: High-frequency backups are generated every 12 hours. Note If the SnapshotBackupType parameter is set to Standard, this parameter is set to -1 and cannot be changed. High-frequency backup takes effect only when the SnapshotBackupType parameter is set to Flash and the value of this parameter is greater than 0.	-1
HighFrequencyBackupRetention	long	No	The number of days for which high-frequency backups are retained. Before you use this parameter, make sure that you specify the BackupInterval parameter. By default, high-frequency backups are retained for one day.

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	644A359C-B871-4DD3-97B5-ED91EF5809C2

Examples

Sample success responses

JSONformat

{
  "RequestId": "644A359C-B871-4DD3-97B5-ED91EF5809C2"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidPreferredBackupPeriod.Malformed	Specified parameter PreferredBackupPeriod is not valid.
400	InvalidPreferredBackupTime.Malformed	Specified parameter PreferredBackupTime is not valid.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-02-22	The Error code has changed. The request parameters of the API has changed	View Change Details