分布式数据库 TiDB

产品文档

分布式数据库 TiDB

describeBackupPolicy

描述

查看实例当前的备份策略。

请求方式

GET

请求地址

https://tidb.jdcloud-api.com/v1/regions/{regionId}/instances/{instanceId}:describeBackupPolicy

名称 类型 是否必需 默认值 描述
regionId String True 地域代码
instanceId String True 实例ID

请求参数

返回参数

名称 类型 描述
result Result

Result

名称 类型 描述
startWindow String 自动备份开始时间窗口,范围00:00-23:59,时间范围差不得小于30分钟。
例如:00:00-01:00,表示0点到1点开始进行数据库自动备份,备份完成时间则跟实例大小有关,不保证在这个时间范围中完成
retentionPeriod Integer 自动备份保留周期,单位天,缺省为7天,范围7-730
backupPeriod String 自动备份的周期,多个取值用英文逗号分隔,支持以下参数,不区分大小写:
- Monday:周一
- Tuesday:周二
- Wednesday:周三
- Thursday:周四
- Friday:周五
- Saturday:周六
- Sunday:周日
例如定义周一和周三备份,则输入为Monday,Wednesday
autoIncBackup Boolean 是否开启自动增量备份

返回码

返回码 描述
200 OK
更新时间:2022-09-16 16:18:23
feedback