Modifies the backup policy of an ApsaraDB for MongoDB instance.
debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- 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 Key: the condition key that is defined by the cloud service.
- 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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
dds:ModifyBackupPolicy | WRITE |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceId | string | Yes | The ID of the instance. | dds-bp16cb162771**** |
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.
| 03:00Z-04:00Z |
PreferredBackupPeriod | string | Yes | The day of a week on which to back up data. Valid values:
Note
Separate multiple values with commas (,).
| Monday,Wednesday,Friday,Sunday |
BackupRetentionPeriod | long | No | The retention period of full backups. Note
| 30 |
EnableBackupLog | long | No | Specifies whether to enable log backup. Default value: 0. Valid values:
| 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. Default value: Standard. Valid values:
| Standard |
BackupInterval | string | No | The frequency at which high-frequency backups are created. Valid values:
Note
| -1 |
Response parameters
Examples
Sample success responses
JSON
format
{
"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 |
---|