All Products
Search
Document Center

AnalyticDB for PostgreSQL:DescribeBackupPolicy

Last Updated:Mar 03, 2024

Queries the backup policy of an AnalyticDB for PostgreSQL instance.

Operation description

You can call this operation to query the backup settings of an AnalyticDB for PostgreSQL instance in elastic storage mode. Periodically backing data can prevent data loss. For more information about how to modify backup policies, see ModifyBackupPolicy .

Limits

You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

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:DescribeBackupPolicyRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The ID of the instance.

Note You can call the DescribeDBInstances operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.
gp-bp***************

Response parameters

ParameterTypeDescriptionExample
object
BackupRetentionPeriodinteger

The number of days for which data backup files are retained.

7
RequestIdstring

The ID of the request.

9E6B3287-A3E2-5A87-B8D8-E9**********
PreferredBackupPeriodstring

The cycle based on which backups are performed. If more than one day of the week is specified, the days of the week are separated by commas (,). Valid values:

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

The backup time. The time is in the HH:mmZ-HH:mmZ format. The time is displayed in UTC.

12:00Z-13:00Z
RecoveryPointPeriodstring

The frequency of the point-in-time backup. Valid values:

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

Indicates whether automatic point-in-time backup is enabled. Valid values:

  • true: Automatic point-in-time backup is enabled.
  • false: Automatic point-in-time backup is disabled.
true

Examples

Sample success responses

JSONformat

{
  "BackupRetentionPeriod": 7,
  "RequestId": "9E6B3287-A3E2-5A87-B8D8-E9**********",
  "PreferredBackupPeriod": "Wednesday,Friday",
  "PreferredBackupTime": "12:00Z-13:00Z",
  "RecoveryPointPeriod": "1",
  "EnableRecoveryPoint": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history