All Products
Document Center

ApsaraDB for MongoDB:ModifyBackupPolicy

Last Updated:Jan 17, 2023

Modifies the backup policy of an ApsaraDB for MongoDB instance.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operate access level Resource type conditional keyword Association operation
dds:ModifyBackupPolicy WRITE
  • MongoDB

Request parameters

Parameter Type Required Description Example
DBInstanceId string Yes

The ID of the instance.

PreferredBackupTime string Yes

The time range to back up data. Specify the time in the HH:mmZ-HH:mmZ format. The time must be in UTC.

Note The time range is 1 hour.
PreferredBackupPeriod string Yes

The day of a week on which to back up data. Valid values:

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
Note Separate multiple values with commas (,).
BackupRetentionPeriod long No

The retention period of full backups.

  • 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 log backup. Default value: 0. Valid values:

    • 0: disables log backup.
    • 1: enables log backup.
    LogBackupRetentionPeriod long No

    The number of days for which log backups are retained. Default value: 7.

    Valid values: 7 to 730.

    SnapshotBackupType string No

    The snapshot backup type. Default value: Standard. Valid values:

    • Flash: single-digit second backup
    • Standard: standard backup
    BackupInterval string No

    The frequency at which high-frequency backups are created. Valid values:

    • -1: disables high-frequency backup.
    • 15: every 15 minutes.
    • 30: every 30 minutes.
    • 60: every hour.
    • 120: every 2 hours.
    • 180: every 3 hours.
    • 240: every 4 hours.
    • 360: every 6 hours.
    • 480: every 8 hours.
    • 720: every 12 hours.
  • If SnapshotBackupType is set to Standard, this parameter is set to -1 and cannot be changed.
  • High-frequency backup takes effect only when SnapshotBackupType is set to Flash and the value of this parameter is greater than 0.
  • -1

    Response parameters

    Parameter Type Description Example
    RequestId string

    The ID of the request.



    Normal return example


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

    Error codes

    Http 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 API error center.