All Products
Document Center

ApsaraDB for MongoDB:DescribeBackupPolicy

Last Updated:Jan 17, 2023

Queries 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:DescribeBackupPolicy READ
  • MongoDB

Request parameters

Parameter Type Required Description Example
DBInstanceId string Yes

The ID of the instance.


Response parameters

Parameter Type Description Example
PreferredBackupPeriod string

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

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
RequestId string

The ID of the request.

PreferredBackupTime string

The time range to back up data. The time is in the HH:mmZ-HH:mmZ format. The time is displayed in UTC.

BackupRetentionPeriod string

The retention period of backups. Unit: days.

EnableBackupLog integer

Indicates whether log backup is enabled. Default value: 0. Valid values:

  • 0: disables log backup.
  • 1: enables log backup.
LogBackupRetentionPeriod integer

The number of days for which to retain log backups. Valid values: 7 to 730.

SnapshotBackupType string

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

  • Flash: single-digit second backup
  • Standard: standard backup
BackupInterval integer

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.


Normal return example


  "PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
  "RequestId": "5A9464CA-F7DC-5434-90B1-DF7F197C****",
  "PreferredBackupTime": "09:00Z-10:00Z",
  "BackupRetentionPeriod": "30",
  "EnableBackupLog": 1,
  "LogBackupRetentionPeriod": 7,
  "SnapshotBackupType": "Standard",
  "BackupInterval": -1

Error codes

For a list of error codes, visit the API error center.