修改存储库绑定的备份策略
功能介绍
修改存储库绑定的备份策略
URI
PUT /v5/{project_id}/backup/policy
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| enterprise_project_id | 否 | String | 企业项目ID,查询所有企业项目时填写:all_granted_eps |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
| region | 是 | String | Region ID |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| enabled | 否 | Boolean | 策略是否启用,缺省值:true |
| policy_id | 是 | String | 备份策略ID |
| operation_definition | 否 | 调度参数 | |
| trigger | 否 | BackupTriggerRequestInfo object | 策略时间调度规则 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| day_backups | 否 | Integer | 保留日备个数,该备份不受保留最大备份数限制。取值为0到100。若选择该参数,则timezone 也必选。最小值:0,最大值:100 |
| max_backups | 否 | Integer | 单个备份对象自动备份的最大备份数。取值为-1或0-99999。-1代表不按备份数清理。若该字段和retention_duration_days字段同时为空,备份会永久保留。最小值:1,最大值:99999,缺省值:-1 |
| month_backups | 否 | Integer | 保留月备个数,该备份不受保留最大备份数限制。取值为0到100。若选择该参数,则timezone 也必选。最小值:0, 最大值:100 |
| retention_duration_days | 否 | Integer | 备份保留时长,单位天。最长支持99999天。-1代表不按时间清理。若该字段和max_backups 参数同时为空,备份会永久保留。最小值:1, 最大值:99999, 缺省值:-1 |
| timezone | 否 | String | 用户所在时区,格式形如UTC+08:00,若没有选择年备,月备,周备,日备中任一参数,则不能选择该参数。 |
| week_backups | 否 | Integer | 保留周备个数,该备份不受保留最大备份数限制。取值为0到100。若选择该参数,则timezone 也必选。 |
| year_backups | 否 | Integer | 保留年备个数,该备份不受保留最大备份数限制。取值为0到100。若选择该参数,则timezone 也必选。最小值:0,最大值:100 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| pattern | 是 | Array of strings | 调度规则。限制24条规则。调度器的调度规则,可参照iCalendar RFC 2445规范中的事件规则,但仅支持FREQ、BYDAY、BYHOUR、BYMINUTE、INTERVAL等参数,其中FREQ仅支持WEEKLY和DAILY,BYDAY支持一周七天(MO、TU、WE、TH、FR、SA、SU),BYHOUR支持0-23小时,BYMINUTE支持0-59分钟,并且间隔不能小于一小时,一天最大24个时间点。例如,周一到周天,每天14:00调度,其规则为:'FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00'。每天14:00调度,其规则为'FREQ=DAILY;INTERVAL=1;BYHOUR=14;BYMINUTE=00'。 |
响应参数
状态码:200
请求已成功
无
请求示例
修改备份策略,目标备份策略ID为af4d08ad-2b60-4916-a5cf-8d6a23956dda。
PUT https://{endpoint}/v5/{project_id}/backup/policy
{
"enabled" : true,
"policy_id" : "af4d08ad-2b60-4916-a5cf-8d6a23956dda",
"operation_definition" : {
"day_backups" : 0,
"max_backups" : -1,
"month_backups" : 0,
"retention_duration_days" : 5,
"timezone" : "UTC+08:00",
"week_backups" : 0,
"year_backups" : 0
},
"trigger" : {
"properties" : {
"pattern" : [ "FREQ=DAILY;INTERVAL=2;BYHOUR=14;BYMINUTE=00" ]
}
}
} 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。