更新时间:2024-08-20 GMT+08:00
分享

查询自动备份策略

功能介绍

查询自动备份策略。

调试

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

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy

表1 参数说明

名称

是否必选

说明

project_id

参数解释:

租户在某一Region下的项目ID。

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

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

实例ID。

请求参数

无。

响应参数

表2 参数说明

参数

参数类型

描述

backup_policy

Object

备份策略信息。

详情请参见表3

表3 backup_policy字段数据结构说明

参数

参数类型

描述

keep_days

Integer

全量备份文件可以保存的天数。取值范围:1~732。

最小值:1

最大值:732

start_time

String

全量备份时间段。自动备份将在该时间段内触发。取值范围:格式必须为hh:mm-HH:MM且有效,当前时间指UTC时间。

  • HH取值必须比hh大1。
  • mm和MM取值必须相同,且取值必须为00。

period

String

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

取值范围:格式为逗号隔开的数字,数字代表星期。

取值示例:

  • 1,2,3,4 表示备份周期配置为星期一、星期二、星期三和星期四。
  • 1,2,3,4,5,6,7 则表示星期一至星期日每天执行一次自动备份。
  • 1,3,5表示周一、周三、周五执行一次自动备份。

differential_priod

String

差量备份周期配置。自动差量备份将每隔周期分钟执行(废弃)。

differential_period

Integer

差量备份周期配置。自动差量备份将每隔周期分钟执行。

rate_limit

Integer

备份限速,默认值为0MB/s,表示不限速。控制备份是备份数据上传OBS的速度,限速用于限制上传备份对上传带宽的影响

prefetch_block

Integer

控制差量备份时读取磁盘上表文件差量修改页面的预取页面个数。当差量修改页面非常集中时(如数据导入场景),可以适当调大该值;当差量修改页面非常分散时(如随机更新),可以适当调小该值。默认为64,单位个数

filesplit_size

Integer

废弃字段。

file_split_size

Integer

全量、差量备份时产生的备份文件会根据分片大小进行拆分,可设置范围为0~1024GB,设置需为4的倍数,默认4GB,0GB表示不限制大小。

enable_standby_backup

Boolean

是否启用备机备份。

  • true:启用备机备份。
  • false:不启用备机备份。

请求示例

查询自动备份策略。

GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/backups/policy

响应示例

查询自动备份策略成功。

{
    "backup_policy": {
        "period": "1,2,3,4,5,6,7",
        "keep_days": 7,
        "start_time": "18:00-19:00",
        "differential_period": 30 ,
        "rate_limit": 75 ,
        "prefetch_block": 64 ,
        "file_split_size": 4 ,
        "enable_standby_backup" : false
    }
}

状态码

错误码

请参见错误码

相关文档