文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 备份与恢复/ 查询自动备份策略 - ShowBackupPolicy
更新时间：2026-03-16 GMT+08:00
查看PDF
分享

查询自动备份策略 - ShowBackupPolicy

功能介绍

查询自动备份策略。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:instance:getBackupPolicy

read

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

rds:instance:list

-

URI

  • URI格式

    GET /v3/{project_id}/instances/{instance_id}/backups/policy

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一region下的project ID。

    约束限制：

    非空。

    取值范围：

    获取方法请参见获取项目ID。

    默认取值：

    不涉及。

    instance_id

    是

    参数解释：

    实例ID。

    约束限制：

    非空。

    取值范围：

    该参数值可调用查询数据库实例列表接口，通过表4中的“id”获取。

    默认取值：

    不涉及。

请求消息

  • 请求参数

    无。

  • URI样例

    GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/backups/policy

响应消息

  • 正常响应要素说明
    表2 要素说明

    名称

    参数类型

    说明

    backup_policy

    Object

    参数解释：

    备份策略对象，包括备份保留的天数和备份开始时间。

    详情请参见表3。
    表3 backup_policy字段数据结构说明

    名称

    参数类型

    说明

    keep_days

    Integer

    参数解释：

    备份文件可以保存的天数。

    取值范围：

    • 对于RDS for MySQL、RDS for SQL Server实例，支持1～732天。如果需要延长保留时间请提交工单申请，自动备份最长可以保留10年。
    • 对于RDS for PostgreSQL实例，支持1~3660天。

    start_time

    String

    参数解释：

    备份时间段。自动备份将在该时间段内触发，当前时间段为UTC时间。

    取值范围：

    不涉及。

    period

    String

    参数解释：

    备份周期配置。自动备份将在每星期指定的天进行。

    取值范围：

    格式为逗号隔开的数字，数字代表星期。

    取值示例：1,2,3,4则表示备份周期配置为星期一、星期二、星期三和星期四。
  • 正常响应样例 
    {
	"backup_policy": {
		"keep_days": 7,
		"start_time": "19:00-20:00",
		"period": "1,2"
	}
}
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 备份与恢复

相关文档