查询备份策略
更新时间：2023-11-07
备份功能说明
- Status为FINISHED且Result为SUCCEED的备份称为有效备份。以下操作仅适用于有效备份：用于恢复数据库；修改备份描述信息；查看备份的数据库信息；删除备份。非有效备份不能进行上述操作。
- 备份策略中backupUsedCapacity为实例所有有效备份大小之和。
- maxBackupCnt是一个实例的有效备份保存数量最大值（含自动备份和用户主动备份）。当实例成功备份（含自动备份和用户主动备份）后，如果有效备份数已经大于maxBackupCnt，则系统将删除最早的有效备份，直至有效备份数变为maxBackupCnt。
- backupCapacityQuota是一个实例的备份空间总量，如果某次备份操作的备份文件大于剩余的备份空间（即backupCapacityQuota - backupUsedCapacity），则该次备份操作将失败。
- 删除的备份文件不可恢复（含系统删除和用户主动删除的备份）。
说明
- 查询指定实例的备份策略
请求结构
GET /v{version}/instance/{instanceId}/backupPolicy HTTP/1.1
HOST: hbase.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | string | 是 | URL参数 | API版本号，当前取值1 |
| instanceId | string | 是 | URL参数 | 指定实例Id |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| maxBackupCnt | int | 最大的备份保存数量 |
| backupCapacityQuota | double | 备份空间总量。单位：GB。 |
| backupUsedCapacity | double | 已使用空间大小。单位：GB。 |
| autoBackup | string | 自动备份状态，取值：[ON,OFF]。ON：开启，OFF：关闭。仅当autoBackup为ON时，preferredBackupPeriod和preferredBackupTime有意义。 |
| preferredBackupPeriod | string | 自动备份周期，只能是以下7种取值：Monday：周一；Tuesday：周二；Wednesday：周三；Thursday：周四；Friday：周五；Saturday：周六；Sunday：周日。说明：暂时只支持一周备份一次。 |
| preferredBackupTime | string | 自动备份开始时间（UTC时间）。 |
请求示例
GET /v1/instance/hb-abc123/backupPolicy HTTP/1.1
HOST: hbase.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
HTTP/1.1 200 OK
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
Content-Type: application/json
{
"autoBackup": "OFF",
"maxBackupCnt": 3,
"preferredBackupPeriod": "Wednesday",
"preferredBackupTime": "01:00Z",
"backupCapacityQuota": 100000000,
"backupUsedCapacity": 0
}