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

查询稀疏备份策略 - ListSparseBackupPolicy

功能介绍

查询稀疏备份策略。

调试

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

授权信息

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:instance:getBackupPolicy

read

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

rds:instance:list

-

接口约束

该接口仅支持PostgreSQL引擎。

URI

  • URI格式

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

  • 参数说明
    表1 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

    参数解释：

    租户在某一region下的project ID。

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

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

    instance_id

    是

    String

    参数解释：

    实例ID。

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

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

请求消息

无。

请求示例

查询稀疏备份策略。

GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/a2471f32101d4b57ae2a09f489ac16cein03/backups/sparse-policy

响应消息

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

    参数

    参数类型

    描述

    policies

    Array of objects

    参数解释：

    备份策略集。

    详情请参见表3。
    表3 policies字段说明

    参数

    参数类型

    描述

    id

    String

    参数解释：

    备份策略ID。

    取值范围：

    不涉及。

    period

    String

    参数解释：

    备份周期配置。

    取值范围：

    格式为“日期 月份 星期”形式的Cron表达式，时区为UTC时区。

    • 日期支持范围为1~31、特殊字符*（表示任意值）、特殊字符L（表示最后一天）。填写1~31或L时支持填写多个，以逗号隔开。
    • 月份支持范围为1~12、特殊字符*（表示任意值）。
    • 星期支持范围为1~7（1表示星期一，2表示星期二，依次类推）、特殊字符*（表示任意值）。填写1~7数字时支持填写多个，以逗号隔开。

    keep_days

    Integer

    参数解释：

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

    取值范围：

    1~3660

    start_time

    String

    参数解释：

    全量备份时间段。自动备份将在该时间段内触发。

    取值范围：

    格式为hh:mm-HH:MM，为UTC时间。

    • HH的值比hh大1。
    • mm和MM的值相同，且取值必须为00。
  • 正常响应样例 
    {
    "policies": [
        {
            "period": "1 * *",
            "id": "13223393-b6e9-4845-b053-539d5f53d584",
            "keep_days": 30,
            "start_time": "10:00-11:00"
        },
        {
            "period": "1 3 *",
            "id": "2803a1bc-a0f6-42e9-acdb-16eb87c79b4b",
            "keep_days": 365,
            "start_time": "10:00-11:00"
        },
        {
            "period": "* * 4",
            "id": "a43571b1-1164-4928-b235-26a2e355ea4e",
            "keep_days": 7,
            "start_time": "10:00-11:00"
        }
    ]
}
  • 异常响应

    请参见异常响应结果。

状态码

错误码

请参见错误码。

父主题： 备份与恢复

相关文档