All Products
Search
Document Center

AnalyticDB for PostgreSQL:ModifyBackupPolicy

Last Updated:Mar 03, 2024

Configures the backup policy of an AnalyticDB for PostgreSQL instance.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
gpdb:ModifyBackupPolicyWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The ID of the instance.

gp-bp***************
PreferredBackupTimestringYes

The backup window. Specify the backup window in the HH:mmZ-HH:mmZ format. The backup window must be in UTC. Default value: 00:00-01:00.

15:00Z-16:00Z
PreferredBackupPeriodstringYes

The cycle based on which you want to perform a backup. Separate multiple values with commas (,). Valid values:

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
Tuesday, Thursday, Saturday
BackupRetentionPeriodintegerNo

The number of days for which data backup files are retained. Default value: 7. Maximum value: 7. Valid values: 1 to 7.

7
EnableRecoveryPointbooleanNo

Specifies whether to enable automatic point-in-time backup.

  • true
  • false

Default value: true.

true
RecoveryPointPeriodstringNo

The frequency of point-in-time backup.

  • 1: per hour
  • 2: per 2 hours
  • 4: per 4 hours
  • 8: per 8 hours

Default value: 8.

8

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

DA147739-AEAD-4417-9089-65**********

Examples

Sample success responses

JSONformat

{
  "RequestId": "DA147739-AEAD-4417-9089-65**********"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-09-18The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.