文档

DescribeBackupPolicy - 查看实例备份策略

更新时间:

查看AnalyticDB PostgreSQL版实例的备份策略。

接口说明

周期性备份数据可以有效防止数据丢失,通过本接口您可以查看目标存储弹性模式实例的备份策略。如需修改备份策略,请参见 ModifyBackupPolicy

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
gpdb:DescribeBackupPolicyRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-bp***************

返回参数

名称类型描述示例值
object
BackupRetentionPeriodinteger

数据备份保留天数。

7
RequestIdstring

请求 ID。

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

数据备份周期,多个取值用英文逗号(,)隔开。取值说明:

  • Monday:周一。
  • Tuesday:周二。
  • Wednesday:周三。
  • Thursday:周四。
  • Friday:周五。
  • Saturday:周六。
  • Sunday:周日。
Wednesday,Friday
PreferredBackupTimestring

数据备份时间。格式:HH:mmZ-HH:mmZ(UTC 时间)。

12:00Z-13:00Z
RecoveryPointPeriodstring

恢复点频次。取值说明:

  • 1:每小时。
  • 2:每两小时。
  • 4:每四小时。
  • 8:每八小时。
1
EnableRecoveryPointboolean

是否开启自动恢复点。取值说明:

  • true:开启。
  • false:关闭。
true

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈